Accounts

Used for performing operations on Accounts

get

Returns a list of Accounts

post

Creates a new account.

Performs operations on a single Account.

get

Returns the Account

delete

Deletes the Account

put

Updates the Account that the Id belongs to.

get

Returns a list of actions that can be performed.

post

Performs an action. Possible action types are - enable, disable, delete, approve, unapprove, destroy, destroy.

put

Updates an account.

A collection of comment.

get

Returns a list of Comments.

post

Adds a new Comment.

Performs operations on a single Comment.

get

Returns a Comment.

post

Copies an existing Account

A collection of follower.

get

Returns a list of users that are following this object.

A collection of attachment.

get

Returns a list of attachments.

post

Creates a new attachment.

get

Returns the details for a specific attachment on a specific user defined object.

put

Updates the comment for an existing attachment.

delete

Deletes an existing attachment.

A collection of history.

get

Returns a list of events.

get

Returns the metadata associated with the Account, including an href link to the metadata definition.

put

Updates the metadata instance associated with the metadata. A valid XML metadata structure is expected in the body. The updated metadata will be returned if the request was successful.

A collection of member object links.

get

Returns the Users associated with the Account.

A collection of workspace object links.

get

Returns the Workspaces defined for the Account.

A collection of subAccount object links.

get

Returns the Sub-Accounts defined for the Account.

A collection of property object links.

get

Returns a list of Properties defined for a specific Account. This is only available in 5.1.1 onwards.

post

Creates a new Account/System Property

put

Updates the properties for the Account.

delete

Deletes the properties for the Account.

A collection of role object links.

get

Returns the Roles defined for the Account.

get

Returns the Account Workspace defined for the Account.

get

Returns a list of Variants a specific Account.

get

Returns a list of external IDs associated with an Account.

post

Creates new external ID.

get

Returns the details for a specific external ID.

put

Updates the Account/System Property

delete

Deletes a specific external ID.

Account Properties

Used for performing operations on Account/System Properties

get

Returns a list of Account/System Properties

post

Returns a list of Account/System Properties

Performs operations on a single Account/System Property

get

Returns the Account/System Property

put

Updates the Account/System Property

delete

Deletes the Account/System Property

post

Copies an existing Workflow Definition.

get

Returns a list of external IDs associated with an Account.

post

Creates new external ID.

get

Returns the details for a specific external ID.

put

Updates the Account/System Property

delete

Deletes a specific external ID.

Account Workspace

get

Returns the corresponding Workspace for the account that is currently in use.

post

Copies an existing Workflow Definition.

get

Returns a list of external IDs associated with an Account.

post

Creates new external ID.

get

Returns the details for a specific external ID.

put

Updates the Account/System Property

delete

Deletes a specific external ID.

Actions

Perform operations on Actions

get

Returns a list of Actions Listing is based on supplied filters.

post

Create a new action for a given action type and plugin.

Perform operations on a specific Action

get

Returns details of the Action

put

Update the details of the Action

delete

Delete the Action

get

Returns a list of actions that can be performed.

post

Performs an action. Possible action types are - enable, disable, start, stop, delete, retry, cancel, schedule, approve, unapprove, destroy, destroy.

A collection of comment.

get

Returns a list of Comments.

post

Adds a new Comment.

Performs operations on a single Comment.

get

Returns a Comment.

post

Copies an existing Action.

A collection of follower.

get

Returns a list of users that are following this object.

A collection of attachment.

get

Returns a list of attachments.

post

Creates a new attachment.

get

Returns the details for a specific attachment.

put

Updates the comment for an existing attachment.

delete

Deletes an existing attachment.

A collection of history.

get

Returns a list of events.

get

Returns the metadata instance of the action including an href to the metadata definition.

put

Updates the metadata instance associated with the configuration. A valid XML metadata structure is expected in the body. The updated metadata will be returned if the request was successful.

get

Returns file instances associated with an action (could have no files, one or several instances)

get

Returns a list of external IDs associated with an Account.

post

Creates new external ID.

get

Returns the details for a specific external ID.

put

Updates the Account/System Property

delete

Deletes a specific external ID.

get

Returns a list of variables associated with a specific action.

get

Returns the details for a specific variable that is associated with a particular action.

get

Returns a list of options that are available for the specific object variable.

Assets

This resource is used for managing Assets

get

Returns a list of Assets Listing is based on supplied filters

post

Create new placeholder asset.

Perform operations on a specific Asset

get

Returns the Asset object details (account, workspace, owner, title etc.), asset file information and technical information (media or image contexts). You can also list multiple assets by entering a list of Asset ids separated by a semicolon e.g /api/assets;id=1234;id=2345;id=3456

put

Update an Asset details (only editable properties).

get

Returns a list of existing annotations made against a timeline in MAM.

post

Creates an annotation on a timeline in MAM. When specifying an originatorContext you can enter MioAssetReview, QCReport, or leave the field empty.

Performs operations on a specific Annotation.

put

Adds a new Comment.

delete

Deletes an existing annotation a ne.

A collection of comment.

get

Returns a list of Comments.

post

Adds a new Comment.

Performs operations on a single Comment.

get

Returns a Comment.

post

Copies an existing Asset.

A collection of follower.

get

Returns a list of users that are following this object.

A collection of attachment.

get

Returns a list of attachments.

post

Creates a new attachment.

get

Returns the details for a specific attachment.

put

Updates the comment for an existing attachment.

delete

Deletes an existing attachment.

A collection of history.

get

Returns a list of events.

A collection of reference object links.

get

Returns a list of references.

get

Returns the metadata associated with the asset, including an href link to the metadata definition.

put

Updates the metadata instance associated with the metadata. A valid XML metadata structure is expected in the body. The updated metadata will be returned if the request was successful.

A collection of job object links.

get

Returns a list of jobs associated with the asset. Listing composed of href links to the job resource and is based on supplied filters.

A collection of workflow object links.

get

Get a list of workflows, based on supplied filters.

Operations on asset keyframes.

get

Returns a list of keyframes, based on supplied filters.

post

Creates a new keyframe from an existing Asset.

get

Returns details of the specific keyframe.

put

Updates details of the keyframe.

delete

Deletes the keyframe.

get

Returns the keyframe image.

get

Returns a stream of bytes.

Used for viewing published players.

get

Returns a list of associated players.

Returns a list of Actions which can be executed on the asset based on its current state.

get

Returns a list of Actions which can be executed on the asset based on its current state.

Performs operations on parent asset group memberships.

delete

Deletes multiple member Assets from a group. You can specify multiple members of the group that you wish to delete, by simply specifying the ID for each Asset.

Performs operations on parent asset group memberships.

get

Returns a list of parent group memberships.

post

Creates a new membership with a parent group.

get

Returns details of the specific asset membership.

put

Updates the membership with the parent group.

delete

Delete the membership with the parent group.

Performs operations on child asset memberships for a given asset group.

get

Returns a list of asset memberships (children). This resource is only available for asset groups.

post

Creates a new membership with a child asset.

get

Returns details of the specific asset membership.

put

Updates the membership with the child member.

delete

Delete the membership with the child member.

A collection of child object links.

get

Returns the child file Assets This is only available for file assets which have child file assets.

get

Returns the parent file Asset. This is only available for file assets which have a parent.

get

Returns a list of active proxies available for a specific Asset.

get

Returns a list of external IDs associated with an Account.

post

Creates new external ID.

get

Returns the details for a specific external ID.

put

Updates the Account/System Property

delete

Deletes a specific external ID.

get

Returns the media region that is associated to the asset if there is one. This is only available for 5.3.0 onwards.

post

Creates a new media region for a Clip or MediaAsset. This is only available for 5.3.0 onwards.

put

Updates the media region of an asset. This is only available for 5.3.0 onwards

delete

Deletes the media region of an asset if there is one. This is only available for 5.3.0 onwards.

get

Returns all placed media regions that belong to the specified asset. This is only available for 5.3.0 onwards.

post

Creates a new media region for a Sequence or MediaAsset. This is only available for 5.3.0 onwards. Media regions are only for clips or media-assets, but immutable for media-assets. Placed Media Regions are only for sequences or media-assets, but immutable for media-assets. Note that Timestamps are in microseconds.

get

Returns the placed media region found by specified id for a specified asset id. This is only available for 5.3.0 onwards.

put

Updates the placed media region found by specified id for a specified asset id. This is only available for 5.3.0 onwards.

Collections

This resource is used for viewing Collections.

get

Returns a list of Collections.

post

Creates a new Collection.

get

Returns Collection found by specified id.

put

Updates the collection.

delete

Deletes a Collection found by specified id.

put

Returns the Assets found by specified ID. You can also remove Assets from a collection.

get

Returns a list of items.

A collection of comment.

get

Returns comments for a specific collection.

post

Posts a new comment on a specific collection.

Performs operations on a single Comment.

get

Returns a specific comment for a specific collection.

put

Updates a comment for a specified Object within a collection.

delete

Deletes a comment on a specific object within a collection.

post

Copies an existing Collection.

A collection of follower.

get

Returns comments for a specific collection.

A collection of attachment.

get

Returns attachments for a specific collection.

post

Adds a new attachment to the collection.

get

Returns the details for a specific attachment.

put

Updates the comment for an existing attachment.

delete

Deletes an existing attachment.

A collection of history.

get

Returns the history for the given collection.

A collection of reference object links.

get

Returns the references for the given collection.

get

Returns the comments for the given Variable Instance.

post

Adds a new comment to the Variable Instance.

delete

Deletes a comment on a specific object within a collection.

get

Returns Sub-collections for the given collection.

A collection of keyframe.

get

Get all keyframe, optionally filtered

post

Sets a new Keyframe to the collection.

put

Updates the Collection's Keyframe with an existing one.

delete

Deletes a Keyframe for a collection.

get

Returns a list of external IDs associated with an Account.

post

Creates new external ID.

get

Returns the details for a specific external ID.

put

Updates the Account/System Property

delete

Deletes a specific external ID.

Events

This resource is used for viewing Events

get

Returns a list of Events. Listing is based on supplied filters.

post

Create a new Event

Perform operations on a specific Event

get

Returns Event object details (priority, event-type, event-data).

Event Handlers

This resource is used for viewing and managing EventHandlers

get

Returns a list of EventHandlers. Listing is based on supplied filters.

Perform operations on a specific EventHandler

get

Returns EventHandler object details.

delete

Deletes the EventHandler

get

Returns a list of actions that can be performed.

post

Performs an action. Possible action types are - delete, destroy.

A collection of comment.

get

Returns a list of Comments.

post

Adds a new Comment.

Performs operations on a single Comment.

get

Returns a Comment.

post

Copies an existing Event Handler.

A collection of follower.

get

Returns a list of users that are following this object.

A collection of attachment.

get

Returns a list of attachments.

post

Creates a new attachment.

get

Returns the details for a specific attachment.

put

Updates the comment for an existing attachment.

delete

Deletes an existing attachment.

A collection of history.

get

Returns a list of events.

A collection of reference object links.

get

Returns a list of references.

Set or get the event configuration.

get

Returns the event handler configuration including an href to the configuration.

put

Updates the metadata instance associated with the configuration. A valid XML metadata structure is expected in the body. The updated metadata will be returned if the request was successful.

get

Returns a list of external IDs associated with an Account.

post

Creates new external ID.

get

Returns the details for a specific external ID.

put

Updates the Account/System Property

delete

Deletes a specific external ID.

Groups

Perform operation on Groups

get

Returns a list of Groups. Listing is based on supplied filters.

post

Creates a new Group.

Perform operations on a specific Group.

get

Returns Group object details.

put

Updates the group that the id belongs to.

delete

Deletes the Group

get

Returns a list of actions that can be performed.

post

Performs an action. Possible action types are - enable, disable, delete, retry, destroy.

A collection of comment.

get

Returns a list of Comments.

post

Adds a new Comment.

Performs operations on a single Comment.

get

Returns a Comment.

post

Copies an existing Group.

A collection of follower.

get

Returns a list of users that are following this object.

A collection of attachment.

get

Returns a list of attachments.

A collection of history.

get

Returns a list of events.

A collection of reference object links.

get

Returns a list of references.

get

Returns the metadata of a specific group.

put

Updates the metadata instance associated with the metadata. A valid XML metadata structure is expected in the body. The updated metadata will be returned if the request was successful.

Enables you to add a member to the group. You must also provide the IDs of all the other group members in order to add a new member. The same applies for updating any existing members. You must remove any member IDs if you want to remove those members from the group. Only available from 5.1.1 onwards.

get

Returns a list of users that are members of the specific role. Listing is based on supplied filters.

get

Returns a list of external IDs associated with an Account.

post

Creates new external ID.

get

Returns the details for a specific external ID.

put

Updates the Account/System Property

delete

Deletes a specific external ID.

Jobs

This resource is used for viewing, creating and managing Jobs

get

Returns a list of Jobs. Listing is based on supplied filters

post

Create new Job for a given asset, action and configuration.

Perform operations on a specific Job. You can also list multiple Jobs by entering a list of Job ids separated by a semicolon e.g /api/jobs;id=1234;id=2345;id=3456.

get

Returns details of the Job including the action type, plugin, state etc. This includes an href link to the asset, an href link to any parent job, href link to any associated workflow instance, an href link to the action and an Href links to any sub-jobs (in the case of a group job) would also be returned.

get

Returns a list of actions that can be performed.

post

Performs an action. Possible action types are - enable, disable, start, stop, delete, retry, cancel, schedule, approve, unapprove, destroy.

A collection of comment.

get

Returns a list of Comments.

post

Adds a new Comment.

Performs operations on a single Comment.

get

Returns a Comment.

post

Copies an existing Job.

A collection of follower.

get

Returns a list of users that are following this object.

A collection of attachment.

get

Returns a list of attachments.

post

Creates a new attachment.

put

Updates the comment for an existing attachment.

delete

Deletes an existing attachment.

A collection of history.

get

Returns a list of events.

A collection of reference object links.

get

Returns a list of references.

Perform a callback on the specified resource.

post

Set or get the job metadata.

get

Returns the job configuration including an href to the configuration.

put

Updates the metadata instance associated with the configuration. A valid XML metadata structure is expected in the body. The updated metadata will be returned if the request was successful.

post

Create a new Metadata Definition

get

Returns a list of external IDs associated with an Account.

post

Creates new external ID.

get

Returns the details for a specific external ID.

put

Updates the Account/System Property

delete

Deletes a specific external ID.

Metadata Definitions

Perform operations on Metadata Definitions

get

Returns a list of Metadata Definitions. Listing is based on supplied filters.

post

Create a new Metadata Definition.

Perform operations on a specific Metadata Definition.

get

Returns the details of the Metadata Definition.

put

Updates an existing Metadata Definition.

delete

Delete the Metadata Definition.

get

Returns a list of actions that can be performed.

post

Performs an action. Possible action types are - enable, disable, start, stop, delete, retry, cancel, schedule, approve, unapprove, destroy.

post

Copies an existing Metadata Definition.

A collection of comment.

get

Returns a list of Comments.

post

Adds a new Comment.

Performs operations on a single Comment.

get

Returns a Comment.

put

Upates a comment made against a specific Metdata Definition.

delete

Deletes an existing comment made againsts a specific Metdata Defintion.

A collection of follower.

get

Returns a list of users that are following this object.

A collection of attachment.

get

Returns a list of attachments.

post

Creates a new attachment.

get

Returns the details for a specific attachment.

put

Updates the comment for an existing attachment.

delete

Deletes an existing attachment.

A collection of history.

get

Returns a list of events.

Perform operations on a specific metadata defintion metadata.

get

Returns the defintion of the metadata definition.

put

Updates the metadata instance associated with the definition. A valid XML metadata structure is expected in the body. The updated metadata will be returned if the request was successful.

get

Returns a list of external IDs associated with an Account.

post

Creates new external ID.

get

Returns the details for a specific external ID.

put

Updates the Account/System Property

delete

Deletes a specific external ID.

Message Templates

This resource is used for viewing and managing Message Templates.

get

Returns a list of Message Template bodies. Listing is based on supplied filters.

post

Creates a new Message Template.

Perform operations on a specific Message Template.

get

Returns Message Template object details.

put

Updates an existi.

delete

Deletes the Message Template.

get

Returns a list of actions that can be performed.

post

Performs an action. Possible action types are - delete, destroy.

A collection of comment.

get

Returns a list of Comments.

post

Adds a new Comment.

Performs operations on a single Comment.

get

Returns a Comment.

post

Copies an existing Message Template.

A collection of follower.

get

Returns a list of users that are following this object.

A collection of attachment.

get

Returns a list of attachments.

post

Creates a new attachment.

get

Returns the details for a specific attachment.

put

Updates the comment for an existing attachment.

delete

Deletes an existing attachment.

A collection of history.

get

Returns a list of events.

A collection of reference object links.

get

Returns a list of references.

Set or get the event configuration.

get

Returns the HTML body of the Message Template.

put

Updates the HTML body of the Message Template.

Objects

This resource is used for retrieving Objects.

get

Object Types

This resource is used for viewing information about Object Types including custom Objects Types created by users.

get

Returns a list of existing Object Types.

get

Returns the details of a specific Object Type.

get

Returns the details of a specific Object Type.

get

Returns the details of a specific Object Type.

get

Returns the details of a specific Object Type.

Players

Show existing Players

get

Returns a list of Players. Listing is based on supplied filters.

get

Returns details of a specific Player

A collection of comment.

get

Returns a list of comments.

post

Adds a new comment.

Performs operations on a single comment.

get

Returns a comment.

post

Copies an existing Player.

A collection of follower.

get

Returns a list of users that are following this object.

A collection of attachment.

get

Returns a list of attachments.

post

Creates a new attachment.

get

Returns the details for a specific attachment.

put

Updates the comment for an existing attachment.

delete

Deletes an existing attachment.

A collection of history.

get

Returns a list of events.

A collection of reference object links.

get

Returns a list of references.

get

Returns a list of external IDs associated with an Account.

post

Creates new external ID.