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 the asset with the given ID.
-
aa:asset-by-id-bulk Bulk call to get information about multiple assets.
-
aa:asset-selective-by-id Get a selected subset of information for an asset.
-
aa:delete-asset-by-id Delete the asset with the given ID.
-
aa:update-asset-by-id Update the asset with the given ID.
Data Model
-
datamodel:asset-model-by-id Get data model information for an asset.
-
datamodel:asset-model-by-type Get data model information for assets of a given type.
-
datamodel:aggregated-model Get the aggregated data model information for all systems.
-
datamodel:system-model Get the general data model information of a system.
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.
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.
Taxonomies
-
taxonomies:taxonomies Get the root resource with link rels for functionality regarding taxonomies of a system.
-
taxonomies:taxonomy-by-taxonomyid Get information about a taxonomy.
-
taxonomies:entry-by-taxonomyid-and-entryid Get a taxonomy entry.