CTMS API Reference

Common elements

CTMS API CURIEs: CURIEs defined by the CTMS API
Common Object Properties: Common properties that are used in different resources
Paging information: Common properties and links used in resources that support paging through a list of resources
Common Query Parameters: Common query parameters that are used in different CTMS requests
Status: Status properties for aa:asset and loc:item resources
Bulk calls: General handling of bulk calls in CTMS.
Long-running commands: General handling of long-running commands in CTMS.
Multi-link link rels: Single-link vs. multi-link link rels
Common error codes: A summary of standardized error codes from CTMS APIs.

aa:assets Entry point for asset-related functions
aa:asset Represents an asset
aa:attributes Represents the attributes of an asset in a common format
aa:time-based Represents the time-based annotation of an asset in a common format
aa:keyframes Returns key frames like shot borders, scene changes or the position of markers for an asset
aa:thumb Represents a thumbnail image for an asset

The representation of the folder structure of a system

loc:locations Entry point for functions that handle the folder structure of a system
loc:collection Represents a list of items in a folder
loc:item Represents an item in a folder
loc:path-to-root Represents the folder path up to the root folder for a location item

datamodel:aggregated-model A data model aggregated across all systems.
datamodel:system-model The data model of a single system.
datamodel:asset-model The data model for an asset. It includes details about the the available attributes and layers and layout information defining how clients should present the data for the asset.

relations:relations Represents the relations of an asset in a common format
relations:relation-types Represents the relation types of an asset in a common format

New in MC | Cloud UX 2024.10

taxonomies:taxonomies The entry point for taxonomy-related functions of a system
taxonomies:taxonomy-list Represents the list of all taxonomies of a system
taxonomies:taxonomy Represents a taxonomy
taxonomies:taxonomy-model Represents the data model of a taxonomy
taxonomies:entry Represents an entry of a taxonomy
taxonomies:entries Represents a list of entries of a taxonomy
taxonomies:path-to-root Represents the path in a hierarchical taxonomy to an entry
taxonomies:hit-list Represents a recommended hit list format for taxonomy pick tools.

New in MC | Cloud UX 2020.9

settings:settings Entry point to query and manipulate the settings of a system.
settings:section The organizational item which contains this section’s settings and links available (child/sub) sections.

ia:asset-lock Represents an asset edit lock object and provides links to manage it
ia:asset-versions Represents the versions of an asset
ia:colors Represents a list of colors
ia:form Represents a form
ia:forms Represents the list of all forms
ia:monitor Represents a monitor
ia:monitors Represents a list of monitors
ia:monitor-servers Represents the list of monitor servers in a particular monitor
ia:mos-map Represents a list of configured mos devices
ia:print-style: Represents a printing style
ia:print-styles Represents the list of printing styles
ia:queue Represents a queue
ia:queues Query and manipulate queues
ia:queue-attributes Represents the attributes of a queue
ia:queue-notifications Represents a notification subscription object and provides links to manage it
ia:queue-stories Represents the list of stories in a queue
ia:queue-watcher Represents a watcher object and provides links to manage it
ia:script-template Represents a script template
ia:script-templates Represents the list of script templates
ia:searchqueue-attributes Represents the attributes of a searchqueue
ia:system Provides links to query MediaCentral Newsroom Management system data
ia:tokens Represents the list of tokens defined in the system
ia:user Represents an user in a MediaCentral Newsroom Management system
ia:users Represents a list of users in an MediaCentral Newsroom Management system