CTMS clients should use only one hard-coded URL: the URL of the CTMS registry. Starting with the information in the CTMS registry, clients can then navigate through the entire API by following link rels. Using the CTMS Registry as a Client shows how to query the CTMS registry.
The CTMS registry may contain the following link rels. Not all link rels are available in all installations. The CTMS registry may also contain other link rels.
Assets
-
aa:assets Get the root resource with link rels for functionality regarding assets of a system.
-
aa:asset-by-id Get information about an asset.
-
aa:asset-selective-by-id Get selective information about an asset.
-
aa:delete-asset-by-id Delete an asset.
-
aa:update-asset-by-id Update an asset.
Locations
-
loc:locations Get the root resource with link rels for functionality regarding the folder structure of a system.
-
loc:item-by-id Get information about an item (folder or asset reference) in the folder hierarchy.
-
loc:root-item Get the root item of the folder structure of a system.
Data Model
-
datamodel:asset-model-by-id Get data model information for an asset.
-
datamodel:aggregated-model Get the aggregated data model information for all systems.
Taxonomies
-
taxonomies:taxonomies Get the root resource with link rels for functionality regarding taxonomies of a system.
-
taxonomies:taxonomy-by-taxonomyid Get a taxonomy.
-
taxonomies:entry-by-taxonomyid-and-entryid Get a taxonomy entry.
Settings
-
settings:settings Get the root resource with link rels for functionality regarding settings of a system.
-
settings:root-section Get the root section of the settings hierarchy.
-
settings:section-by-path Get a section of the settings hierarchy.