MediaCentral | Media Suite API

Welcome to the MediaCentral | Media Suite API documentation, also known as the Connectivity Toolkit Media Services (CTMS) API.

The API is a REST API following the HATEOAS principles. It uses the Hypertext Application Language (HAL) standard to allow a caller to navigate through the API by following links. The entry point for the API is the CTMS Registry service.

If you are not familiar with the API, we recommend to first read the HAL introduction and the CTMS Registry Overview, or jump directly into the Quick Start guides. For a detailed API reference consult the Resources and Link rels (all) pages.

Note:

The MediaCentral| Media Suite API (also referred to as Connectivity Toolkit Media Services or CTMS API) is a family of HAL/REST APIs that allow access to the functionality of CloudUX systems and modules in a common way. This usually includes the following steps:

Authenticate
Query the CTMS Registry over HTTP to obtain a core set of links
Make REST calls to the URLs within these links. The results are HAL resources with further links to additional functionality.

Through this iterative approach, code can navigate the entire API. The only hardcoded links required are any for authentication and the resource root for the CTMS Registry.

Using the API needs to adhere to the following principles:

Caching and reusing a link within an active session is considered a good practice.
Hardcoding other links or calling services via other transports (for example via direct Avid Platform bus calls or using the ACS Monitor) is not supported. Any implementation behavior that appears to function today may cease to work in the future as resource roots and sub-resource paths may change without notice as part of normal feature release work.