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 a 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 a 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.

Action Types

This resource lists all the action types that are associated with a specific asset.

get

Returns a list of all the action types that are associated with a specific asset.

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). While it is not possible to retrieve the full storage location of the Asset via API calls, you can use this endpoint to retrieve the Asset file's originalFileName and its currentLocation (for example, the asset location file path on Azure in the response - /ooflexdev.blob.core.windows.net/.../e9f3859c-1821-44a7-a3b5-2c4086f6410c.jpg). 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

Updates asset details (only editable properties). This endpoint also comes with an option set of schema which enables users to update the details of an existing asset.

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.

get

Returns a list of existing annotations made against a timeline.

post

Enables a user to post a single annotation on a timeline. When specifying an originatorContext you can enter MioAssetReview, QCReport, or leave the field empty.

Performs operations on a specific Annotation.

put

Updates an existing comment (annotation).

delete

Deletes an existing annotation.

post

Enables a user to post one or more annotations on a timeline in MAM. When you post multiple annotations simultaneously, all annotations must be placed within a single array. Please also take note, that when you specify an originatorContext you can enter MioAssetReview, QCReport, or leave the field empty.

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 a list of reviews.

get

Returns the details for a specific review session.

delete

Deletes a specific review session.

get

Returns the list of actions available to a user in a specific review session. FlexREVIEW now enables exclusive reviews - when such a session is taken by a user, it cannot be assigned to another user unless it is released. If the review session specified in the request is exclusive AND a user has taken the review session, the response will include an exclusiveReviewer section. This section will NOT be included in the API response if the review session is released (ended or not taken). The possible actions returned in the response, depending on the type of the review session and the current user's permissions, are DOWNLOADED, WATCHED, APPROVE, TAKE, and RELEASE.

post

Enables a user to take action on a review session they are assigned to. The possible actions are DOWNLOADED, WATCHED, and APPROVE. In addition, FlexREVIEW now enables exclusive reviews (when an exclusive review session is taken by a user, it cannot be assigned to another user unless it is released). A review session can only be defined as exclusive or not during its creation. If the review session is exclusive and the current user has sufficient user permissions, two more possible actions are also TAKE (if the specified review session is exclusive and is not taken, this action enables the current user to take the review session exclusively) and RELEASE (if the specified review session is taken by the current user, this action unassigns the current user from the exclusive review session and releases that session as available for taking by another user or by the same one again). Please note that all action values must be capitalized in the POST request. For example, a request for endpoint /api/assets/10105/reviews/102313/actions with { "action":"TAKE" } in the request body will assign the exclusive review session with id 102313 to the current user. The TAKE and RELEASE actions are only available if the specified review session was created as exclusive AND your user permissions are sufficient (Permissions > Access > Roles > Permissions from the UI). You can force the release of a review session both via the UI and also via the API - if you have the correct permissions for that, there is no need for the review session to have been taken in order to be released. IMPORTANT - if a user is disabled in the system, all exclusive review sessions taken by that user will be released. If the specified review session is exclusive and is taken by the current user, when the current user finishes the review the review will get released. If an exclusive review session is approved, this will automatically release the session if it has been blocked.

get

Retrieves a list of comments made during a specific review session.

get

Retrieves a list of reviewers and the status for each reviewer in a specific review session.

get

Retrieves the status information for a specific reviewer in review session.

put

Enables a user to change the status information for a specific reviewer in review session.

post
put

Enables a user to post a comment against a specific range of frames within an asset, in a review session.

get

Returns the metadata associated with the asset, including a href link to the metadata definition. If you search using a specific metadata field and value, you must specify the metadata definition first. For example - /api/assets;metadataDefinitionId=123441;metadata=processing-profile-uri-id:II316007618_profile_no_drm_id;limit=1

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 that can be executed on the asset based on its current state.

post

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

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

This endpoint enables you to add an existing asset to an asset group in MAM by specifying the asset ID. This endpoint also enables you to specify the index for the asset you are adding. You can use the index field to specify the order in which a new member will appear in a group. You can specify the order of an asset by entering a number in the index field. For example - you might have 10 members already in the group, but you may want your new member to be listed in 1st place. So in order for your new member to appear in 1st place, you would enter 1 in the index field.

delete

Deletes an existing membership.

put

This endpoint updates the order of an existing member within an asset group in MAM. For example - you might have 10 members in a group and you might want to change the order of one of the existing members. You can use the index field to change the order of a specific member by entering a number. If you wanted a member of the group to be listed in 5th place, you would enter 5 in the index field.

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.

get

Returns all of the subtitle assets that are linked to a specific media asset.

get

Returns a list of object hierarchies for the specified media asset. You can use two optional matrix parameters in the request for this endpoint - context and level. For example context=upward is used to request the upward hierarchy for the asset, and level specifies the number of levels (parents) in the object hierarchy (up to 6). The response should have the following fields - id, name, displayName, objectType, and a list of parent group assets. Example - /api/assets/31315/hierarchy;context=upward;level=2

Collections

This resource is used for viewing Collections.

get

Returns a list of Collections.

post

Creates a new Collection. Please note that you can now use the new fql property to save an FQL as a dynamic query. This is a new 'type' of collection that you can define by using an FQL query defined instead of a specific asset. The fql property is an optional string type that can contain up to 2000 characters. You can then use the GET method with type=dynamic matrix parameter to retrieve dynamic collections - for example, /api/collections;type=dynamic (see the GET method description for more information).

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.

Evaluation

This resource is used for evaluating URLs for panel supported user defined objects.

post

This endpoint is used to evaluate URLs for panel supported user defined objects.

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).

Enables a user to retrieve a file that is stored in the filestore. This is related to the "File" field type in the Metadata Designer. Files can be associated with the "File" field type, such as an image (thumbnail) or a JSON file.

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 a 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.

Files

Performs operations on non-asset files that are stored in the filestore.

get

Retrieves a non-asset file that is stored in the filestore. This includes attachments such as JSON files and images. You must use a GET request to obtain the file path name for the file Example- /api/versions/406690/data, then you can use the file path name to download the file. Example - api/files/3f9de7f0-f9a7-4141-a58f-6eda0518a15f.png.

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 a href link to the asset, a href link to any parent job, href link to any associated workflow instance, a href link to the action and a href link 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 history.

get

Returns a list of events.

Perform a callback on the specified resource.

post

Set or get the job metadata.

get

Returns the job configuration including a 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

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.

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.

get

Returns a list of existing User Defined Object Types.

get

Returns the details of a specific object type.

get

Returns the details of a specific user object type.

get

Returns the details of a specific asset 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.

get

Returns the details for a specific external ID.

put

Updates the Account/System Property.

delete

Deletes a specific external ID.

Player Definitions

This resource is used for viewing and managing Player Definitions.

get

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

Perform operations on a specific Player Definitions.

get

Returns Player Definition object details.

delete

Deletes a Player 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.

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 Definition.

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 player's configuration.

get

Returns the player's configuration including a 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.

get

Returns file instances from the Metadata of a Player Definition, Action configuration, or resource configuration.

Plugins

This resource is used for viewing existing Plugins

get

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

Profiles

Perform operations on Profiles

get

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

post

Create a new profile.

Perform operations on a specific Profile

get

Returns the details of the Profile

put

Update the profile.

delete

Deletes the Profile

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 Profile.

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 instance of the profile including a href link 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 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.

Quotas

This resource is used for viewing and managing Quotas

get

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

post

Creates a new Quota.

Perform operations on a specific Quota.

get

Returns Quota object details.

put

Updates an existing a new Quota.

delete

Deletes a Quota

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 Quota.

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 quota's configuration.

get

Returns the quota's configuration including a 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.

Report Definitions

This resource is used for viewing Report Definitions

get

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

get

Returns details of a specific Report Definition

delete

Deletes a Report Definition

get

Returns a list of actions that can be performed.

post

Performs an action. Possible action types are - enable, disable, start, stop, 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 Report Definition.

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.

get

Returns the details for a specific external ID.

put

Updates the Account/System Property

delete

Deletes a specific external ID.

Resources

Perform operations on Resources

get

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

Perform operations on a specific Resource

get

Returns details of the Resource

delete

Deletes the Resource

get

Returns a list of actions that can be performed.

post

Performs an action. Possible action types are - enable, disable, start, stop, 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 Resource.

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 a callback on the specified resource.

post

Performs a callback.

get

Returns the metadata instance of the resource including a href to the metadata definition.

put

Updates the metadata instance of the resource including a href to the metadata definition.

A collection of item.

get

Returns a list of resource items based on specified filters.

get

Returns details of a resource item

A collection of storageResource.

get

Returns the storage resources for a folder resource.

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.

Roles

Perform operation on Roles

get

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

post

Creates a Role

Perform operations on a specific Role

get

Returns Role object details.

put

Updates the role that the Id belongs to.

delete

Deletes a Role

get

Returns a list of actions that can be performed.

post

Performs an action. Possible action types are - enable, disable, 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 Role.

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 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.

Tasks

Perform operation on Tasks

get

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

Perform operations on a specific Task

get

Returns Task object details. You can also list multiple Tasks by entering a list of Task ids separated by a semicolon e.g /api/assets;id=1234;id=2345;id=3456

post

Update the status of the task.

Task Definitions

This resource is used for viewing Task Definitions

get

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

post

Creates a new Task Definition.

get

Returns details of a specific Task Definition

put

Creates a new Task Definition.

delete

Deletes a Task 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.

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 Task Definition.

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 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.

Timelines

This resource is used for viewing, creating and managing timelines

get

Returns the details of all timelines.

post

Enables a user to create a new timeline.

get

Returns the details of a specific timeline.

put

Enables a user to update the details of a specific timeline.

delete

Deletes a specific timeline.

Timed Actions

This resource is used for viewing, creating and managing Timed Actions

get

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

post

Creates a new Timed Action

Perform operations on a specific Timed Action

get

Returns details of the Timed Action

put

Update the details of a Timed Action

delete

Deletes a Timed Action

get

Returns a list of actions that can be performed.

post

Performs an action. Possible action types are - start, stop, 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 Metadata Definition.

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 configuration of the timed-action.

get

Returns the timed-action's configuration including a 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.

Users

This resource is used for managing Users

get

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

post

Creates a new user

Perform operations on a specific User

get

Returns User object details.

delete

Deletes a User

put

updates the user 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, 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 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.

A collection of reference object links.

get

Returns a list of references.

get

Returns the metadata associated with the user, including a 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 group object links.

get

Returns a list of groups associated with the user. Listing composed of href links to the group resource and is based on supplied filters.

A collection of workspace object links.

get

Returns a list of workspaces associated with the user. Listing composed of href links to the workspace resource and is based on supplied filters.

A collection of accessibleWorkspace object links.

get

Returns a list of accessible workspaces for the user. Listing composed of href links to the workspace resource and is based on supplied filters.

get

Returns the user's picture if one has been uploaded.

put

Updates the user profile picture.

Returns an image.

get

A collection of activity.

get

Returns a list of user's events. Listing is based on supplied filters.

A collection of following object links.

get

Returns a list of objects that are followed by the specific user. 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.

User Defined Object Type Definitions

This resource is used for managing user defined object type definitions.

get

Returns the hierarchy information associated with user defined object types.

post

Enables a user to create a new user defined object type.

get

Returns the hierarchy information associated with a sepcific user defined object type.

put

Enables a user to update the information for a specific user defined object type.

User Defined Object Type Instances

This resource is used for managing user defined object type instances.

get

Returns a list of custom objects created by a user. For example if a user creates a custom object type called 'Episodes', you would simply need to type 'api/episodes/' in order to view all objects of that type.

post

Creates a new user defined object. Fields are as follows- name, description, parentObjectId, accountId, and workspaceId.

delete

Enables a user to delete a user defined object instance by specifying the ID of the instance.

post

Enables a user to destroy a User Defined Object Type Instance. You can do this by specifying "destroy" in the action field in the body of the call.

get

Returns details of a specific User Defined Object. For example if you wanted to view the details for a specific custom object such as an individual episode, you would type 'api/episodes/{userDefinedObjectTypePluralNameId}. You can also list multiple User Defined Objects by entering a list of User Defined Object ids separated by a semicolon e.g /api/episodes;id=1234;id=2345;id=3456

put

Updates a specific user defined object. Fields are as follows- name, description.

get

Returns a list of data for a specific user defined object.

put

Updates the data for a specific user defined object.

A collection of comment.

get

Returns a list of comments about a specific user defined object.

post

Posts a new comment on a specific user defined object.

get

Returns a list of details for a specific comment.

put

Updates an existing comment on a specific user defined object.

delete

Deletes an existing comment on a specific user defined object.

post

Copies an existing User Defined Object.

A collection of follower.

get

Returns a list of users who are currently following a specific user defined object.

A collection of history.

get

Returns the details for the history of a specific user defined object.

A collection of attachment.

get

Returns a list of attachments for a specific user defined object.

post

Creates a new attachment.

A collection of reference.

get

Returns of references for a specific user defined object.

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.

Variants

This is used for viewing a list of Variants.

get

Returns a list of existing Variants.

post

Allows you to create a new variant.

get

Returns the details of a particular Variant.

put

Allows you to edit a specific Variant.

delete

Allows you to delete a specific variant.

post

Copies an existing Variant.

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.

Wizards

This resource is used for viewing Wizards

get

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

post

Creates a new Wizard. When specifying the details for your new Wizard, you must indicate if the Wizard is a Toolbar Wizard, a Task Wizard, or a Stand Alone Wizard. Possible action types are - enable, disable, start, stop, delete, retry, cancel, schedule, approve, unapprove, destroy.

get

Returns details of a specific Wizard

put

Updates the details for an existing Wizard. Possible action types are - enable, disable, start, stop, delete, retry, cancel, schedule, approve, unapprove, destroy.

delete

Deletes a Wizard

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 Wizard.

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 all active Wizard 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.

Workflows

This resource is used for viewing Workflows

get

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

post

Creates a new workflow.

View details of a Workflow group.

post

Creates a Workflow group.

get

Returns the details for a specific Workflow group.

put

Updates the details of a Workflow group.

View details of a specific Workflow

get

Returns details of the workflow including a href link to the asset and a href link to the workflow 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.

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 Workflow.

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.

View the jobs for the workflow instance.

get

Returns a list of jobs for the current workflow. The listing composed of href links to the job resource and based on supplied filters.

Returns the JSON representation of a workflow instance. Each node will link to an array of running jobs or tasks.

get

Returns the workflow nodes found by specified id.

Perform operations on Workflow signals.

get

Returns a list of signals for the workflow.

post

Signal the workflow.

get

Returns a hashmap of all the JBPM variables for that Workflow.

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.

Workflow Definitions

Perform operations on Workflow Definitions

get

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

post

Create a new Workflow Definition

Perform operations on a specific Workflow Definition

get

Returns the details of an Workflow Definition. This includes a list of nodes with href links to the corresponding action.You can also list multiple Workflow definitions by entering a number of Workflow Definition ids separated by a semicolon e.g /api/workflowDefinitions;id=1234;id=2345;id=3456

put

Update the details of the Workflow Definition

delete

Deletes the Workflow 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.

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 Workflow Definition.

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

Get the workflow definition graph image.

put

Updates the workflow-defintion. A valid XML metadata structure is expected in the body.

get

Returns the JSON representation of a workflow definition. Each node will link to an action or task-definition and contain a layout object. Available from 5.1.1 onwards- replaces /nodes.

put

Updates a Workflow Definition. Available from 5.1.1 onwards- replaces /nodes.

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.

Workspaces

This resource is used for viewing and managing Workspaces

get

Returns a list of Workspaces. Listing is based on supplied filters.#

post

Creates a new Workspace

Perform operations on a specific Workspace

get

Returns Workspace object details.

put

Updates a Workspace.

delete

Deletes a Workspace

get

Returns a list of actions that can be performed.

post

Performs an action. Possible action types are - enable, disable, delete, retry, 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 Workspace.

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 metadata of the workspace.

get

Returns the workspace's metadata including a href to the metadata.

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.

The workspace members

get

Returns the workspace members found by the specified ID.

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.