The MetadataType Controller allows you to manage metadata types within the AdmiralCloud platform. Metadata types define structured information models that can be attached to various resources like media, channels, or containers. This controller provides endpoints for creating, retrieving, updating, and deleting metadata types, as well as managing their properties and validation rules. Proper metadata type configuration is essential for maintaining data consistency across your AdmiralCloud implementation.
Reference
Find metadataType
Retrieves a list of metadata types based on specified criteria. This endpoint supports filtering by various attributes such as name, container, or status. Use this endpoint when you need to discover available metadata types or check which types are applicable to specific resources.
Field | Type | Required | Description |
---|---|---|---|
settings | object | ✗ | Settings for this subtype |
└ label | object | ✗ | Translations for this subtype Beta |
└ de | string | ✗ | German translation of this subtype name. |
└ en | string | ✗ | English translation of this subtype name. |
type | string | ✗ | Return subypes for the given type videoaudioimagedocument |
Field | Type | Description |
---|---|---|
creatorId | integer | User id of the creator if this caption |
customerId | integer | CustomerId this caption belongs to |
id | integer | Id of the subtype |
lastEditorId | integer | User id of the creator if this caption |
mediaContainerId | integer | MediaContainerId for this metadata type |
settings | object | Settings for this subtype |
└ label | object | Translations for this subtype Beta |
└ de | string | German translation of this subtype name. |
└ en | string | English translation of this subtype name. |
subtype | string | Name of the subtype |
type | string | Type of the subtype videoaudioimagedocument |
/v5/metadatatype
{ "body": [ { "id": 1, "type": "video", "subtype": "animation", "settings": { "label": { "de": "Animation", "en": "Animation" } }, "customerId": 1, "creatorId": 123, "lastEditorId": 123 } ] }
Create metadataType
Creates a new metadata type definition in the AdmiralCloud platform. Metadata types allow you to define structured information models that can be attached to resources. When creating a metadata type, you must specify its name, container type (where it can be used), and the properties that define its structure.
Field | Type | Required | Description |
---|---|---|---|
mediaContainerId | integer | ✗ | MediaContainerId for this metadata type (used for dropsites) |
settings | object | ✗ | Settings for this subtype |
└ label | object | ✗ | Translations for this subtype Beta |
└ de | string | ✗ | German translation of this subtype name. |
└ en | string | ✗ | English translation of this subtype name. |
subtype | string | ✓ | Name of the subtype |
type | string | ✓ | Type for this new subtype videoaudioimagedocument |
Field | Type | Description |
---|---|---|
creatorId | integer | User id of the creator if this caption |
customerId | integer | CustomerId this caption belongs to |
id | integer | Id of the subtype |
lastEditorId | integer | User id of the creator if this caption |
mediaContainerId | integer | MediaContainerId for this metadata type |
settings | object | Settings for this subtype |
└ label | object | Translations for this subtype Beta |
└ de | string | German translation of this subtype name. |
└ en | string | English translation of this subtype name. |
subtype | string | Name of the subtype |
type | string | Type of the subtype videoaudioimagedocument |
Destroy metadataType
Permanently removes a metadata type from the system. Use this endpoint with caution as deleting a metadata type will also delete all metadata entries of this type across all resources. This operation cannot be undone. Before deletion, verify that the metadata type is no longer needed for any operational or archival purposes.
Field | Type | Required | Description |
---|---|---|---|
forceDelete | boolean | ✗ | If mediacontainers are linked to this subtype, the subtype can only be deleted if forceDelete is set to true. |
mediaContainerId | integer | ✗ | MediaContainerId for this metadata type |
subtype | string | ✓ | TSubtype you want to delete |
type | string | ✓ | Type of the subtype you want to delete videoaudioimagedocument |
Field | Type | Description |
---|---|---|
id | integer | Id of the subtype |
mediaContainerId | integer | MediaContainerId for this metadata type |
subtype | string | Name of the subtype |
type | string | Type of the subtype videoaudioimagedocument |