The MediaContainerRelation Controller enables you to create and manage relationships between different media containers in your system. This API allows you to establish, query, and remove connections between related media assets – for example, linking an image to its license document or connecting videos with supplementary materials.
Use Cases
- Establish connections between versions or variations of the same content
- Link media assets to their legal documents (licenses, releases, etc.)
- Connect primary content with supporting materials
Best Practices
- Keep track of relation IDs when creating new connections, as they’re needed for later deletion
- Use the Find relations endpoint to validate connections before performing operations
- Consider implementing regular audits of your relations to ensure all connections remain valid
Reference
Find relations
Returns all related media containers for a given mediaContainerId. Use this endpoint to discover all assets connected to a specific media container, such as finding all license documents associated with an image or all supplementary materials linked to a video.
Field | Type | Required | Description |
---|
mediaContainerId | integer | ✓ | Return relations for the given mediaContainerId |
Field | Type | Description |
---|
createdAt | dateTime | Date and time of the creation |
customerId | integer | CustomerId this caption belongs to |
flag | integer | Flag of the mediacontainer |
id | integer | Id of the relation |
lastEditorId | integer | User id of the creator if this caption |
mediaContainerId | integer | mediaContainerId of this relation |
notes | string | Notes of this mediacontainer |
relatedMediaContainer | object | Details regarding the linked mediacontainer |
└ type | string | Type of the related mediacontainer |
└ subtype | string | Optional subtype of the related mediacontainer |
relatedMediaContainerId | integer | mediaContainerId the mediacontainer is related to. |
settings | object | Settings of the mediacontainer |
updatedAt | dateTime | Date and time of the latest update |
Create mediacontainer relation
Establishes a new relationship between two media containers. This endpoint creates a connection between two assets by specifying both the source mediaContainerId and the relatedMediaContainerId. Use this when you need to link content, such as connecting an image to its license document or a video to its transcript file.
Field | Type | Required | Description |
---|
mediaContainerId | integer | ✓ | Create a relation for this mediaContainerId |
relatedMediaContainerId | integer | ✓ | mediaContainerId the mediacontainer is related to. |
Field | Type | Description |
---|
createdAt | dateTime | Date and time of the creation |
customerId | integer | CustomerId this caption belongs to |
id | integer | Id of the relation |
lastEditorId | integer | User id of the creator if this caption |
mediaContainerId | integer | mediaContainerId of this relation |
notes | string | Notes of this mediacontainer |
relatedMediaContainerId | integer | mediaContainerId the mediacontainer is related to. |
updatedAt | dateTime | Date and time of the latest update |
Destroy mediacontainer relation
Removes an existing relationship between two media containers. This endpoint permanently deletes the specified relationship using the relation ID (not the media container IDs). Use this when you need to remove connections between assets that are no longer relevant, such as outdated licenses or disconnected content.
Field | Type | Required | Description |
---|
id | integer | ✓ | Id of the relation you want to delete |
Field | Type | Description |
---|
id | integer | Id of the relation |