Media Resource Tags Endpoints¶

Media Resource Tags API endpoints.

Overview¶

Method	Endpoint	Description
GET	`/api/v1/media-resources/{media_resource_id}/tags/`	Get Media Resource Tags
POST	`/api/v1/media-resources/{media_resource_id}/tags/`	Assign Media Resource Tags
PUT	`/api/v1/media-resources/{media_resource_id}/tags/`	Set Media Resource Tags
DELETE	`/api/v1/media-resources/{media_resource_id}/tags/`	Remove Media Resource Tags

API Reference¶

Sartiq Backend Server - Media Resource Tags 0.1.0¶

media-resource-tags¶

GET /api/v1/media-resources/{media_resource_id}/tags/¶

Get Media Resource Tags

Input parameters

Parameter	In	Type	Default	Nullable	Description
`OAuth2PasswordBearer`	header	string	N/A	No
`media_resource_id`	path	string		No

Responses

200 OK422 Unprocessable Entity

application/json

{
    "tags": [
        {
            "id": "6ba721c7-bbcf-427d-bdbf-faac09f8b3a9",
            "name": "string",
            "color": null,
            "description": null,
            "owner_id": "6b86ced8-238c-4638-b3c9-1fed11919cd7",
            "organization_id": null,
            "created_at": "2022-04-13T15:42:05.901Z",
            "updated_at": "2022-04-13T15:42:05.901Z"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "tags": {
            "items": {
                "$ref": "#/components/schemas/TagPublic"
            },
            "type": "array",
            "title": "Tags"
        }
    },
    "type": "object",
    "required": [
        "tags"
    ],
    "title": "MediaResourceTagsPublic",
    "description": "Response for tags on a media resource."
}

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string",
            "input": null,
            "ctx": {}
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

POST /api/v1/media-resources/{media_resource_id}/tags/¶

Assign Media Resource Tags

Input parameters

Parameter	In	Type	Default	Nullable
`OAuth2PasswordBearer`	header	string	N/A	No
`media_resource_id`	path	string		No
`organization_id`	query			No

Request body

application/json

{
    "tag_ids": [
        "c589d40d-5e1e-4ca5-8a65-cef691bc6d01"
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "properties": {
        "tag_ids": {
            "items": {
                "type": "string",
                "format": "uuid"
            },
            "type": "array",
            "title": "Tag Ids"
        }
    },
    "type": "object",
    "required": [
        "tag_ids"
    ],
    "title": "MediaResourceTagAssign",
    "description": "Request body for assigning/removing tags on a media resource."
}

Responses

201 Created422 Unprocessable Entity

application/json

{
    "tags": [
        {
            "id": "06d76a44-2deb-41ba-bcfa-ee8c38fd1018",
            "name": "string",
            "color": null,
            "description": null,
            "owner_id": "4ca89ca5-129f-4cfe-9b20-51adde0bd936",
            "organization_id": null,
            "created_at": "2022-04-13T15:42:05.901Z",
            "updated_at": "2022-04-13T15:42:05.901Z"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "tags": {
            "items": {
                "$ref": "#/components/schemas/TagPublic"
            },
            "type": "array",
            "title": "Tags"
        }
    },
    "type": "object",
    "required": [
        "tags"
    ],
    "title": "MediaResourceTagsPublic",
    "description": "Response for tags on a media resource."
}

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string",
            "input": null,
            "ctx": {}
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

PUT /api/v1/media-resources/{media_resource_id}/tags/¶

Set Media Resource Tags

Input parameters

Parameter	In	Type	Default	Nullable
`OAuth2PasswordBearer`	header	string	N/A	No
`media_resource_id`	path	string		No
`organization_id`	query			No

Request body

application/json

{
    "tag_ids": [
        "309667d1-6a91-483b-b4a4-25255088d0eb"
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "properties": {
        "tag_ids": {
            "items": {
                "type": "string",
                "format": "uuid"
            },
            "type": "array",
            "title": "Tag Ids"
        }
    },
    "type": "object",
    "required": [
        "tag_ids"
    ],
    "title": "MediaResourceTagAssign",
    "description": "Request body for assigning/removing tags on a media resource."
}

Responses

200 OK422 Unprocessable Entity

application/json

{
    "tags": [
        {
            "id": "dbb10d6e-1dc5-4228-9457-7a4b093b1dc8",
            "name": "string",
            "color": null,
            "description": null,
            "owner_id": "3742af54-f1fe-4130-85c8-73f6f41ef462",
            "organization_id": null,
            "created_at": "2022-04-13T15:42:05.901Z",
            "updated_at": "2022-04-13T15:42:05.901Z"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "tags": {
            "items": {
                "$ref": "#/components/schemas/TagPublic"
            },
            "type": "array",
            "title": "Tags"
        }
    },
    "type": "object",
    "required": [
        "tags"
    ],
    "title": "MediaResourceTagsPublic",
    "description": "Response for tags on a media resource."
}

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string",
            "input": null,
            "ctx": {}
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

DELETE /api/v1/media-resources/{media_resource_id}/tags/¶

Remove Media Resource Tags

Input parameters

Parameter	In	Type	Default	Nullable
`OAuth2PasswordBearer`	header	string	N/A	No
`media_resource_id`	path	string		No
`organization_id`	query			No

Request body

application/json

{
    "tag_ids": [
        "ce1a0d58-0f50-47e9-9b53-171fd6b2b4ac"
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "properties": {
        "tag_ids": {
            "items": {
                "type": "string",
                "format": "uuid"
            },
            "type": "array",
            "title": "Tag Ids"
        }
    },
    "type": "object",
    "required": [
        "tag_ids"
    ],
    "title": "MediaResourceTagAssign",
    "description": "Request body for assigning/removing tags on a media resource."
}

Responses

200 OK422 Unprocessable Entity

application/json

{
    "tags": [
        {
            "id": "0633f2cf-1eaf-4eb0-8ade-a17bb2604d77",
            "name": "string",
            "color": null,
            "description": null,
            "owner_id": "9f2868b2-4127-4bb2-8abe-a1b374a00914",
            "organization_id": null,
            "created_at": "2022-04-13T15:42:05.901Z",
            "updated_at": "2022-04-13T15:42:05.901Z"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "tags": {
            "items": {
                "$ref": "#/components/schemas/TagPublic"
            },
            "type": "array",
            "title": "Tags"
        }
    },
    "type": "object",
    "required": [
        "tags"
    ],
    "title": "MediaResourceTagsPublic",
    "description": "Response for tags on a media resource."
}

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string",
            "input": null,
            "ctx": {}
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

Schemas¶

HTTPValidationError¶

Name	Type	Description
`detail`	Array<ValidationError>

MediaResourceTagAssign¶

Name	Type	Description
`tag_ids`	Array<string(uuid)>

MediaResourceTagsPublic¶

Name	Type	Description
`tags`	Array<TagPublic>

TagPublic¶

Name	Type	Description
`color`
`created_at`	string(date-time)
`description`
`id`	string(uuid)
`name`	string
`organization_id`
`owner_id`	string(uuid)
`updated_at`	string(date-time)

ValidationError¶

Name	Type	Description
`ctx`
`input`
`loc`	Array<>
`msg`	string
`type`	string

Security schemes¶

Name	Type	Scheme	Description
OAuth2PasswordBearer	oauth2