Assets (aa)
-
aa:asset-by-id-bulk: Bulk call to get information about multiple assets.
-
aa:asset-by-id: Get information about the asset with the given ID.
-
aa:asset-selective-by-id: Get a selected subset of information for the asset with the given ID.
-
aa:asset-selective: Get a selected subset of information for an asset.
-
aa:asset: Get information about a linked asset.
-
aa:assets: Get the root resource with link rels for functionality regarding assets of a system.
-
aa:attributes: Get custom attributes of an asset.
-
aa:create-asset: Create a new asset.
-
aa:delete-asset: Delete the asset.
-
aa:delete-asset-by-id: Delete the asset with the given ID.
-
aa:delete-time-based: Delete selected parts of the time-based annotation of an asset.
-
aa:keyframes: Get information about keyframe positions like shot borders, scene changes or markers of an asset.
-
aa:multi-value-attribute-by-attributeid: Get the rows of a multi-value attribute.
-
aa:multi-value-attribute-range-by-attributeid: Get a range of the rows of a multi-value attribute.
-
aa:set-thumb-command: Start a command to set the thumbnail for the asset.
-
aa:thumb: Get information about the thumbnail for the asset.
-
aa:time-based: Get the time-based annotation for the asset.
-
aa:update-asset: Update the asset.
-
aa:update-asset-by-id: Update the asset with the given ID.
-
aa:update-attributes: Update custom attributes of the asset.
-
aa:update-multi-value-attribute: Update the multi-value attribute.
-
aa:update-multi-value-attribute-by-attributeid: Update a multi-value attribute of an asset.
-
aa:update-time-based: Update time-based annotation of the asset.
Commands
-
command:cancel: Request cancellation of a long-running command.
Data model
-
datamodel:aggregated-model: Get the aggregated data model information for all systems.
-
datamodel:asset-model: Get data model information for the asset, including layout information.
-
datamodel:asset-model-by-id: Get data model information for an asset, including layout information.
-
datamodel:system-model: Get the general data model information of a system.
Locations (loc)
-
loc:add-item: Add an item to a folder.
-
loc:add-items: Add multiple items to a folder.
-
loc:collection: Get the collection of items in a folder.
-
loc:collection-at-itemid: Get the collection of items in a folder, starting with the given item ID.
-
loc:create-folder: Create a sub folder.
-
loc:delete-item: Delete the item.
-
loc:delete-item-by-id: Delete the item with the given ID.
-
loc:delete-item-by-id-bulk-command: Long-running bulk command to delete multiple items.
-
loc:delete-item-in-folder-by-id-bulk-command: Long-running bulk command to delete multiple items from the current folder.
-
loc:item: Get information about the item (folder or asset reference).
-
loc:item-by-id: Get information about an item (folder or asset reference) in the folder hierarchy.
-
loc:locations: Get the root resource with link rels for functionality regarding the folder structure of a system.
-
loc:move-item: Move an item to the folder.
-
loc:move-items: Move multiple items to the folder.
-
loc:parent-collection: Get the parent collection that contains the item.
-
loc:parent-folder: Get the parent folder that contains the item.
-
loc:path: Get one of the folders in the hierarchy of folders from the root folder to the current item.
-
loc:path-to-root: Get the hierarchy of folders from the root folder to the current item.
-
loc:referenced-object: Get the asset that is referenced by the current item.
-
loc:referencing-items: Get all references to the current asset in the entire folder hierarchy.
-
loc:root-item: Get the root item of the folder structure of a system.
-
loc:update-item: Update the item (folder or asset reference).
Protection
-
protection:delete-all-reservations: Delete all reservations on the current item.
-
protection:delete-reservation-by-creator: Delete the reservation that was created by the given user.
-
protection:delete-reservation: Delete the reservation that was created by the caller.
-
protection:reservations: Get the root resource with link rels for functionality regarding folder and asset reservations of a system.
-
protection:set-reservation-for-user: Create a reservation for the given user.
-
protection:set-reservation: Create a reservation for the caller.
Relations
-
relations:create-relation: Create a relation between the current entity to another entity.
-
relations:delete-relation: Delete the current relation.
-
relations:related-entity: Get information about the related entity.
-
relations:relation-type: Get information about a relation type.
-
relations:relation-types: Get the relation types that are supported for the current entity.
-
relations:relation: Get information about a relation between two entities.
-
relations:relations: Get information about all relations of the current entity to other entities.
Settings
-
settings:parent-section: Get the parent section.
-
settings:path: Get the array of sections from the root section to the current section.
-
settings:root-section: Get the root section of the settings hierarchy.
-
settings:section-by-path: Get a section of the settings hierarchy.
-
settings:settings: Get the root resource with link rels for functionality regarding settings of a system.
Taxonomies
-
taxonomies:child-entries: Get the child entries of the current entry.
-
taxonomies:create-child-entry: Create a child entry below the current entry.
-
taxonomies:create-entry: Create a top-level entry.
-
taxonomies:create-entry-bulk: Bulk call to create multiple top-level entries.
-
taxonomies:create-or-update-entry: Create or update an entry.
-
taxonomies:create-or-update-entry-bulk: Bulk call to create or update multiple entries.
-
taxonomies:default-entry: Get the default entry for the taxonomy.
-
taxonomies:delete-entry: Delete the entry.
-
taxonomies:entries: Get the top-level entries of the taxonomy.
-
taxonomies:entry-by-entryid: Get an entry of the taxonomy by its ID.
-
taxonomies:entry-by-entryid-bulk: Get multiple entries of the taxonomy by their ID.
-
taxonomies:entry-by-taxonomyid-and-entryid: Get the given entry from the given taxonomy.
-
taxonomies:entry: Link to a taxonomy entry.
-
taxonomies:hit-list: Get a recommended layout for showing a list of entries, e.g. in a pick tool.
-
taxonomies:move-entry: Move the entry to a different parent entry, including all child entries recursively.
-
taxonomies:parent-entry: Get the parent entry.
-
taxonomies:path-to-root: Get the path that leads to the taxonomy entry, from the top-level entry to the direct parent entry.
-
taxonomies:path: Link to one parent entry in the path in taxonomies:path-to-root.
-
taxonomies:search: Find taxonomy entries that match a given search condition.
-
taxonomies:taxonomies: Get the root resource with link rels for functionality regarding taxonomies of a system.
-
taxonomies:taxonomy: Link to a taxonomy.
-
taxonomies:taxonomy-by-taxonomyid: Get information about the given taxonomy.
-
taxonomies:taxonomy-list: Get a list of all taxonomies for a system.
-
taxonomies:taxonomy-model: Get the Meta data model for the taxonomy with information about the attributes that each entry can have.
-
taxonomies:update-entry: Update the current entry.
-
taxonomies:update-entry-bulk: Bulk call to update multiple entries of the taxonomy.
-
taxonomies:update-taxonomy: Update the properties of the taxonomy.
MediaCentral | Newsroom Management (ia)
-
ia:asset-by-uuid: Get an asset by its UUID.
-
ia:asset-nsml: Get an NSML representation of the asset.
-
ia:attributes: Get the attributes of a queue.
-
ia:colors: Get the list of colors defined in MediaCentral Newsroom Management system.
-
ia:copy-queue-stories: Copy stories from the current queue to a destination queue.
-
ia:copy-queue-stories-by-id: Copy stories from the queue with the given ID to a destination queue.
-
ia:copy-queue-stories-to-system-by-id: Copy stories from the queue with the given ID to a destination queue on different system.
-
ia:create-asset-with-position: Create an asset at a given position in the queue.
-
ia:create-queue-watcher: Create a watcher to get notified about queue changes.
-
ia:create-story: Create a story in the queue.
-
ia:delete-queue-by-id: Delete a given queue.
-
ia:delete-queue-stories: Delete stories in the queue.
-
ia:delete-queue-stories-by-id: Delete stories in a given queue.
-
ia:delete-queue-watcher: Remove the notification watcher.
-
ia:forms: Get a list of all system forms.
-
ia:form-by-name: Get a system form by its name.
-
ia:form-nsml: Get the NSML representation of the form.
-
ia:get-status-of-queue-notifications: Get the status of a user’s subscription to notifications of the current queue.
-
ia:get-status-of-queue-notifications-by-id: Get the status of a user’s subscription to notifications of the given queue.
-
ia:group-queue-stories: Group stories in the current queue.
-
ia:group-queue-stories-by-id: Group stories in the given queue.
-
ia:lock-asset: Put an edit lock on the asset or a part of it.
-
ia:lock-asset-by-id: Put an edit lock on a given asset or a part of it.
-
ia:monitor: Link to the monitor.
-
ia:monitor-servers: Link to the monitor servers resource.
-
ia:mos-map: Get the system’s MOS map.
-
ia:move-queue-stories: Move stories from this queue to a destination queue.
-
ia:move-queue-stories-by-id: Move stories from the given queue to a destination queue.
-
ia:order-queue-stories: Change the order of the stories in this queue.
-
ia:order-queue-stories-by-id: Change the order of the stories in the given queue.
-
ia:print-style-by-id: Get a printing style by its id.
-
ia:print-style-content: Get a textual representation of a printing style.
-
ia:print-styles: Get the list of all printing styles.
-
ia:queue-attributes-by-id: Get the queue attributes for the given queue.
-
ia:queue-by-id: Get the given queue.
-
ia:queue-stories: Get the list of stories in the current queue.
-
ia:queue-stories-by-id: Get the list of stories in the given queue.
-
ia:queue: Link to the queue.
-
ia:readrate-by-presenter: Get a presenter’s read rate.
-
ia:rundown: Link to the rundown queue for this monitor.
-
ia:script-template-by-id: Get the given script template.
-
ia:script-template-nsml: Gets the NSML representation of the script template.
-
ia:script-templates: Get the list of all script templates.
-
ia:subscribe-to-queue-notifications: Subscribe the current user to notifications about queue changes.
-
ia:subscribe-to-queue-notifications-by-id: Subscribe the current user to notifications about changes of the given queue.
-
ia:token-by-id: Get a system token value by its id.
-
ia:ungroup-queue-stories: Dissolve a group of stories, without changing the order.
-
ia:ungroup-queue-stories-by-id: Dissolve a group of stories in the given queue, without changing the order.
-
ia:unlock-asset: Remove a lock from an asset.
-
ia:unlock-asset-by-id-and-lockId: Remove a lock from a given asset.
-
ia:unsubscribe-from-queue-notifications: Unsubscribe the current user from notifications about queue changes.
-
ia:unsubscribe-from-queue-notifications-by-id: Unsubscribe the current user from notifications about changes of the given queue.
-
ia:update-attributes: Update the queue attributes.
-
ia:versions: Gets the list of all available versions of an asset.
MediaCentral | Production Management (pa)
-
pa:asset-medias: Get the media file information for the asset.