

Ooyala Flex Core
version 6.2.2
https://{flexUrl}/api
Accounts
Used for performing operations on Accounts
Returns a list of Accounts
Creates a new account.
get /accounts
Returns a list of Accounts
Query Parameters
- MatrixParam['name']: (string)
- MatrixParam['description']: (string)
- MatrixParam['enabled']: (boolean)
- MatrixParam['deleted']: (boolean - default: false)
- MatrixParam['account']: (string)
-
MatrixParam['exactNameMatch']: (string)
Pass it true if you want to search an Object using the exact name.
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
-
MatrixParam['externalId']: (string)
Search for an object via its endpoint (e.g. assets, workflows) and specify the external ID key and value, e.g. For example /api/assets;externalId=key:value
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /accounts
Creates a new account.
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"name": {
"type": "string",
"required": true
},
"description": {
"type": "string",
"required": false
},
"variant": {
"type": "string",
"required": false
}
}
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Performs operations on a single Account.
Returns the Account
Deletes the Account
Updates the Account that the Id belongs to.
get /accounts/{accountId}
Returns the Account
URI Parameters
-
accountId: required (integer)
Account ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
delete /accounts/{accountId}
Deletes the Account
URI Parameters
-
accountId: required (integer)
Account ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
put /accounts/{accountId}
Updates the Account that the Id belongs to.
URI Parameters
-
accountId: required (integer)
Account ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"name": {
"type": "string",
"required": true
},
"description": {
"type": "string",
"required": false
},
"variant": {
"type": "string",
"required": false
},
"metadataDefinitionId": {
"type": "long",
"required": true
}
}
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns a list of actions that can be performed.
Performs an action. Possible action types are - enable, disable, delete, approve, unapprove, destroy, destroy.
Updates an account.
get /accounts/{accountId}/actions
Returns a list of actions that can be performed.
URI Parameters
-
accountId: required (integer)
Account ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['context']: (string)
This query parameter enables you to retrieve a list of objects with references. For example if you wanted to retrieve a list of actions with references, you would do the following /api/actions?context=reference.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /accounts/{accountId}/actions
Performs an action. Possible action types are - enable, disable, delete, approve, unapprove, destroy, destroy.
URI Parameters
-
accountId: required (integer)
Account ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"action": {
"type": "string",
"required": true
}
}
}
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"name": {
"type": "string",
"required": false
},
"type": {
"type": "string",
"required": false
},
"variant": {
"type": "string",
"required": false
},
"enabled": {
"type": "boolean",
"required": false
},
"deleted": {
"type": "boolean",
"required": false
},
"href": {
"type": "string",
"required": false
},
"owner": {
"type": "string",
"required": false
}
}
}
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
put /accounts/{accountId}/actions
Updates an account.
URI Parameters
-
accountId: required (integer)
Account ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
A collection of comment.
Returns a list of Comments.
Adds a new Comment.
get /accounts/{accountId}/comments
Returns a list of Comments.
URI Parameters
-
accountId: required (integer)
Account ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /accounts/{accountId}/comments
Adds a new Comment.
URI Parameters
-
accountId: required (integer)
Account ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Performs operations on a single Comment.
Returns a Comment.
get /accounts/{accountId}/comments/{commentId}
Returns a Comment.
URI Parameters
-
accountId: required (integer)
Account ID
-
commentId: required (integer)
Comment ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Copies an existing Account
post /accounts/{accountId}/copy
Copies an existing Account
URI Parameters
-
accountId: required (integer)
Account ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"name": {
"type": "string",
"required": true
},
"description": {
"type": "string",
"required": false
}
}
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
A collection of follower.
Returns a list of users that are following this object.
get /accounts/{accountId}/followers
Returns a list of users that are following this object.
URI Parameters
-
accountId: required (integer)
Account ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
A collection of attachment.
Returns a list of attachments.
Creates a new attachment.
get /accounts/{accountId}/attachments
Returns a list of attachments.
URI Parameters
-
accountId: required (integer)
Account ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /accounts/{accountId}/attachments
Creates a new attachment.
URI Parameters
-
accountId: required (integer)
Account ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"fileName": {
"type": "string",
"required": true
},
"mimeType": {
"type": "string",
"required": false
},
"description": {
"type": "string",
"required": false
},
"fileContent": {
"type": "string",
"required": true
}
}
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns the details for a specific attachment on a specific user defined object.
Updates the comment for an existing attachment.
Deletes an existing attachment.
get /accounts/{accountId}/attachments/{attachmentId}
Returns the details for a specific attachment on a specific user defined object.
URI Parameters
-
accountId: required (integer)
Account ID
- attachmentId: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
put /accounts/{accountId}/attachments/{attachmentId}
Updates the comment for an existing attachment.
URI Parameters
-
accountId: required (integer)
Account ID
- attachmentId: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"description": {
"type": "string",
"required": true
}
}
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
delete /accounts/{accountId}/attachments/{attachmentId}
Deletes an existing attachment.
URI Parameters
-
accountId: required (integer)
Account ID
- attachmentId: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
A collection of history.
Returns a list of events.
get /accounts/{accountId}/history
Returns a list of events.
URI Parameters
-
accountId: required (integer)
Account ID
Query Parameters
- MatrixParam['objectId']: (integer - minimum: 0)
-
MatrixParam['objectType']: (string)
One or more objectTypes can be provided. This parameter can't be used when an objectId is already provided.
-
MatrixParam['accountId']: (string)
One or more accountId can be provided.
-
MatrixParam['severity']: (one of Info, Error, Warn)
One or more severities can be provided.
-
MatrixParam['eventType']: (string)
One or more eventTypes can be provided.
- MatrixParam['ownerId']: (integer - minimum: 0)
-
MatrixParam['from']: (date)
Last modified to date. Supported date formats are:
- dd MMM yyyy hh:mm:ss Z
- dd MMM yyyy hh:mm:ss
- dd MMM yyyy
- now (translated as current date and time)
-
MatrixParam['to']: (date)
Last modified to date. Supported date formats are:
- dd MMM yyyy hh:mm:ss Z
- dd MMM yyyy hh:mm:ss
- dd MMM yyyy
- now (translated as current date and time)
-
MatrixParam['attribute']: (string)
One or more attributes can be provided.
-
MatrixParam['value']: (string)
One or more values can be provided.
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns the metadata associated with the Account, including a href link to the metadata definition.
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.
get /accounts/{accountId}/metadata
Returns the metadata associated with the Account, including a href link to the metadata definition.
URI Parameters
-
accountId: required (integer)
Account ID
Headers
-
Accept: (string)
Method will return JSON by default, but will return XML if set to application/xml.
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
put /accounts/{accountId}/metadata
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.
URI Parameters
-
accountId: required (integer)
Account ID
Headers
-
Accept: (string)
Method will return JSON by default, but will return XML if set to application/xml.
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+xml
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+xml
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
A collection of member object links.
Returns the Users associated with the Account.
get /accounts/{accountId}/members
Returns the Users associated with the Account.
URI Parameters
-
accountId: required (integer)
Account ID
Query Parameters
- MatrixParam['name']: (string)
- MatrixParam['description']: (string)
- MatrixParam['enabled']: (boolean)
- MatrixParam['deleted']: (boolean - default: false)
- MatrixParam['account']: (string)
-
MatrixParam['exactNameMatch']: (string)
Pass it true if you want to search an Object using the exact name.
- MatrixParam['firstName']: (string)
- MatrixParam['lastName']: (string)
- MatrixParam['company']: (string)
- MatrixParam['roleId']: (integer - minimum: 0)
- MatrixParam['email']: (string)
- MatrixParam['accoundId']: (integer - minimum: 0)
- MatrixParam['variant']: (string)
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
A collection of workspace object links.
Returns the Workspaces defined for the Account.
get /accounts/{accountId}/workspaces
Returns the Workspaces defined for the Account.
URI Parameters
-
accountId: required (integer)
Account ID
Query Parameters
- MatrixParam['name']: (string)
- MatrixParam['description']: (string)
- MatrixParam['enabled']: (boolean)
- MatrixParam['deleted']: (boolean - default: false)
- MatrixParam['account']: (string)
-
MatrixParam['exactNameMatch']: (string)
Pass it true if you want to search an Object using the exact name.
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
- MatrixParam['userId']: (integer - minimum: 0)
- MatrixParam['variant']: (string)
-
MatrixParam['skipCount']: (boolean)
This parameter skips the count query execution when fetching a record.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
A collection of subAccount object links.
Returns the Sub-Accounts defined for the Account.
get /accounts/{accountId}/subAccounts
Returns the Sub-Accounts defined for the Account.
URI Parameters
-
accountId: required (integer)
Account ID
Query Parameters
- MatrixParam['name']: (string)
- MatrixParam['description']: (string)
- MatrixParam['enabled']: (boolean)
- MatrixParam['deleted']: (boolean - default: false)
- MatrixParam['account']: (string)
-
MatrixParam['exactNameMatch']: (string)
Pass it true if you want to search an Object using the exact name.
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
- MatrixParam['variant']: (string)
- MatrixParam['accountId']: (integer - minimum: 0)
-
MatrixParam['parenAccountId']: (integer - minimum: 0)
If no parentAccountId is provided, the accountId will used instead (if it is provided).
-
MatrixParam['skipCount']: (boolean)
This parameter skips the count query execution when fetching a record.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
A collection of property object links.
Returns a list of Properties defined for a specific Account. This is only available in 5.1.1 onwards.
Creates a new Account/System Property
Updates the properties for the Account.
Deletes the properties for the Account.
get /accounts/{accountId}/properties
Returns a list of Properties defined for a specific Account. This is only available in 5.1.1 onwards.
URI Parameters
-
accountId: required (integer)
Account ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /accounts/{accountId}/properties
Creates a new Account/System Property
URI Parameters
-
accountId: required (integer)
Account ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"key": {
"type": "string",
"required": true
},
"value": {
"type": "string",
"required": true
}
}
}
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"href": {
"type": "string",
"required": false
},
"key": {
"type": "string",
"required": false
},
"value": {
"type": "string",
"required": false
},
"account": {
"type": "object",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"name": {
"type": "string",
"required": false
},
"type": {
"type": "string",
"required": false
},
"variant": {
"type": "string",
"required": false
},
"enabled": {
"type": "boolean",
"required": false
},
"deleted": {
"type": "boolean",
"required": false
},
"href": {
"type": "string",
"required": false
},
"owner": {
"type": "string",
"required": false
}
}
}
}
}
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
put /accounts/{accountId}/properties
Updates the properties for the Account.
URI Parameters
-
accountId: required (integer)
Account ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"key": {
"type": "strng",
"required": false
},
"value": {
"type": "string",
"required": false
}
}
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
delete /accounts/{accountId}/properties
Deletes the properties for the Account.
URI Parameters
-
accountId: required (integer)
Account ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
A collection of role object links.
Returns the Roles defined for the Account.
get /accounts/{accountId}/roles
Returns the Roles defined for the Account.
URI Parameters
-
accountId: required (integer)
Account ID
Query Parameters
- MatrixParam['name']: (string)
- MatrixParam['description']: (string)
- MatrixParam['enabled']: (boolean)
- MatrixParam['deleted']: (boolean - default: false)
- MatrixParam['account']: (string)
-
MatrixParam['exactNameMatch']: (string)
Pass it true if you want to search an Object using the exact name.
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns the Account Workspace defined for the Account.
get /accounts/{accountId}/accountWorkspace
Returns the Account Workspace defined for the Account.
URI Parameters
-
accountId: required (integer)
Account ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns a list of Variants a specific Account.
get /accounts/{accountId}/variants
Returns a list of Variants a specific Account.
URI Parameters
-
accountId: required (integer)
Account ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns a list of external IDs associated with an Account.
Creates new external ID.
get /accounts/{accountId}/externalIds
Returns a list of external IDs associated with an Account.
URI Parameters
-
accountId: required (integer)
Account ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
},
"href": {
"type": "string"
}
},
"required": [
"key",
"value",
"href"
]
}
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /accounts/{accountId}/externalIds
Creates new external ID.
URI Parameters
-
accountId: required (integer)
Account ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"key",
"value"
]
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns the details for a specific external ID.
Updates the Account/System Property
Deletes a specific external ID.
get /accounts/{accountId}/externalIds/{key}
Returns the details for a specific external ID.
URI Parameters
-
accountId: required (integer)
Account ID
- key: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
put /accounts/{accountId}/externalIds/{key}
Updates the Account/System Property
URI Parameters
-
accountId: required (integer)
Account ID
- key: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"properties": {
"value": {
"type": "string"
}
},
"required": [
"value"
]
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
delete /accounts/{accountId}/externalIds/{key}
Deletes a specific external ID.
URI Parameters
-
accountId: required (integer)
Account ID
- key: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Account Properties
Used for performing operations on Account/System Properties
Returns a list of Account/System Properties
Returns a list of Account/System Properties
get /accountProperties
Returns a list of Account/System Properties
Query Parameters
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['externalId']: (string)
Search for an object via its endpoint (e.g. assets, workflows) and specify the external ID key and value, e.g. For example /api/assets;externalId=key:value
-
MatrixParam['skipCount']: (boolean)
This parameter skips the count query execution when fetching a record.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /accountProperties
Returns a list of Account/System Properties
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"key": {
"type": "string",
"required": true
},
"value": {
"type": "string",
"required": true
}
}
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Performs operations on a single Account/System Property
Returns the Account/System Property
Updates the Account/System Property
Deletes the Account/System Property
get /accountProperties/{accountPropertyId}
Returns the Account/System Property
URI Parameters
-
accountPropertyId: required (integer)
Account Property ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
put /accountProperties/{accountPropertyId}
Updates the Account/System Property
URI Parameters
-
accountPropertyId: required (integer)
Account Property ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"key": {
"type": "string",
"required": true
},
"value": {
"type": "string",
"required": true
}
}
}
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"href": {
"type": "string",
"required": false
},
"key": {
"type": "string",
"required": false
},
"value": {
"type": "string",
"required": false
},
"account": {
"type": "object",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"name": {
"type": "string",
"required": false
},
"type": {
"type": "string",
"required": false
},
"variant": {
"type": "string",
"required": false
},
"enabled": {
"type": "boolean",
"required": false
},
"deleted": {
"type": "boolean",
"required": false
},
"href": {
"type": "string",
"required": false
},
"owner": {
"type": "string",
"required": false
}
}
}
}
}
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
delete /accountProperties/{accountPropertyId}
Deletes the Account/System Property
URI Parameters
-
accountPropertyId: required (integer)
Account Property ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Copies an existing Workflow Definition.
post /accountProperties/{accountPropertyId}/copy
Copies an existing Workflow Definition.
URI Parameters
-
accountPropertyId: required (integer)
Account Property ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"name": {
"type": "string",
"required": true
},
"description": {
"type": "string",
"required": false
}
}
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns a list of external IDs associated with an Account.
Creates new external ID.
get /accountProperties/{accountPropertyId}/externalIds
Returns a list of external IDs associated with an Account.
URI Parameters
-
accountPropertyId: required (integer)
Account Property ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
},
"href": {
"type": "string"
}
},
"required": [
"key",
"value",
"href"
]
}
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /accountProperties/{accountPropertyId}/externalIds
Creates new external ID.
URI Parameters
-
accountPropertyId: required (integer)
Account Property ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"key",
"value"
]
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns the details for a specific external ID.
Updates the Account/System Property
Deletes a specific external ID.
get /accountProperties/{accountPropertyId}/externalIds/{key}
Returns the details for a specific external ID.
URI Parameters
-
accountPropertyId: required (integer)
Account Property ID
- key: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
put /accountProperties/{accountPropertyId}/externalIds/{key}
Updates the Account/System Property
URI Parameters
-
accountPropertyId: required (integer)
Account Property ID
- key: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"properties": {
"value": {
"type": "string"
}
},
"required": [
"value"
]
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
delete /accountProperties/{accountPropertyId}/externalIds/{key}
Deletes a specific external ID.
URI Parameters
-
accountPropertyId: required (integer)
Account Property ID
- key: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Account Workspace
Returns the corresponding Workspace for the account that is currently in use.
get /accountWorkspace
Returns the corresponding Workspace for the account that is currently in use.
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['externalId']: (string)
Search for an object via its endpoint (e.g. assets, workflows) and specify the external ID key and value, e.g. For example /api/assets;externalId=key:value
-
MatrixParam['skipCount']: (boolean)
This parameter skips the count query execution when fetching a record.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Copies an existing Workflow Definition.
post /accountWorkspace/copy
Copies an existing Workflow Definition.
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"name": {
"type": "string",
"required": true
},
"description": {
"type": "string",
"required": false
}
}
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns a list of external IDs associated with an Account.
Creates new external ID.
get /accountWorkspace/externalIds
Returns a list of external IDs associated with an Account.
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
},
"href": {
"type": "string"
}
},
"required": [
"key",
"value",
"href"
]
}
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /accountWorkspace/externalIds
Creates new external ID.
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"key",
"value"
]
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns the details for a specific external ID.
Updates the Account/System Property
Deletes a specific external ID.
get /accountWorkspace/externalIds/{key}
Returns the details for a specific external ID.
URI Parameters
- key: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
put /accountWorkspace/externalIds/{key}
Updates the Account/System Property
URI Parameters
- key: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"properties": {
"value": {
"type": "string"
}
},
"required": [
"value"
]
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
delete /accountWorkspace/externalIds/{key}
Deletes a specific external ID.
URI Parameters
- key: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Actions
Perform operations on Actions
Returns a list of Actions Listing is based on supplied filters.
Create a new action for a given action type and plugin.
get /actions
Returns a list of Actions Listing is based on supplied filters.
Query Parameters
- MatrixParam['name']: (string)
- MatrixParam['description']: (string)
- MatrixParam['enabled']: (boolean)
- MatrixParam['deleted']: (boolean - default: false)
- MatrixParam['account']: (string)
-
MatrixParam['exactNameMatch']: (string)
Pass it true if you want to search an Object using the exact name.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['type']: (string)
The action type
-
MatrixParam['externalId']: (string)
Search for an object via its endpoint (e.g. assets, workflows) and specify the external ID key and value, e.g. For example /api/assets;externalId=key:value
-
MatrixParam['skipCount']: (boolean)
This parameter skips the count query execution when fetching a record.
-
MatrixParam['context']: (boolean)
This parameter returns a list of actions associated with a specific asset type. Example- api/actions?context=type
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /actions
Create a new action for a given action type and plugin.
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"name": {
"type": "string",
"required": true
},
"description": {
"type": "string",
"required": false
},
"type": {
"type": "string",
"required": true
},
"pluginClass": {
"type": "string",
"required": true
},
"runRuleExpression": {
"type": "string",
"required": false
},
"timeout": {
"type": "integer",
"required": false
},
"visibilityIds": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 0,
"uniqueItems": true,
"required": true
},
"undoAction": {
"type": "integer",
"required": false
},
"redoAction": {
"type": "integer",
"required": false
}
}
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"name": {
"type": "string",
"required": false
},
"type": {
"type": "string",
"required": false
},
"variant": {
"type": "string",
"required": false
},
"enabled": {
"type": "boolean",
"required": false
},
"deleted": {
"type": "boolean",
"required": false
},
"href": {
"type": "string",
"required": false
},
"owner": {
"type": "string",
"required": false
}
}
}
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Perform operations on a specific Action
Returns details of the Action
Update the details of the Action
Delete the Action
get /actions/{actionId}
Returns details of the Action
URI Parameters
-
actionId: required (integer)
Action ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
put /actions/{actionId}
Update the details of the Action
URI Parameters
-
actionId: required (integer)
Action ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"name": {
"type": "string",
"required": false
},
"description": {
"type": "string",
"required": false
},
"runRuleExpression": {
"type": "string",
"required": false
},
"timeout": {
"type": "integer",
"required": false
},
"visibilityIds": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 0,
"uniqueItems": true,
"required": false
},
"undoAction": {
"type": "integer",
"required": false
},
"redoAction": {
"type": "integer",
"required": false
}
}
}
HTTP status code 200
Returns the updated action.
Body
Type: application/vnd.nativ.mio.v1+json
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
delete /actions/{actionId}
Delete the Action
URI Parameters
-
actionId: required (integer)
Action ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns a list of actions that can be performed.
Performs an action. Possible action types are - enable, disable, start, stop, delete, retry, cancel, schedule, approve, unapprove, destroy, destroy.
get /actions/{actionId}/actions
Returns a list of actions that can be performed.
URI Parameters
-
actionId: required (integer)
Action ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /actions/{actionId}/actions
Performs an action. Possible action types are - enable, disable, start, stop, delete, retry, cancel, schedule, approve, unapprove, destroy, destroy.
URI Parameters
-
actionId: required (integer)
Action ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"action": {
"type": "string",
"required": true
}
}
}
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"name": {
"type": "string",
"required": false
},
"type": {
"type": "string",
"required": false
},
"variant": {
"type": "string",
"required": false
},
"enabled": {
"type": "boolean",
"required": false
},
"deleted": {
"type": "boolean",
"required": false
},
"href": {
"type": "string",
"required": false
},
"owner": {
"type": "string",
"required": false
}
}
}
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
A collection of comment.
Returns a list of Comments.
Adds a new Comment.
get /actions/{actionId}/comments
Returns a list of Comments.
URI Parameters
-
actionId: required (integer)
Action ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /actions/{actionId}/comments
Adds a new Comment.
URI Parameters
-
actionId: required (integer)
Action ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"message": {
"type": "string",
"required": true
}
}
}
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"message": {
"type": "string",
"required": false
},
"date": {
"type": "date",
"required": false
},
"user": {
"type": "object",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"name": {
"type": "string",
"required": false
},
"fullName": {
"type": "string",
"required": false
},
"enabled": {
"type": "boolean",
"required": false
},
"deleted": {
"type": "boolean",
"required": false
},
"href": {
"type": "string",
"required": false
},
"email": {
"type": "string",
"required": false
},
"variant": {
"type": "string",
"required": false
}
}
},
"parentObject": {
"type": "object",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"name": {
"type": "string",
"required": false
},
"type": {
"type": "string",
"required": false
},
"variant": {
"type": "string",
"required": false
},
"enabled": {
"type": "boolean",
"required": false
},
"deleted": {
"type": "boolean",
"required": false
},
"href": {
"type": "string",
"required": false
},
"owner": {
"type": "string",
"required": false
}
}
}
}
}
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Performs operations on a single Comment.
Returns a Comment.
get /actions/{actionId}/comments/{commentId}
Returns a Comment.
URI Parameters
-
actionId: required (integer)
Action ID
-
commentId: required (integer)
Comment ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Copies an existing Action.
post /actions/{actionId}/copy
Copies an existing Action.
URI Parameters
-
actionId: required (integer)
Action ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"name": {
"type": "string",
"required": true
},
"description": {
"type": "string",
"required": false
}
}
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
A collection of follower.
Returns a list of users that are following this object.
get /actions/{actionId}/followers
Returns a list of users that are following this object.
URI Parameters
-
actionId: required (integer)
Action ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
A collection of attachment.
Returns a list of attachments.
Creates a new attachment.
get /actions/{actionId}/attachments
Returns a list of attachments.
URI Parameters
-
actionId: required (integer)
Action ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /actions/{actionId}/attachments
Creates a new attachment.
URI Parameters
-
actionId: required (integer)
Action ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"fileName": {
"type": "string",
"required": true
},
"mimeType": {
"type": "string",
"required": false
},
"description": {
"type": "string",
"required": false
},
"fileContent": {
"type": "string",
"required": true
}
}
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns the details for a specific attachment.
Updates the comment for an existing attachment.
Deletes an existing attachment.
get /actions/{actionId}/attachments/{attachmentId}
Returns the details for a specific attachment.
URI Parameters
-
actionId: required (integer)
Action ID
- attachmentId: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
put /actions/{actionId}/attachments/{attachmentId}
Updates the comment for an existing attachment.
URI Parameters
-
actionId: required (integer)
Action ID
- attachmentId: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"description": {
"type": "string",
"required": true
}
}
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
delete /actions/{actionId}/attachments/{attachmentId}
Deletes an existing attachment.
URI Parameters
-
actionId: required (integer)
Action ID
- attachmentId: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
A collection of history.
Returns a list of events.
get /actions/{actionId}/history
Returns a list of events.
URI Parameters
-
actionId: required (integer)
Action ID
Query Parameters
- MatrixParam['objectId']: (integer - minimum: 0)
-
MatrixParam['objectType']: (string)
One or more objectTypes can be provided. This parameter can't be used when an objectId is already provided.
-
MatrixParam['accountId']: (string)
One or more accountId can be provided.
-
MatrixParam['severity']: (one of Info, Error, Warn)
One or more severities can be provided.
-
MatrixParam['eventType']: (string)
One or more eventTypes can be provided.
- MatrixParam['ownerId']: (integer - minimum: 0)
-
MatrixParam['from']: (date)
Last modified to date. Supported date formats are:
- dd MMM yyyy hh:mm:ss Z
- dd MMM yyyy hh:mm:ss
- dd MMM yyyy
- now (translated as current date and time)
-
MatrixParam['to']: (date)
Last modified to date. Supported date formats are:
- dd MMM yyyy hh:mm:ss Z
- dd MMM yyyy hh:mm:ss
- dd MMM yyyy
- now (translated as current date and time)
-
MatrixParam['attribute']: (string)
One or more attributes can be provided.
-
MatrixParam['value']: (string)
One or more values can be provided.
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns the metadata instance of the action including a href to the metadata definition.
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 /actions/{actionId}/configuration
Returns the metadata instance of the action including a href to the metadata definition.
URI Parameters
-
actionId: required (integer)
Action ID
Headers
-
Accept: (string)
Method will return JSON by default, but will return XML if set to application/xml.
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
put /actions/{actionId}/configuration
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.
URI Parameters
-
actionId: required (integer)
Action ID
Headers
-
Accept: (string)
Method will return JSON by default, but will return XML if set to application/xml.
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+xml
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+xml
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns file instances associated with an action (could have no files, one or several instances)
get /actions/{actionId}/configuration/files
Returns file instances associated with an action (could have no files, one or several instances)
URI Parameters
-
actionId: required (integer)
Action ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns a list of external IDs associated with an Account.
Creates new external ID.
get /actions/{actionId}/externalIds
Returns a list of external IDs associated with an Account.
URI Parameters
-
actionId: required (integer)
Action ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
},
"href": {
"type": "string"
}
},
"required": [
"key",
"value",
"href"
]
}
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /actions/{actionId}/externalIds
Creates new external ID.
URI Parameters
-
actionId: required (integer)
Action ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"key",
"value"
]
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns the details for a specific external ID.
Updates the Account/System Property
Deletes a specific external ID.
get /actions/{actionId}/externalIds/{key}
Returns the details for a specific external ID.
URI Parameters
-
actionId: required (integer)
Action ID
- key: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
put /actions/{actionId}/externalIds/{key}
Updates the Account/System Property
URI Parameters
-
actionId: required (integer)
Action ID
- key: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"properties": {
"value": {
"type": "string"
}
},
"required": [
"value"
]
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
delete /actions/{actionId}/externalIds/{key}
Deletes a specific external ID.
URI Parameters
-
actionId: required (integer)
Action ID
- key: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns a list of variables associated with a specific action.
get /actions/{actionId}/variables
Returns a list of variables associated with a specific action.
URI Parameters
-
actionId: required (integer)
Action ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns the details for a specific variable that is associated with a particular action.
get /actions/{actionId}/variables/{variableId}
Returns the details for a specific variable that is associated with a particular action.
URI Parameters
-
actionId: required (integer)
Action ID
- variableId: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns a list of options that are available for the specific object variable.
get /actions/{actionId}/variables/{variableId}/values
Returns a list of options that are available for the specific object variable.
URI Parameters
-
actionId: required (integer)
Action ID
- variableId: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Action Types
This resource lists all the action types that are associated with a specific asset.
Returns a list of all the action types that are associated with a specific asset.
get /actionTypes
Returns a list of all the action types that are associated with a specific asset.
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['assetIds']: (boolean)
This parameter enables you to view the action types that are associated with one or more specific assets. For example api/actionTypes;assetIds=
;assetIds= -
MatrixParam['context']: (string)
This query parameter enables you to retrieve a list of objects with references. For example if you wanted to retrieve a list of task definitions with references, you would do the following /api/actions?context=reference.
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"id": {
"type": "string",
"required": true
},
"mimeType": {
"name": "string",
"required": true
},
"displayName": {
"type": "string",
"required": true
},
"href": {
"type": "string",
"required": true
},
"category": {
"type": "string",
"required": true
},
"supportsWorkflow": {
"type": "boolean",
"required": true
},
"supportsManualLaunch": {
"type": "boolean",
"required": true
},
"supportsGroupExecution": {
"type": "boolean",
"required": true
},
"supportsGroupMemberExecution": {
"type": "boolean",
"required": true
},
"iconName": {
"type": "string",
"required": true
},
"runRuleExpression": {
"type": "string",
"required": true
},
"supportsRedo": {
"type": "boolean",
"required": true
},
"supportsUndo": {
"type": "string",
"required": true
}
}
}
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Assets
This resource is used for managing Assets
Returns a list of Assets Listing is based on supplied filters
Create new placeholder asset.
get /assets
Returns a list of Assets Listing is based on supplied filters
Query Parameters
-
MatrixParam['searchText']: (string)
Search for occurrences of searchText in Name, Description, ID, Attachments, Comments and Metadata fields.
-
MatrixParam['owner']: (string - minLength: 1)
Owner user name
-
MatrixParam['variant']: (string - minLength: 1)
List of Variants
-
MatrixParam['excludedVariants']: (string - minLength: 1)
List of Variants
-
MatrixParam['createdFrom']: (date)
Created from date. Supported date formats are:
- dd MMM yyyy hh:mm:ss Z
- dd MMM yyyy hh:mm:ss
- dd MMM yyyy
- now (translated as current date and time)
-
MatrixParam['createdTo']: (date)
Created to date. Supported date formats are:
- dd MMM yyyy hh:mm:ss Z
- dd MMM yyyy hh:mm:ss
- dd MMM yyyy
- now (translated as current date and time)
-
MatrixParam['lastModifiedFrom']: (date)
Last modified from date. Supported date formats are:
- dd MMM yyyy hh:mm:ss Z
- dd MMM yyyy hh:mm:ss
- dd MMM yyyy
- now (translated as current date and time)
-
MatrixParam['lastModifiedTo']: (date)
Last modified to date. Supported date formats are:
- dd MMM yyyy hh:mm:ss Z
- dd MMM yyyy hh:mm:ss
- dd MMM yyyy
- now (translated as current date and time)
-
MatrixParam['enabled']: (one of true, false, all)
Enabled flag
-
MatrixParam['deleted']: (one of true, false, all)
Deleted flag
-
MatrixParam['approved']: (one of true, false, all)
Approved flag
-
MatrixParam['accountId']: (number)
You can list multiple Account Ids separated by a colon, e.g. aId=1; aId=2;
-
MatrixParam['workspaceId']: (number)
You can list multiple Workspace Ids separated by a colon, e.g. wsId=1; wsId=2;
-
MatrixParam['metadataDefinitionId']: (number)
Metadata Definition Id
-
MatrixParam['includeNoVariant']: (boolean)
Includes Objects that do not have a Variant.
- MatrixParam['includeData']: (boolean)
-
MatrixParam['parentId’]: (number)
Returns a list of parent Ids. Please note that this matrix parameter can only be used if the parent is a user defined object.
-
MatrixParam['includeVariables']: (boolean)
Whether or not to include the Variables of Workflows or Jobs in the response.
- MatrixParam['ancestorId']: (number)
- MatrixParam['level']: (number)
- MatrixParam['objectType']: (string)
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (boolean)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['includeMetadata']: (boolean)
Include metadata in the response
-
MatrixParam['assetType']: (one of Group, File)
Type of Assets
-
MatrixParam['fileType']: (string - default: all types - minLength: 1)
One or more file types of Assets. An Asset Type must be specified before specifying a file type. Asset types are as follows- 'media', 'text', 'subtitle", "image".
-
MatrixParam['id']: (string)
Filtering by multiple Ids.Example- /api/assets;id=1234;id=2345;id=3456.
-
MatrixParam['status']: (one of ARCHIVED, DELETED, PUBLISHED, PURGED)
Status of Assets
-
MatrixParam['creationContext']: (one of ingest, proxy, copy, transcode, new, transform)
The creation context of Assets.
- MatrixParam['referenceName']: (string)
-
MatrixParam['managed']: (string)
Whether the Assets are managed or not
-
MatrixParam['folderResourceId']: (integer - minimum: 0)
ID of the folder resource
-
MatrixParam['originalFileName']: (string)
The original filename
-
MatrixParam['technicalType']: (one of Media, Image)
Different criteria can be applied to Assets depending on which technical type has been chosen.
-
MatrixParam['format']: (string)
Only applies to Media
-
MatrixParam['streamCount']: (integer)
Only applies to Media
-
MatrixParam['audioStreamCount']: (integer)
Only applies to Media
-
MatrixParam['videoStreamCount']: (string)
Only applies to Media
-
MatrixParam['internalMetadata']: (string)
Only applies to Media
-
MatrixParam['bitRate']: (integer)
Only applies to Media
-
MatrixParam['bitRateUnits']: (string - default: bit/s)
Only applies to Media
-
MatrixParam['fileSize']: (integer)
Only applies to Media
-
MatrixParam['fileSizeUnits']: (string - default: B)
Only applies to Media
-
MatrixParam['duration']: (integer)
Only applies to Media
-
MatrixParam['durationUnits']: (string - default: µs)
Only applies to Media
-
MatrixParam['keyframeDescription']: (string)
Search for a specific keyframe description. Only applies to Media.
-
MatrixParam['videoCodec']: (string)
Only applies to Media
-
MatrixParam['frameRate']: (string)
Only applies to Media
-
MatrixParam['pixelAspectRatio']: (string)
Only applies to Media
-
MatrixParam['frameWidth']: (integer)
Only applies to Media
-
MatrixParam['frameHeight']: (integer)
Only applies to Media
-
MatrixParam['interlaceFormat']: (string)
Only applies to Media
-
MatrixParam['pixelFormat']: (string)
Only applies to Media
-
MatrixParam['standard']: (string)
Only applies to Media
-
MatrixParam['videoLanguage']: (string)
Only applies to Media
-
MatrixParam['videoBitRate']: (integer)
Only applies to Media
-
MatrixParam['videoBitRateUnits']: (string - default: bit/s)
Only applies to Media
-
MatrixParam['audioCodec']: (string)
Only applies to Media
-
MatrixParam['sampleRate']: (string)
Only applies to Media
-
MatrixParam['channels']: (integer)
Only applies to Media
-
MatrixParam['bitsPerSample']: (integer)
Only applies to Media
-
MatrixParam['audioLanguage']: (string)
Only applies to Media
-
MatrixParam['audioBitRate']: (integer)
Only applies to Media
-
MatrixParam['audioBitRateUnits']: (string - default: bit/s)
Only applies to Media
-
MatrixParam['imageFormat']: (string)
Only applies to Image
-
MatrixParam['width']: (integer)
Only applies to Image
-
MatrixParam['height']: (integer)
Only applies to Image
-
MatrixParam['widthResolution']: (string)
Only applies to Image
-
MatrixParam['heightResolution']: (string)
Only applies to Image
-
MatrixParam['colorMode']: (string)
Only applies to Image
-
MatrixParam['bitsPerPixel']: (integer)
Only applies to Image
-
MatrixParam['exactNameMatch']: (string)
Pass it true if you want to search asset with exact name
-
MatrixParam['externalId']: (string)
Search for an object via its endpoint (e.g. assets, workflows) and specify the external ID key and value, e.g. For example /api/assets;externalId=key:value
-
MatrixParam['signedURL']: (string)
Returns a link to an asset stored in s3. This link enables you to download a file stored in s3 without needing to log in.
-
MatrixParam['skipCount']: (boolean)
This parameter skips the count query execution when fetching a record.
-
MatrixParam['publishedFrom']: (boolean)
This parameter enables users to search assets published from a certain date.
-
MatrixParam['publishedTo']: (boolean)
This parameter enables users to search assets published up to a certain date.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /assets
Create new placeholder asset.
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"name": {
"type": "string",
"required": true
},
"description": {
"type": "string",
"required": false
},
"type": {
"type": "string",
"required": true
},
"variant": {
"type": "string",
"required": false
},
"metadataDefinitionId": {
"type": "integer",
"required": false
},
"accountId": {
"type": "integer",
"required": false
},
"workspaceId": {
"type": "integer",
"required": false
}
}
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"name": {
"type": "string",
"required": false
},
"type": {
"type": "string",
"required": false
},
"variant": {
"type": "string",
"required": false
},
"enabled": {
"type": "boolean",
"required": false
},
"deleted": {
"type": "boolean",
"required": false
},
"href": {
"type": "string",
"required": false
},
"owner": {
"type": "string",
"required": false
}
}
}
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Perform operations on a specific Asset
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
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 /assets/{assetId}
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
URI Parameters
-
assetId: required (integer)
Asset ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['includeMetadata']: (boolean)
Include metadata in the response
-
MatrixParam['skipCount']: (boolean)
This parameter skips the count query execution when fetching a record.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
put /assets/{assetId}
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.
URI Parameters
-
assetId: required (integer)
Asset ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"name": {
"type": "string",
"required": false
},
"description": {
"type": "string",
"required": false
},
"referenceName": {
"type": "string",
"required": false
},
"assetOrigin": {
"type": "string",
"required": false
},
"variant": {
"type": "string",
"required": false
},
"metadataDefinitionId": {
"type": "integer",
"required": false
},
"referenceName": {
"type": "string",
"required": false
},
"fileDetails": {
"type": "array",
"required": false
},
"assetContext": {
"type": "array",
"required": false
},
"type": {
"type": "string",
"required": false
},
"formatContext": {
"type": "array",
"required": false
},
"format": {
"type": "string",
"required": false
},
"duration": {
"type": "integer",
"required": false
},
"bitRate": {
"type": "integer",
"required": false
},
"vfsLocation": {
"type": "array",
"required": false
},
"protocol": {
"type": "string",
"required": false
},
"path": {
"type": "string",
"required": false
},
"mimeType": {
"type": "string",
"required": false
}
}
}
HTTP status code 200
Returns an updated Asset.
Body
Type: application/vnd.nativ.mio.v1+json
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns a list of existing annotations made against a timeline in MAM.
Creates an annotation on a timeline in MAM. When specifying an originatorContext you can enter MioAssetReview, QCReport, or leave the field empty.
get /assets/{assetId}/accounts
Returns a list of existing annotations made against a timeline in MAM.
URI Parameters
-
assetId: required (integer)
Asset ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /assets/{assetId}/accounts
Creates an annotation on a timeline in MAM. When specifying an originatorContext you can enter MioAssetReview, QCReport, or leave the field empty.
URI Parameters
-
assetId: required (integer)
Asset ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns a list of existing annotations made against a timeline in MAM.
Creates an annotation on a timeline in MAM. When specifying an originatorContext you can enter MioAssetReview, QCReport, or leave the field empty.
get /assets/{assetId}/annotations
Returns a list of existing annotations made against a timeline in MAM.
URI Parameters
-
assetId: required (integer)
Asset ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /assets/{assetId}/annotations
Creates an annotation on a timeline in MAM. When specifying an originatorContext you can enter MioAssetReview, QCReport, or leave the field empty.
URI Parameters
-
assetId: required (integer)
Asset ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"properties": {
"timelineComment": {
"type": "object",
"properties": {
"comment": {
"type": "string"
},
"timestampIn": {
"type": "integer"
},
"timestampOut": {
"type": "integer"
},
"originatorContext": {
"type": "string"
}
}
}
}
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Performs operations on a specific Annotation.
Adds a new Comment.
Deletes an existing annotation a ne.
put /assets/{assetId}/annotations/{annotationId}
Adds a new Comment.
URI Parameters
-
assetId: required (integer)
Asset ID
- annotationId: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"comment": {
"type": "string",
"required": true
},
"timestampIn": {
"type": "integer"
},
"timestampOut": {
"type": "integer"
}
}
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
delete /assets/{assetId}/annotations/{annotationId}
Deletes an existing annotation a ne.
URI Parameters
-
assetId: required (integer)
Asset ID
- annotationId: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
A collection of comment.
Returns a list of Comments.
Adds a new Comment.
get /assets/{assetId}/comments
Returns a list of Comments.
URI Parameters
-
assetId: required (integer)
Asset ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /assets/{assetId}/comments
Adds a new Comment.
URI Parameters
-
assetId: required (integer)
Asset ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"message": {
"type": "string",
"required": true
}
}
}
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"message": {
"type": "string",
"required": false
},
"date": {
"type": "date",
"required": false
},
"user": {
"type": "object",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"name": {
"type": "string",
"required": false
},
"fullName": {
"type": "string",
"required": false
},
"enabled": {
"type": "boolean",
"required": false
},
"deleted": {
"type": "boolean",
"required": false
},
"href": {
"type": "string",
"required": false
},
"email": {
"type": "string",
"required": false
},
"variant": {
"type": "string",
"required": false
}
}
},
"parentObject": {
"type": "object",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"name": {
"type": "string",
"required": false
},
"type": {
"type": "string",
"required": false
},
"variant": {
"type": "string",
"required": false
},
"enabled": {
"type": "boolean",
"required": false
},
"deleted": {
"type": "boolean",
"required": false
},
"href": {
"type": "string",
"required": false
},
"owner": {
"type": "string",
"required": false
}
}
}
}
}
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Performs operations on a single Comment.
Returns a Comment.
get /assets/{assetId}/comments/{commentId}
Returns a Comment.
URI Parameters
-
assetId: required (integer)
Asset ID
-
commentId: required (integer)
Comment ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Copies an existing Asset.
post /assets/{assetId}/copy
Copies an existing Asset.
URI Parameters
-
assetId: required (integer)
Asset ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"name": {
"type": "string",
"required": true
},
"description": {
"type": "string",
"required": false
}
}
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
A collection of follower.
Returns a list of users that are following this object.
get /assets/{assetId}/followers
Returns a list of users that are following this object.
URI Parameters
-
assetId: required (integer)
Asset ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
A collection of attachment.
Returns a list of attachments.
Creates a new attachment.
get /assets/{assetId}/attachments
Returns a list of attachments.
URI Parameters
-
assetId: required (integer)
Asset ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /assets/{assetId}/attachments
Creates a new attachment.
URI Parameters
-
assetId: required (integer)
Asset ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"fileName": {
"type": "string",
"required": true
},
"mimeType": {
"type": "string",
"required": false
},
"description": {
"type": "string",
"required": false
},
"fileContent": {
"type": "string",
"required": true
}
}
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns the details for a specific attachment.
Updates the comment for an existing attachment.
Deletes an existing attachment.
get /assets/{assetId}/attachments/{attachmentId}
Returns the details for a specific attachment.
URI Parameters
-
assetId: required (integer)
Asset ID
- attachmentId: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
put /assets/{assetId}/attachments/{attachmentId}
Updates the comment for an existing attachment.
URI Parameters
-
assetId: required (integer)
Asset ID
- attachmentId: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"description": {
"type": "string",
"required": true
}
}
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
delete /assets/{assetId}/attachments/{attachmentId}
Deletes an existing attachment.
URI Parameters
-
assetId: required (integer)
Asset ID
- attachmentId: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns all the assets that are members of given group asset.
get /assets/{assetId}/hierarchy
Returns all the assets that are members of given group asset.
URI Parameters
-
assetId: required (integer)
Asset ID
Query Parameters
- MatrixParam['name']: (string)
- MatrixParam['description']: (string)
- MatrixParam['enabled']: (boolean)
- MatrixParam['deleted']: (boolean - default: false)
- MatrixParam['account']: (string)
-
MatrixParam['exactNameMatch']: (string)
Pass it true if you want to search an Object using the exact name.
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['metadataDefinitionId']: (string)
How many assets in the hierarchy that are associated with this metadata definition ID.
-
MatrixParam['metadata']: (string)
How many assets in the hierarchy have this metadata field with this specific value. Example - metadata=string1:123;
-
MatrixParam['variant']: (string)
How many assets in the hierarchy that are associated with this variant name. Example - variant={VariantName}
-
MatrixParam['technicalType']: (string)
How many assets in the hierarchy have a technicalType of either image or media. Example - technicalType=Media; / technicalType=Image;
-
MatrixParam['assetOrigin']: (string)
How many assets in the hierarchy have an assetOrigin of Ingest, Import or Proxy. Example - assetOrigin=Ingest / assetOrigin=Import / assetOrigin=Proxy
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"assetHierarchies": [
{
"id": 767,
"href": "https://accountb.qa1.ooflex.net/api/assets/152214/members/767",
"asset": {
"id": 135140,
"uuid": "801c45ca-ab7b-4098-bd00-1eb02e848c2d",
"name": "F FRAMETEST01 HD.mp4",
"displayName": "F FRAMETEST01 HD.mp4",
"type": "Media Asset",
"href": "https://accountb.qa1.ooflex.net/api/assets/135140",
"variant": {
"id": 18382,
"name": "MV1",
"href": "https://accountb.qa1.ooflex.net/api/variants/18382"
},
"assetOrigin": "Import",
"referenceName": "",
"accountId": 10329,
"workspaceId": 10328,
"masterKeyframeId": 126555,
"workspace": {
"id": 10328,
"name": "accountb",
"displayName": "accountb",
"accountId": 10329,
"href": "https://accountb.qa1.ooflex.net/api/workspaces/10328"
}
},
"name": ""
},
{
"id": 733,
"href": "https://accountb.qa1.ooflex.net/api/assets/137728/members/733",
"asset": {
"id": 135140,
"uuid": "801c45ca-ab7b-4098-bd00-1eb02e848c2d",
"name": "F FRAMETEST01 HD.mp4",
"displayName": "F FRAMETEST01 HD.mp4",
"type": "Media Asset",
"href": "https://accountb.qa1.ooflex.net/api/assets/135140",
"variant": {
"id": 18382,
"name": "MV1",
"href": "https://accountb.qa1.ooflex.net/api/variants/18382"
},
"assetOrigin": "Import",
"referenceName": "",
"accountId": 10329,
"workspaceId": 10328,
"masterKeyframeId": 126555,
"workspace": {
"id": 10328,
"name": "accountb",
"displayName": "accountb",
"accountId": 10329,
"href": "https://accountb.qa1.ooflex.net/api/workspaces/10328"
}
},
"name": ""
}
],
"totalCount": 2,
"offset": 0,
"limit": 100
}
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
A collection of history.
Returns a list of events.
get /assets/{assetId}/history
Returns a list of events.
URI Parameters
-
assetId: required (integer)
Asset ID
Query Parameters
- MatrixParam['objectId']: (integer - minimum: 0)
-
MatrixParam['objectType']: (string)
One or more objectTypes can be provided. This parameter can't be used when an objectId is already provided.
-
MatrixParam['accountId']: (string)
One or more accountId can be provided.
-
MatrixParam['severity']: (one of Info, Error, Warn)
One or more severities can be provided.
-
MatrixParam['eventType']: (string)
One or more eventTypes can be provided.
- MatrixParam['ownerId']: (integer - minimum: 0)
-
MatrixParam['from']: (date)
Last modified to date. Supported date formats are:
- dd MMM yyyy hh:mm:ss Z
- dd MMM yyyy hh:mm:ss
- dd MMM yyyy
- now (translated as current date and time)
-
MatrixParam['to']: (date)
Last modified to date. Supported date formats are:
- dd MMM yyyy hh:mm:ss Z
- dd MMM yyyy hh:mm:ss
- dd MMM yyyy
- now (translated as current date and time)
-
MatrixParam['attribute']: (string)
One or more attributes can be provided.
-
MatrixParam['value']: (string)
One or more values can be provided.
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
A collection of reference object links.
Returns a list of references.
get /assets/{assetId}/references
Returns a list of references.
URI Parameters
-
assetId: required (integer)
Asset ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
-
MatrixParam['includeDisabled']: (boolean)
If set to true, this matrix parameter retrieves all the references including referenced objects that have been disabled. Example- api/assets/
/references;includeDisabled=true
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns a list of reviews.
get /assets/{assetId}/reviews
Returns a list of reviews.
URI Parameters
-
assetId: required (integer)
Asset ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns the details for a specific review session.
Deletes a specific review session.
get /assets/{assetId}/reviews/{reviewId}
Returns the details for a specific review session.
URI Parameters
-
assetId: required (integer)
Asset ID
- reviewId: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
delete /assets/{assetId}/reviews/{reviewId}
Deletes a specific review session.
URI Parameters
-
assetId: required (integer)
Asset ID
- reviewId: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns the list of actions available to a user in a specific review session.
Performs an action. Possible action types are - delete, approve, unapprove, destroy.
get /assets/{assetId}/reviews/{reviewId}/actions
Returns the list of actions available to a user in a specific review session.
URI Parameters
-
assetId: required (integer)
Asset ID
- reviewId: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /assets/{assetId}/reviews/{reviewId}/actions
Performs an action. Possible action types are - delete, approve, unapprove, destroy.
URI Parameters
-
assetId: required (integer)
Asset ID
- reviewId: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"action": {
"type": "string",
"required": true
}
}
}
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"name": {
"type": "string",
"required": false
},
"type": {
"type": "string",
"required": false
},
"variant": {
"type": "string",
"required": false
},
"enabled": {
"type": "boolean",
"required": false
},
"deleted": {
"type": "boolean",
"required": false
},
"href": {
"type": "string",
"required": false
},
"owner": {
"type": "string",
"required": false
}
}
}
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Retrieves a list of comments made during a specific review session.
get /assets/{assetId}/reviews/{reviewId}/comments
Retrieves a list of comments made during a specific review session.
URI Parameters
-
assetId: required (integer)
Asset ID
- reviewId: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Retrieves a list of reviewers and the status for each reviewer in a specific review session.
get /assets/{assetId}/reviews/{reviewId}/statuses
Retrieves a list of reviewers and the status for each reviewer in a specific review session.
URI Parameters
-
assetId: required (integer)
Asset ID
- reviewId: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Retrieves the status information for a specific reviewer in review session.
Enables a user to change the status information for a specific reviewer in review session.
get /assets/{assetId}/reviews/{reviewId}/statuses/{reviewer}
Retrieves the status information for a specific reviewer in review session.
URI Parameters
-
assetId: required (integer)
Asset ID
- reviewId: required (string)
- reviewer: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
put /assets/{assetId}/reviews/{reviewId}/statuses/{reviewer}
Enables a user to change the status information for a specific reviewer in review session.
URI Parameters
-
assetId: required (integer)
Asset ID
- reviewId: required (string)
- reviewer: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"reviewer": {
"type": "integer",
"required": true
},
"finished": {
"type": "boolean",
"required": false
},
"customStatuses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"customStatusId": {
"type": "integer",
"required": true
},
"instance": {
"type": "object",
"required": false
}
}
},
"required": false
}
}
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Enables a user to post a comment against a specific range of frames within an asset in a review session.
post /assets/{assetId}/reviews/{reviewId}/annotations
Enables a user to post a comment against a specific range of frames within an asset in a review session.
URI Parameters
-
assetId: required (integer)
Asset ID
- reviewId: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"timelineComment": {
"comment": {
"type": "string",
"required": true
},
"timestampIn": {
"type": "integer",
"required": true
},
"timestampOut": {
"type": "integer",
"required": true
}
}
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Enables a user to post a comment against a specific range of frames within an asset, in a review session.
put /assets/{assetId}/reviews/{reviewId}/annotations/{annotationId}
Enables a user to post a comment against a specific range of frames within an asset, in a review session.
URI Parameters
-
assetId: required (integer)
Asset ID
- reviewId: required (string)
- annotationId: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"timelineComment": {
"comment": {
"type": "string",
"required": true
},
"timestampIn": {
"type": "integer",
"required": true
},
"timestampOut": {
"type": "integer",
"required": true
}
}
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
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
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.
get /assets/{assetId}/metadata
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
URI Parameters
-
assetId: required (integer)
Asset ID
Headers
-
Accept: (string)
Method will return JSON by default, but will return XML if set to application/xml.
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
put /assets/{assetId}/metadata
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.
URI Parameters
-
assetId: required (integer)
Asset ID
Headers
-
Accept: (string)
Method will return JSON by default, but will return XML if set to application/xml.
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+xml
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+xml
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
A collection of job object links.
Returns a list of jobs associated with the asset. Listing composed of href links to the job resource and is based on supplied filters.
get /assets/{assetId}/jobs
Returns a list of jobs associated with the asset. Listing composed of href links to the job resource and is based on supplied filters.
URI Parameters
-
assetId: required (integer)
Asset ID
Query Parameters
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['status']: (one of Scheduled, Pending, Queued, WaitingForLock, Running, Completed, Cancelled, Failed, TimedOut)
Status of Jobs
-
MatrixParam['skipCount']: (boolean)
This parameter skips the count query execution when fetching a record.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
A collection of workflow object links.
Get a list of workflows, based on supplied filters.
get /assets/{assetId}/workflows
Get a list of workflows, based on supplied filters.
URI Parameters
-
assetId: required (integer)
Asset ID
Query Parameters
-
MatrixParam['searchText']: (string)
Search for occurrences of searchText in Name, Description, ID, Attachments, Comments and Metadata fields.
-
MatrixParam['owner']: (string - minLength: 1)
Owner user name
-
MatrixParam['variant']: (string - minLength: 1)
List of Variants
-
MatrixParam['excludedVariants']: (string - minLength: 1)
List of Variants
-
MatrixParam['createdFrom']: (date)
Created from date. Supported date formats are:
- dd MMM yyyy hh:mm:ss Z
- dd MMM yyyy hh:mm:ss
- dd MMM yyyy
- now (translated as current date and time)
-
MatrixParam['createdTo']: (date)
Created to date. Supported date formats are:
- dd MMM yyyy hh:mm:ss Z
- dd MMM yyyy hh:mm:ss
- dd MMM yyyy
- now (translated as current date and time)
-
MatrixParam['lastModifiedFrom']: (date)
Last modified from date. Supported date formats are:
- dd MMM yyyy hh:mm:ss Z
- dd MMM yyyy hh:mm:ss
- dd MMM yyyy
- now (translated as current date and time)
-
MatrixParam['lastModifiedTo']: (date)
Last modified to date. Supported date formats are:
- dd MMM yyyy hh:mm:ss Z
- dd MMM yyyy hh:mm:ss
- dd MMM yyyy
- now (translated as current date and time)
-
MatrixParam['enabled']: (one of true, false, all)
Enabled flag
-
MatrixParam['deleted']: (one of true, false, all)
Deleted flag
-
MatrixParam['approved']: (one of true, false, all)
Approved flag
-
MatrixParam['accountId']: (number)
You can list multiple Account Ids separated by a colon, e.g. aId=1; aId=2;
-
MatrixParam['workspaceId']: (number)
You can list multiple Workspace Ids separated by a colon, e.g. wsId=1; wsId=2;
-
MatrixParam['metadataDefinitionId']: (number)
Metadata Definition Id
-
MatrixParam['includeNoVariant']: (boolean)
Includes Objects that do not have a Variant.
- MatrixParam['includeData']: (boolean)
-
MatrixParam['parentId’]: (number)
Returns a list of parent Ids. Please note that this matrix parameter can only be used if the parent is a user defined object.
-
MatrixParam['includeVariables']: (boolean)
Whether or not to include the Variables of Workflows or Jobs in the response.
- MatrixParam['ancestorId']: (number)
- MatrixParam['level']: (number)
- MatrixParam['objectType']: (string)
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['definitionId']: (integer - minimum: 0)
The workflow definition ID
-
MatrixParam['definitionVersion']: (integer - minimum: 0)
The workflow defintion version. Specifying definition version requires that the workflow definition ID is also specified.
-
MatrixParam['status']: (one of Running, Ended, Failed, Cancelled, Cancelling, Completed)
The workflow status
-
MatrixParam['skipCount']: (boolean)
This parameter skips the count query execution when fetching a record.
-
MatrixParam['startDateFrom']: (date)
Supported date formats are:
- dd MMM yyyy hh:mm:ss Z
- dd MMM yyyy hh:mm:ss
- dd MMM yyyy
- now (translated as current date and time)
-
MatrixParam['startDateTo']: (date)
Supported date formats are:
- dd MMM yyyy hh:mm:ss Z
- dd MMM yyyy hh:mm:ss
- dd MMM yyyy
- now (translated as current date and time)
-
MatrixParam['endDateFrom']: (date)
Supported date formats are:
- dd MMM yyyy hh:mm:ss Z
- dd MMM yyyy hh:mm:ss
- dd MMM yyyy
- now (translated as current date and time)
-
MatrixParam['endDateTo']: (date)
Supported date formats are:
- dd MMM yyyy hh:mm:ss Z
- dd MMM yyyy hh:mm:ss
- dd MMM yyyy
- now (translated as current date and time)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Operations on asset keyframes.
Returns a list of keyframes, based on supplied filters.
Creates a new keyframe from an existing Asset.
get /assets/{assetId}/keyframes
Returns a list of keyframes, based on supplied filters.
URI Parameters
-
assetId: required (integer)
Asset ID
Query Parameters
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /assets/{assetId}/keyframes
Creates a new keyframe from an existing Asset.
URI Parameters
-
assetId: required (integer)
Asset ID
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"title": {
"type": "string",
"required": true
},
"description": {
"type": "string",
"required": false
},
"approved": {
"type": "boolean",
"required": false
},
"master": {
"type": "boolean",
"required": false
},
"timecode": {
"type": "long",
"required": false
},
"mimeType": {
"type": "string",
"required": false
},
"image": {
"type": "string",
"required": false
}
}
}
Returns details of the specific keyframe.
Updates details of the keyframe.
Deletes the keyframe.
get /assets/{assetId}/keyframes/{keyframeId}
Returns details of the specific keyframe.
URI Parameters
-
assetId: required (integer)
Asset ID
-
keyframeId: required (integer)
Keyframe ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
put /assets/{assetId}/keyframes/{keyframeId}
Updates details of the keyframe.
URI Parameters
-
assetId: required (integer)
Asset ID
-
keyframeId: required (integer)
Keyframe ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"title": {
"type": "string",
"required": true
},
"description": {
"type": "string",
"required": false
},
"approved": {
"type": "boolean",
"required": false
},
"master": {
"type": "boolean",
"required": false
}
}
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
delete /assets/{assetId}/keyframes/{keyframeId}
Deletes the keyframe.
URI Parameters
-
assetId: required (integer)
Asset ID
-
keyframeId: required (integer)
Keyframe ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns the keyframe image.
get /assets/{assetId}/keyframes/{keyframeId}/image
Returns the keyframe image.
URI Parameters
-
assetId: required (integer)
Asset ID
-
keyframeId: required (integer)
Keyframe ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns a stream of bytes.
get /assets/{assetId}/keyframes/{keyframeId}/raw
Returns a stream of bytes.
URI Parameters
-
assetId: required (integer)
Asset ID
-
keyframeId: required (integer)
Keyframe ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Used for viewing published players.
Returns a list of associated players.
get /assets/{assetId}/players
Returns a list of associated players.
URI Parameters
-
assetId: required (integer)
Asset ID
Query Parameters
-
MatrixParam['searchText']: (string)
Search for occurrences of searchText in Name, Description, ID, Attachments, Comments and Metadata fields.
-
MatrixParam['owner']: (string - minLength: 1)
Owner user name
-
MatrixParam['variant']: (string - minLength: 1)
List of Variants
-
MatrixParam['excludedVariants']: (string - minLength: 1)
List of Variants
-
MatrixParam['createdFrom']: (date)
Created from date. Supported date formats are:
- dd MMM yyyy hh:mm:ss Z
- dd MMM yyyy hh:mm:ss
- dd MMM yyyy
- now (translated as current date and time)
-
MatrixParam['createdTo']: (date)
Created to date. Supported date formats are:
- dd MMM yyyy hh:mm:ss Z
- dd MMM yyyy hh:mm:ss
- dd MMM yyyy
- now (translated as current date and time)
-
MatrixParam['lastModifiedFrom']: (date)
Last modified from date. Supported date formats are:
- dd MMM yyyy hh:mm:ss Z
- dd MMM yyyy hh:mm:ss
- dd MMM yyyy
- now (translated as current date and time)
-
MatrixParam['lastModifiedTo']: (date)
Last modified to date. Supported date formats are:
- dd MMM yyyy hh:mm:ss Z
- dd MMM yyyy hh:mm:ss
- dd MMM yyyy
- now (translated as current date and time)
-
MatrixParam['enabled']: (one of true, false, all)
Enabled flag
-
MatrixParam['deleted']: (one of true, false, all)
Deleted flag
-
MatrixParam['approved']: (one of true, false, all)
Approved flag
-
MatrixParam['accountId']: (number)
You can list multiple Account Ids separated by a colon, e.g. aId=1; aId=2;
-
MatrixParam['workspaceId']: (number)
You can list multiple Workspace Ids separated by a colon, e.g. wsId=1; wsId=2;
-
MatrixParam['metadataDefinitionId']: (number)
Metadata Definition Id
-
MatrixParam['includeNoVariant']: (boolean)
Includes Objects that do not have a Variant.
- MatrixParam['includeData']: (boolean)
-
MatrixParam['parentId’]: (number)
Returns a list of parent Ids. Please note that this matrix parameter can only be used if the parent is a user defined object.
-
MatrixParam['includeVariables']: (boolean)
Whether or not to include the Variables of Workflows or Jobs in the response.
- MatrixParam['ancestorId']: (number)
- MatrixParam['level']: (number)
- MatrixParam['objectType']: (string)
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['definitionId']: (integer - minimum: 0)
The player definition ID
-
MatrixParam['assetTitle']: (string)
The asset title
-
MatrixParam['skipCount']: (boolean)
This parameter skips the count query execution when fetching a record.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns a list of Actions which can be executed on the asset based on its current state.
Returns a list of Actions that can be executed on the asset based on its current state.
Performs an action. Possible action types are - enable, disable, start, stop, delete, retry, cancel, schedule, approve, unapprove, destroy, destroy.
get /assets/{assetId}/actions
Returns a list of Actions that can be executed on the asset based on its current state.
URI Parameters
-
assetId: required (integer)
Asset ID
Query Parameters
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /assets/{assetId}/actions
Performs an action. Possible action types are - enable, disable, start, stop, delete, retry, cancel, schedule, approve, unapprove, destroy, destroy.
URI Parameters
-
assetId: required (integer)
Asset ID
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"action": {
"type": "string",
"required": true
}
}
}
HTTP status code 200
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"name": {
"type": "string",
"required": false
},
"type": {
"type": "string",
"required": false
},
"variant": {
"type": "string",
"required": false
},
"enabled": {
"type": "boolean",
"required": false
},
"deleted": {
"type": "boolean",
"required": false
},
"href": {
"type": "string",
"required": false
},
"owner": {
"type": "string",
"required": false
}
}
}
Performs operations on parent asset group memberships.
Returns a list of parent group memberships.
Creates a new membership with a parent group.
get /assets/{assetId}/parentGroups
Returns a list of parent group memberships.
URI Parameters
-
assetId: required (integer)
Asset ID
Query Parameters
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['id']: (integer - minimum: 0)
The asset ID
-
MatrixParam['name']: (string)
The asset name
-
MatrixParam['type']: (string)
The asset type
-
MatrixParam['variant']: (string)
The variants
-
MatrixParam['includeMetadata']: (boolean)
Include the metadata in the response
-
MatrixParam['deleted']: (boolean)
Include deleted assets
-
MatrixParam['creationContext']: (string)
The creation context
-
MatrixParam['membershipName']: (string)
The membership name
-
MatrixParam['skipCount']: (boolean)
This parameter skips the count query execution when fetching a record.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /assets/{assetId}/parentGroups
Creates a new membership with a parent group.
URI Parameters
-
assetId: required (integer)
Asset ID
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"required": true
},
"membershipName": {
"type": "string",
"required": true
}
}
}
}
Returns details of the specific asset membership.
Updates the membership with the parent group.
Delete the membership with the parent group.
get /assets/{assetId}/parentGroups/{membershipId}
Returns details of the specific asset membership.
URI Parameters
-
assetId: required (integer)
Asset ID
-
membershipId: required (integer)
The Asset Membership ID.
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
put /assets/{assetId}/parentGroups/{membershipId}
Updates the membership with the parent group.
URI Parameters
-
assetId: required (integer)
Asset ID
-
membershipId: required (integer)
The Asset Membership ID.
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"membershipName": {
"type": "string",
"required": true
}
}
}
HTTP status code 200
Returns the updated membership.
Body
Type: application/vnd.nativ.mio.v1+json
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
delete /assets/{assetId}/parentGroups/{membershipId}
Delete the membership with the parent group.
URI Parameters
-
assetId: required (integer)
Asset ID
-
membershipId: required (integer)
The Asset Membership ID.
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Performs operations on child asset memberships for a given asset group.
Returns a list of asset memberships (children). This resource is only available for asset groups.
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.
Deletes an existing membership.
get /assets/{assetId}/members
Returns a list of asset memberships (children). This resource is only available for asset groups.
URI Parameters
-
assetId: required (integer)
Asset ID
Query Parameters
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['id']: (integer - minimum: 0)
The asset ID
-
MatrixParam['name']: (string)
The asset name
-
MatrixParam['type']: (string)
The asset type
-
MatrixParam['variant']: (string)
The variants
-
MatrixParam['includeMetadata']: (boolean)
Include the metadata in the response
-
MatrixParam['deleted']: (boolean)
Include deleted assets
-
MatrixParam['creationContext']: (string)
The creation context
-
MatrixParam['membershipName']: (string)
The membership name
-
MatrixParam['group']: (string)
This parameter enables you to retrieve a list of group members and exclude all of the items in the group such as any media assets, image assets, and so on. In order to retrieve just the group members, you would do the following- api/assets/
/members;group=true”. In order to only list the group items, you would do the following- api/assets/ /members;group=false” -
MatrixParam['skipCount']: (boolean)
This parameter skips the count query execution when fetching a record.
-
MatrixParam['assetType']: (boolean)
This parameter enables you to retrieve a list of specific asset types. For example - api/assets/{assetId}/members;assetType=File;fileType=Image;fileType=Media;fileType=Text. The asset types that can be retrieved are as follows - File, Image, Media, Text, IMP Asset, Segmented Clip, Sequence, Subtitle, Placeholder.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /assets/{assetId}/members
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.
URI Parameters
-
assetId: required (integer)
Asset ID
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"memberships": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"required": true
},
"index": {
"type": "integer",
"required": true
},
"membershipName": {
"type": "string",
"required": true
}
}
},
"required": true
}
}
}
HTTP status code 201
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": true
},
"membershipName": {
"type": "string",
"required": true
},
"href": {
"type": "string",
"required": true
},
"asset": {
"type": "array",
"required": true
},
"id": {
"type": "integer",
"required": true
},
"name": {
"type": "string",
"required": true
},
"displayName": {
"type": "string",
"required": true
},
"type": {
"type": "string",
"required": true
},
"href": {
"type": "string",
"required": true
},
"assetOrigin": {
"type": "string",
"required": true
},
"accountId": {
"type": "integer",
"required": true
},
"workspaceId": {
"type": "integer",
"required": true
},
"workspace": {
"type": "array",
"required": true
},
"id": {
"type": "integer",
"required": true
},
"name": {
"type": "string",
"required": true
},
"displayName": {
"type": "string",
"required": true
},
"accountId": {
"type": "integer",
"required": true
},
"href": {
"type": "string",
"required": true
},
"index": {
"type": "integer",
"required": true
}
}
}
delete /assets/{assetId}/members
Deletes an existing membership.
URI Parameters
-
assetId: required (integer)
Asset ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['membershipId']: (integer - minimum: 0)
This parameter can be used to delete one or more assets from a group. In order to delete an asset from a group, you must specify the membership ID. Example /api/assets;membershipId=1234;membershipId=2345;membershipId=3456
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
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.
put /assets/{assetId}/members/{membershipId}
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.
URI Parameters
-
assetId: required (integer)
Asset ID
- membershipId: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"index": {
"type": "integer",
"required": true
}
}
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": true
},
"href": {
"type": "string",
"required": true
},
"asset": {
"type": "array",
"required": true
},
"id": {
"type": "integer",
"required": true
},
"name": {
"type": "string",
"required": true
},
"displayName": {
"type": "string",
"required": true
},
"type": {
"type": "string",
"required": true
},
"href": {
"type": "string",
"required": true
},
"assetOrigin": {
"type": "string",
"required": true
},
"accountId": {
"type": "integer",
"required": true
},
"workspaceId": {
"type": "integer",
"required": true
},
"workspace": {
"type": "array",
"required": true
},
"id": {
"type": "integer",
"required": true
},
"name": {
"type": "string",
"required": true
},
"displayName": {
"type": "string",
"required": true
},
"accountId": {
"type": "integer",
"required": true
},
"href": {
"type": "string",
"required": true
},
"index": {
"type": "integer",
"required": true
}
}
}
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
A collection of child object links.
Returns the child file Assets This is only available for file assets which have child file assets.
get /assets/{assetId}/children
Returns the child file Assets This is only available for file assets which have child file assets.
URI Parameters
-
assetId: required (integer)
Asset ID
Query Parameters
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['id']: (integer - minimum: 0)
The asset ID
-
MatrixParam['name']: (string)
The asset name
-
MatrixParam['type']: (string)
The asset type
-
MatrixParam['variant']: (string)
The variants
-
MatrixParam['includeMetadata']: (boolean)
Include the metadata in the response
-
MatrixParam['deleted']: (boolean)
Include deleted assets
-
MatrixParam['creationContext']: (string)
The creation context
-
MatrixParam['referenceName']: (string)
The asset reference name
-
MatrixParam['skipCount']: (boolean)
This parameter skips the count query execution when fetching a record.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns the parent file Asset. This is only available for file assets which have a parent.
get /assets/{assetId}/parent
Returns the parent file Asset. This is only available for file assets which have a parent.
URI Parameters
-
assetId: required (integer)
Asset ID
HTTP status code 200
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"name": {
"type": "string",
"required": false
},
"type": {
"type": "string",
"required": false
},
"variant": {
"type": "string",
"required": false
},
"enabled": {
"type": "boolean",
"required": false
},
"deleted": {
"type": "boolean",
"required": false
},
"href": {
"type": "string",
"required": false
},
"owner": {
"type": "string",
"required": false
}
}
}
Returns a list of active proxies available for a specific Asset.
get /assets/{assetId}/proxies
Returns a list of active proxies available for a specific Asset.
URI Parameters
-
assetId: required (integer)
Asset ID
Query Parameters
-
MatrixParam['assetOrigins']: (string)
Returns one or more proxies. You can return the details of either a standard proxy (PROXY) or a segmented proxy (SEGMENTED_PROXY). Example- /api/assets/
/proxies;assetOrigins=PROXY;assetOrigins=SEGMENTED_PROXY
Returns a list of external IDs associated with an Account.
Creates new external ID.
get /assets/{assetId}/externalIds
Returns a list of external IDs associated with an Account.
URI Parameters
-
assetId: required (integer)
Asset ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
},
"href": {
"type": "string"
}
},
"required": [
"key",
"value",
"href"
]
}
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /assets/{assetId}/externalIds
Creates new external ID.
URI Parameters
-
assetId: required (integer)
Asset ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"key",
"value"
]
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns the details for a specific external ID.
Updates the Account/System Property
Deletes a specific external ID.
get /assets/{assetId}/externalIds/{key}
Returns the details for a specific external ID.
URI Parameters
-
assetId: required (integer)
Asset ID
- key: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
put /assets/{assetId}/externalIds/{key}
Updates the Account/System Property
URI Parameters
-
assetId: required (integer)
Asset ID
- key: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"properties": {
"value": {
"type": "string"
}
},
"required": [
"value"
]
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
delete /assets/{assetId}/externalIds/{key}
Deletes a specific external ID.
URI Parameters
-
assetId: required (integer)
Asset ID
- key: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns the media region that is associated to the asset if there is one. This is only available for 5.3.0 onwards.
Creates a new media region for a Clip or MediaAsset. This is only available for 5.3.0 onwards.
Updates the media region of an asset. This is only available for 5.3.0 onwards
Deletes the media region of an asset if there is one. This is only available for 5.3.0 onwards.
post /assets/{assetId}/mediaRegions
Creates a new media region for a Clip or MediaAsset. This is only available for 5.3.0 onwards.
URI Parameters
-
assetId: required (integer)
Asset ID
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"sourceTimestampIn": {
"type": "long",
"required": true
},
"sourceTimestampOut": {
"type": "long",
"required": true
}
}
}
put /assets/{assetId}/mediaRegions
Updates the media region of an asset. This is only available for 5.3.0 onwards
URI Parameters
-
assetId: required (integer)
Asset ID
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"sourceTimestampIn": {
"type": "long",
"required": true
},
"sourceTimestampOut": {
"type": "long",
"required": true
}
}
}
Returns all placed media regions that belong to the specified asset. This is only available for 5.3.0 onwards.
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.
post /assets/{assetId}/placedMediaRegions
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.
URI Parameters
-
assetId: required (integer)
Asset ID
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"sourceTimestampIn": {
"type": "long",
"required": true
},
"sourceTimestampOut": {
"type": "long",
"required": true
},
"assetCorrelationId": {
"type": "long",
"required": true
},
"targetTimestampIn": {
"type": "long",
"required": true
},
"targetTimestampOut": {
"type": "long",
"required": true
}
}
}
Returns the placed media region found by specified id for a specified asset id. This is only available for 5.3.0 onwards.
Updates the placed media region found by specified id for a specified asset id. This is only available for 5.3.0 onwards.
get /assets/{assetId}/placedMediaRegions/{placedMediaRegionId}
put /assets/{assetId}/placedMediaRegions/{placedMediaRegionId}
Updates the placed media region found by specified id for a specified asset id. This is only available for 5.3.0 onwards.
URI Parameters
-
assetId: required (integer)
Asset ID
- placedMediaRegionId: required (string)
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"sourceTimestampIn": {
"type": "long",
"required": true
},
"sourceTimestampOut": {
"type": "long",
"required": true
},
"assetCorrelationId": {
"type": "long",
"required": true
},
"targetTimestampIn": {
"type": "long",
"required": true
},
"targetTimestampOut": {
"type": "long",
"required": true
}
}
}
HTTP status code 200
Returns all of the subtitle assets that are linked to a specific media asset.
get /assets/{assetId}/subtitles
Returns all of the subtitle assets that are linked to a specific media asset.
URI Parameters
-
assetId: required (integer)
Asset ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Collections
This resource is used for viewing Collections.
Returns a list of Collections.
Creates a new Collection.
get /collections
Returns a list of Collections.
Query Parameters
- MatrixParam['name']: (string)
- MatrixParam['description']: (string)
- MatrixParam['enabled']: (boolean)
- MatrixParam['deleted']: (boolean - default: false)
- MatrixParam['account']: (string)
-
MatrixParam['exactNameMatch']: (string)
Pass it true if you want to search an Object using the exact name.
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
-
MatrixParam['externalId']: (string)
Search for an object via its endpoint (e.g. assets, workflows) and specify the external ID key and value, e.g. For example /api/assets;externalId=key:value
-
MatrixParam['skipCount']: (boolean)
This parameter skips the count query execution when fetching a record.
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /collections
Creates a new Collection.
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"name": {
"type": "string",
"required": true
},
"description": {
"type": "string",
"required": false
},
"assets": {
"type": "array",
"items": {
"type": "long"
}
},
"subCollections": {
"required": "false",
"type": "array",
"items": {
"type": "long"
}
},
"parentId": {
"type": "long",
"required": false
},
"variant": {
"type": "string",
"required": false
},
"metadataDefintionId": {
"type": "long",
"required": false
},
"accountId": {
"type": "long",
"required": false
},
"workspaceId": {
"type": "long",
"required": false
}
}
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"name": {
"type": "string",
"required": false
},
"type": {
"type": "string",
"required": false
},
"variant": {
"type": "string",
"required": false
},
"enabled": {
"type": "boolean",
"required": false
},
"deleted": {
"type": "boolean",
"required": false
},
"href": {
"type": "string",
"required": false
},
"owner": {
"type": "string",
"required": false
}
}
}
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns Collection found by specified id.
Updates the collection.
Deletes a Collection found by specified id.
get /collections/{collectionId}
Returns Collection found by specified id.
URI Parameters
-
collectionId: required (integer)
Asset Membership ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
put /collections/{collectionId}
Updates the collection.
URI Parameters
-
collectionId: required (integer)
Asset Membership ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"name": {
"type": "string",
"required": false
},
"description": {
"type": "string",
"required": false
},
"parentId": {
"type": "long",
"required": false
},
"Variant": {
"type": "string",
"required": false
},
"metadataDefinitionId": {
"type": "long",
"required": false
}
}
}
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
delete /collections/{collectionId}
Deletes a Collection found by specified id.
URI Parameters
-
collectionId: required (integer)
Asset Membership ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 204
Body
Type: application/vnd.nativ.mio.v1+json
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns the Assets found by specified ID. You can also remove Assets from a collection.
Returns a list of items.
put /collections/{collectionId}/items
Returns the Assets found by specified ID. You can also remove Assets from a collection.
URI Parameters
-
collectionId: required (integer)
Asset Membership ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"assetsToRemove": {
"type": "long",
"description": "A list of IDs",
"required": false
},
"assetsToAdd": {
"type": "long",
"description": "A list of IDs",
"required": false
}
}
}
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
get /collections/{collectionId}/items
Returns a list of items.
URI Parameters
-
collectionId: required (integer)
Asset Membership ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
A collection of comment.
Returns comments for a specific collection.
Posts a new comment on a specific collection.
get /collections/{collectionId}/comments
Returns comments for a specific collection.
URI Parameters
-
collectionId: required (integer)
Asset Membership ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /collections/{collectionId}/comments
Posts a new comment on a specific collection.
URI Parameters
-
collectionId: required (integer)
Asset Membership ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"message": {
"type": "string",
"required": true
}
}
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"name": {
"type": "string",
"required": false
},
"type": {
"type": "string",
"required": false
},
"variant": {
"type": "string",
"required": false
},
"enabled": {
"type": "boolean",
"required": false
},
"deleted": {
"type": "boolean",
"required": false
},
"href": {
"type": "string",
"required": false
},
"owner": {
"type": "string",
"required": false
}
}
}
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Performs operations on a single Comment.
Returns a specific comment for a specific collection.
Updates a comment for a specified Object within a collection.
Deletes a comment on a specific object within a collection.
get /collections/{collectionId}/comments/{commentId}
Returns a specific comment for a specific collection.
URI Parameters
-
collectionId: required (integer)
Asset Membership ID
-
commentId: required (integer)
Comment ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
put /collections/{collectionId}/comments/{commentId}
Updates a comment for a specified Object within a collection.
URI Parameters
-
collectionId: required (integer)
Asset Membership ID
-
commentId: required (integer)
Comment ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
delete /collections/{collectionId}/comments/{commentId}
Deletes a comment on a specific object within a collection.
URI Parameters
-
collectionId: required (integer)
Asset Membership ID
-
commentId: required (integer)
Comment ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 204
Body
Type: application/vnd.nativ.mio.v1+json
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Copies an existing Collection.
post /collections/{collectionId}/comments/copy
Copies an existing Collection.
URI Parameters
-
collectionId: required (integer)
Asset Membership ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"name": {
"type": "string",
"required": true
},
"description": {
"type": "string",
"required": false
}
}
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
A collection of follower.
Returns comments for a specific collection.
get /collections/{collectionId}/followers
Returns comments for a specific collection.
URI Parameters
-
collectionId: required (integer)
Asset Membership ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
A collection of attachment.
Returns attachments for a specific collection.
Adds a new attachment to the collection.
get /collections/{collectionId}/attachments
Returns attachments for a specific collection.
URI Parameters
-
collectionId: required (integer)
Asset Membership ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /collections/{collectionId}/attachments
Adds a new attachment to the collection.
URI Parameters
-
collectionId: required (integer)
Asset Membership ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"name": {
"type": "string",
"required": false
},
"type": {
"type": "string",
"required": false
},
"variant": {
"type": "string",
"required": false
},
"enabled": {
"type": "boolean",
"required": false
},
"deleted": {
"type": "boolean",
"required": false
},
"href": {
"type": "string",
"required": false
},
"owner": {
"type": "string",
"required": false
}
}
}
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns the details for a specific attachment.
Updates the comment for an existing attachment.
Deletes an existing attachment.
get /collections/{collectionId}/attachments/{attachmentId}
Returns the details for a specific attachment.
URI Parameters
-
collectionId: required (integer)
Asset Membership ID
- attachmentId: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
put /collections/{collectionId}/attachments/{attachmentId}
Updates the comment for an existing attachment.
URI Parameters
-
collectionId: required (integer)
Asset Membership ID
- attachmentId: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"description": {
"type": "string",
"required": true
}
}
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
delete /collections/{collectionId}/attachments/{attachmentId}
Deletes an existing attachment.
URI Parameters
-
collectionId: required (integer)
Asset Membership ID
- attachmentId: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
A collection of history.
Returns the history for the given collection.
get /collections/{collectionId}/history
Returns the history for the given collection.
URI Parameters
-
collectionId: required (integer)
Asset Membership ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
A collection of reference object links.
Returns the references for the given collection.
get /collections/{collectionId}/references
Returns the references for the given collection.
URI Parameters
-
collectionId: required (integer)
Asset Membership ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns the comments for the given Variable Instance.
Adds a new comment to the Variable Instance.
get /collections/{collectionId}/metadata/{variableInstanceId}/comments
Returns the comments for the given Variable Instance.
URI Parameters
-
collectionId: required (integer)
Asset Membership ID
- variableInstanceId: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /collections/{collectionId}/metadata/{variableInstanceId}/comments
Adds a new comment to the Variable Instance.
URI Parameters
-
collectionId: required (integer)
Asset Membership ID
- variableInstanceId: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"message": {
"type": "string",
"required": true
}
}
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"name": {
"type": "string",
"required": false
},
"type": {
"type": "string",
"required": false
},
"variant": {
"type": "string",
"required": false
},
"enabled": {
"type": "boolean",
"required": false
},
"deleted": {
"type": "boolean",
"required": false
},
"href": {
"type": "string",
"required": false
},
"owner": {
"type": "string",
"required": false
}
}
}
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Deletes a comment on a specific object within a collection.
delete /collections/{collectionId}/metadata/{variableInstanceId}/comments/{commentId}
Deletes a comment on a specific object within a collection.
URI Parameters
-
collectionId: required (integer)
Asset Membership ID
- variableInstanceId: required (string)
- commentId: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 204
Body
Type: application/vnd.nativ.mio.v1+json
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns Sub-collections for the given collection.
get /collections/{collectionId}/subCollections
Returns Sub-collections for the given collection.
URI Parameters
-
collectionId: required (integer)
Asset Membership ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
A collection of keyframe.
Get all keyframe, optionally filtered
Sets a new Keyframe to the collection.
Updates the Collection's Keyframe with an existing one.
Deletes a Keyframe for a collection.
get /collections/{collectionId}/subCollections/keyframe
Get all keyframe, optionally filtered
URI Parameters
-
collectionId: required (integer)
Asset Membership ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /collections/{collectionId}/subCollections/keyframe
Sets a new Keyframe to the collection.
URI Parameters
-
collectionId: required (integer)
Asset Membership ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"image": {
"type": "string",
"description": "Base64 encoded file content",
"required": true
},
"mimeType": {
"type": "string",
"required": true
}
}
}
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
put /collections/{collectionId}/subCollections/keyframe
Updates the Collection's Keyframe with an existing one.
URI Parameters
-
collectionId: required (integer)
Asset Membership ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"image": {
"type": "string",
"description": "Base64 encoded file content",
"required": true
},
"mimeType": {
"type": "string",
"required": true
}
}
}
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
delete /collections/{collectionId}/subCollections/keyframe
Deletes a Keyframe for a collection.
URI Parameters
-
collectionId: required (integer)
Asset Membership ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 204
Body
Type: application/vnd.nativ.mio.v1+json
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns a list of external IDs associated with an Account.
Creates new external ID.
get /collections/{collectionId}/subCollections/externalIds
Returns a list of external IDs associated with an Account.
URI Parameters
-
collectionId: required (integer)
Asset Membership ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
},
"href": {
"type": "string"
}
},
"required": [
"key",
"value",
"href"
]
}
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /collections/{collectionId}/subCollections/externalIds
Creates new external ID.
URI Parameters
-
collectionId: required (integer)
Asset Membership ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"key",
"value"
]
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns the details for a specific external ID.
Updates the Account/System Property
Deletes a specific external ID.
get /collections/{collectionId}/subCollections/externalIds/{key}
Returns the details for a specific external ID.
URI Parameters
-
collectionId: required (integer)
Asset Membership ID
- key: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
put /collections/{collectionId}/subCollections/externalIds/{key}
Updates the Account/System Property
URI Parameters
-
collectionId: required (integer)
Asset Membership ID
- key: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"properties": {
"value": {
"type": "string"
}
},
"required": [
"value"
]
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
delete /collections/{collectionId}/subCollections/externalIds/{key}
Deletes a specific external ID.
URI Parameters
-
collectionId: required (integer)
Asset Membership ID
- key: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Evaluation
This resource is used for evaluating URLs for panel supported user defined objects.
This endpoint is used to evaluate URLs for panel supported user defined objects.
post /evaluation
This endpoint is used to evaluate URLs for panel supported user defined objects.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"url": {
"type": "string",
"required": true
},
"objectId": {
"type": "string",
"required": true
},
"context": {
"type": "integer",
"required": true
}
}
}
HTTP status code 200
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"result": {
"type": "string",
"required": true
}
}
}
Events
This resource is used for viewing Events
Returns a list of Events. Listing is based on supplied filters.
Create a new Event
get /events
Returns a list of Events. Listing is based on supplied filters.
Query Parameters
- MatrixParam['objectId']: (integer - minimum: 0)
-
MatrixParam['objectType']: (string)
One or more objectTypes can be provided. This parameter can't be used when an objectId is already provided.
-
MatrixParam['accountId']: (string)
One or more accountId can be provided.
-
MatrixParam['severity']: (one of Info, Error, Warn)
One or more severities can be provided.
-
MatrixParam['eventType']: (string)
One or more eventTypes can be provided.
- MatrixParam['ownerId']: (integer - minimum: 0)
-
MatrixParam['from']: (date)
Last modified to date. Supported date formats are:
- dd MMM yyyy hh:mm:ss Z
- dd MMM yyyy hh:mm:ss
- dd MMM yyyy
- now (translated as current date and time)
-
MatrixParam['to']: (date)
Last modified to date. Supported date formats are:
- dd MMM yyyy hh:mm:ss Z
- dd MMM yyyy hh:mm:ss
- dd MMM yyyy
- now (translated as current date and time)
-
MatrixParam['attribute']: (string)
One or more attributes can be provided.
-
MatrixParam['value']: (string)
One or more values can be provided.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['externalId']: (string)
Search for an object via its endpoint (e.g. assets, workflows) and specify the external ID key and value, e.g. For example /api/assets;externalId=key:value
-
MatrixParam['skipCount']: (boolean)
This parameter skips the count query execution when fetching a record.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /events
Create a new Event
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"eventType": {
"type": "string",
"required": true
},
"severity": {
"type": "string",
"required": true
},
"objectId": {
"type": "integer",
"required": true
},
"eventDataMap": {
"type": "object",
"required": false
},
"message": {
"type": "string",
"required": false
},
"exception": {
"type": "string",
"required": false
}
}
}
Perform operations on a specific Event
Returns Event object details (priority, event-type, event-data).
get /events/{eventId}
Returns Event object details (priority, event-type, event-data).
URI Parameters
-
eventId: required (integer)
Event ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Event Handlers
This resource is used for viewing and managing EventHandlers
Returns a list of EventHandlers. Listing is based on supplied filters.
get /eventHandlers
Returns a list of EventHandlers. Listing is based on supplied filters.
Query Parameters
- MatrixParam['name']: (string)
- MatrixParam['description']: (string)
- MatrixParam['enabled']: (boolean)
- MatrixParam['deleted']: (boolean - default: false)
- MatrixParam['account']: (string)
-
MatrixParam['exactNameMatch']: (string)
Pass it true if you want to search an Object using the exact name.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['status']: (one of Started, Stopped, Failed)
Status of the EventHandler
-
MatrixParam['externalId']: (string)
Search for an object via its endpoint (e.g. assets, workflows) and specify the external ID key and value, e.g. For example /api/assets;externalId=key:value
-
MatrixParam['skipCount']: (boolean)
This parameter skips the count query execution when fetching a record.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Perform operations on a specific EventHandler
Returns EventHandler object details.
Deletes the EventHandler
get /eventHandlers/{eventHandlerId}
Returns EventHandler object details.
URI Parameters
-
eventHandlerId: required (integer)
Event Handler ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
delete /eventHandlers/{eventHandlerId}
Deletes the EventHandler
URI Parameters
-
eventHandlerId: required (integer)
Event Handler ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns a list of actions that can be performed.
Performs an action. Possible action types are - delete, destroy.
get /eventHandlers/{eventHandlerId}/actions
Returns a list of actions that can be performed.
URI Parameters
-
eventHandlerId: required (integer)
Event Handler ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /eventHandlers/{eventHandlerId}/actions
Performs an action. Possible action types are - delete, destroy.
URI Parameters
-
eventHandlerId: required (integer)
Event Handler ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"action": {
"type": "string",
"required": true
}
}
}
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"name": {
"type": "string",
"required": false
},
"type": {
"type": "string",
"required": false
},
"variant": {
"type": "string",
"required": false
},
"enabled": {
"type": "boolean",
"required": false
},
"deleted": {
"type": "boolean",
"required": false
},
"href": {
"type": "string",
"required": false
},
"owner": {
"type": "string",
"required": false
}
}
}
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
A collection of comment.
Returns a list of Comments.
Adds a new Comment.
get /eventHandlers/{eventHandlerId}/comments
Returns a list of Comments.
URI Parameters
-
eventHandlerId: required (integer)
Event Handler ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /eventHandlers/{eventHandlerId}/comments
Adds a new Comment.
URI Parameters
-
eventHandlerId: required (integer)
Event Handler ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"message": {
"type": "string",
"required": true
}
}
}
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"message": {
"type": "string",
"required": false
},
"date": {
"type": "date",
"required": false
},
"user": {
"type": "object",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"name": {
"type": "string",
"required": false
},
"fullName": {
"type": "string",
"required": false
},
"enabled": {
"type": "boolean",
"required": false
},
"deleted": {
"type": "boolean",
"required": false
},
"href": {
"type": "string",
"required": false
},
"email": {
"type": "string",
"required": false
},
"variant": {
"type": "string",
"required": false
}
}
},
"parentObject": {
"type": "object",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"name": {
"type": "string",
"required": false
},
"type": {
"type": "string",
"required": false
},
"variant": {
"type": "string",
"required": false
},
"enabled": {
"type": "boolean",
"required": false
},
"deleted": {
"type": "boolean",
"required": false
},
"href": {
"type": "string",
"required": false
},
"owner": {
"type": "string",
"required": false
}
}
}
}
}
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Performs operations on a single Comment.
Returns a Comment.
get /eventHandlers/{eventHandlerId}/comments/{commentId}
Returns a Comment.
URI Parameters
-
eventHandlerId: required (integer)
Event Handler ID
-
commentId: required (integer)
Comment ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Copies an existing Event Handler.
post /eventHandlers/{eventHandlerId}/copy
Copies an existing Event Handler.
URI Parameters
-
eventHandlerId: required (integer)
Event Handler ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"name": {
"type": "string",
"required": true
},
"description": {
"type": "string",
"required": false
}
}
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
A collection of follower.
Returns a list of users that are following this object.
get /eventHandlers/{eventHandlerId}/followers
Returns a list of users that are following this object.
URI Parameters
-
eventHandlerId: required (integer)
Event Handler ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
A collection of attachment.
Returns a list of attachments.
Creates a new attachment.
get /eventHandlers/{eventHandlerId}/attachments
Returns a list of attachments.
URI Parameters
-
eventHandlerId: required (integer)
Event Handler ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /eventHandlers/{eventHandlerId}/attachments
Creates a new attachment.
URI Parameters
-
eventHandlerId: required (integer)
Event Handler ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"fileName": {
"type": "string",
"required": true
},
"mimeType": {
"type": "string",
"required": false
},
"description": {
"type": "string",
"required": false
},
"fileContent": {
"type": "string",
"required": true
}
}
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns the details for a specific attachment.
Updates the comment for an existing attachment.
Deletes an existing attachment.
get /eventHandlers/{eventHandlerId}/attachments/{attachmentId}
Returns the details for a specific attachment.
URI Parameters
-
eventHandlerId: required (integer)
Event Handler ID
- attachmentId: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
put /eventHandlers/{eventHandlerId}/attachments/{attachmentId}
Updates the comment for an existing attachment.
URI Parameters
-
eventHandlerId: required (integer)
Event Handler ID
- attachmentId: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"description": {
"type": "string",
"required": true
}
}
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
delete /eventHandlers/{eventHandlerId}/attachments/{attachmentId}
Deletes an existing attachment.
URI Parameters
-
eventHandlerId: required (integer)
Event Handler ID
- attachmentId: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
A collection of history.
Returns a list of events.
get /eventHandlers/{eventHandlerId}/history
Returns a list of events.
URI Parameters
-
eventHandlerId: required (integer)
Event Handler ID
Query Parameters
- MatrixParam['objectId']: (integer - minimum: 0)
-
MatrixParam['objectType']: (string)
One or more objectTypes can be provided. This parameter can't be used when an objectId is already provided.
-
MatrixParam['accountId']: (string)
One or more accountId can be provided.
-
MatrixParam['severity']: (one of Info, Error, Warn)
One or more severities can be provided.
-
MatrixParam['eventType']: (string)
One or more eventTypes can be provided.
- MatrixParam['ownerId']: (integer - minimum: 0)
-
MatrixParam['from']: (date)
Last modified to date. Supported date formats are:
- dd MMM yyyy hh:mm:ss Z
- dd MMM yyyy hh:mm:ss
- dd MMM yyyy
- now (translated as current date and time)
-
MatrixParam['to']: (date)
Last modified to date. Supported date formats are:
- dd MMM yyyy hh:mm:ss Z
- dd MMM yyyy hh:mm:ss
- dd MMM yyyy
- now (translated as current date and time)
-
MatrixParam['attribute']: (string)
One or more attributes can be provided.
-
MatrixParam['value']: (string)
One or more values can be provided.
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
A collection of reference object links.
Returns a list of references.
get /eventHandlers/{eventHandlerId}/references
Returns a list of references.
URI Parameters
-
eventHandlerId: required (integer)
Event Handler ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Set or get the event configuration.
Returns the event handler configuration including a href to the configuration.
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 /eventHandlers/{eventHandlerId}/configuration
Returns the event handler configuration including a href to the configuration.
URI Parameters
-
eventHandlerId: required (integer)
Event Handler ID
Headers
-
Accept: (string)
Method will return JSON by default, but will return XML if set to application/xml.
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
put /eventHandlers/{eventHandlerId}/configuration
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.
URI Parameters
-
eventHandlerId: required (integer)
Event Handler ID
Headers
-
Accept: (string)
Method will return JSON by default, but will return XML if set to application/xml.
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+xml
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+xml
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns a list of external IDs associated with an Account.
Creates new external ID.
get /eventHandlers/{eventHandlerId}/externalIds
Returns a list of external IDs associated with an Account.
URI Parameters
-
eventHandlerId: required (integer)
Event Handler ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
},
"href": {
"type": "string"
}
},
"required": [
"key",
"value",
"href"
]
}
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /eventHandlers/{eventHandlerId}/externalIds
Creates new external ID.
URI Parameters
-
eventHandlerId: required (integer)
Event Handler ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"key",
"value"
]
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns the details for a specific external ID.
Updates the Account/System Property
Deletes a specific external ID.
get /eventHandlers/{eventHandlerId}/externalIds/{key}
Returns the details for a specific external ID.
URI Parameters
-
eventHandlerId: required (integer)
Event Handler ID
- key: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
put /eventHandlers/{eventHandlerId}/externalIds/{key}
Updates the Account/System Property
URI Parameters
-
eventHandlerId: required (integer)
Event Handler ID
- key: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"properties": {
"value": {
"type": "string"
}
},
"required": [
"value"
]
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
delete /eventHandlers/{eventHandlerId}/externalIds/{key}
Deletes a specific external ID.
URI Parameters
-
eventHandlerId: required (integer)
Event Handler ID
- key: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Files
Performs operations on non-asset files that are stored in the filestore.
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.
get /files
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.
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Groups
Perform operation on Groups
Returns a list of Groups. Listing is based on supplied filters.
Creates a new Group.
get /groups
Returns a list of Groups. Listing is based on supplied filters.
Query Parameters
- MatrixParam['name']: (string)
- MatrixParam['description']: (string)
- MatrixParam['enabled']: (boolean)
- MatrixParam['deleted']: (boolean - default: false)
- MatrixParam['account']: (string)
-
MatrixParam['exactNameMatch']: (string)
Pass it true if you want to search an Object using the exact name.
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
- MatrixParam['variant']: (string)
- MatrixParam['accoundId']: (integer - minimum: 0)
-
MatrixParam['parenAccountId']: (integer - minimum: 0)
If no parentAccountId is provided, the accountId will used instead (if it is provided).
-
MatrixParam['externalId']: (string)
Search for an object via its endpoint (e.g. assets, workflows) and specify the external ID key and value, e.g. For example /api/assets;externalId=key:value
-
MatrixParam['skipCount']: (boolean)
This parameter skips the count query execution when fetching a record.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /groups
Creates a new Group.
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"name": {
"type": "string",
"required": true
},
"description": {
"type": "string",
"required": false
},
"variant": {
"type": "string",
"required": false
},
"metadataDefinitionId": {
"type": "long",
"required": true
},
"accountId": {
"type": "long",
"required": true
}
}
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Perform operations on a specific Group.
Returns Group object details.
Updates the group that the id belongs to.
Deletes the Group
get /groups/{groupId}
Returns Group object details.
URI Parameters
-
groupId: required (integer)
Group ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
put /groups/{groupId}
Updates the group that the id belongs to.
URI Parameters
-
groupId: required (integer)
Group ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"name": {
"type": "string",
"required": true
},
"description": {
"type": "string",
"required": false
},
"variant": {
"type": "string",
"required": false
},
"metadataDefinitionId": {
"type": "long",
"required": true
}
}
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
delete /groups/{groupId}
Deletes the Group
URI Parameters
-
groupId: required (integer)
Group ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns a list of actions that can be performed.
Performs an action. Possible action types are - enable, disable, delete, retry, destroy.
get /groups/{groupId}/actions
Returns a list of actions that can be performed.
URI Parameters
-
groupId: required (integer)
Group ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /groups/{groupId}/actions
Performs an action. Possible action types are - enable, disable, delete, retry, destroy.
URI Parameters
-
groupId: required (integer)
Group ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"action": {
"type": "string",
"required": true
}
}
}
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"name": {
"type": "string",
"required": false
},
"type": {
"type": "string",
"required": false
},
"variant": {
"type": "string",
"required": false
},
"enabled": {
"type": "boolean",
"required": false
},
"deleted": {
"type": "boolean",
"required": false
},
"href": {
"type": "string",
"required": false
},
"owner": {
"type": "string",
"required": false
}
}
}
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
A collection of comment.
Returns a list of Comments.
Adds a new Comment.
get /groups/{groupId}/comments
Returns a list of Comments.
URI Parameters
-
groupId: required (integer)
Group ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /groups/{groupId}/comments
Adds a new Comment.
URI Parameters
-
groupId: required (integer)
Group ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"message": {
"type": "string",
"required": true
}
}
}
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"message": {
"type": "string",
"required": false
},
"date": {
"type": "date",
"required": false
},
"user": {
"type": "object",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"name": {
"type": "string",
"required": false
},
"fullName": {
"type": "string",
"required": false
},
"enabled": {
"type": "boolean",
"required": false
},
"deleted": {
"type": "boolean",
"required": false
},
"href": {
"type": "string",
"required": false
},
"email": {
"type": "string",
"required": false
},
"variant": {
"type": "string",
"required": false
}
}
},
"parentObject": {
"type": "object",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"name": {
"type": "string",
"required": false
},
"type": {
"type": "string",
"required": false
},
"variant": {
"type": "string",
"required": false
},
"enabled": {
"type": "boolean",
"required": false
},
"deleted": {
"type": "boolean",
"required": false
},
"href": {
"type": "string",
"required": false
},
"owner": {
"type": "string",
"required": false
}
}
}
}
}
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Performs operations on a single Comment.
Returns a Comment.
get /groups/{groupId}/comments/{commentId}
Returns a Comment.
URI Parameters
-
groupId: required (integer)
Group ID
-
commentId: required (integer)
Comment ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Copies an existing Group.
post /groups/{groupId}/copy
Copies an existing Group.
URI Parameters
-
groupId: required (integer)
Group ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"name": {
"type": "string",
"required": true
},
"description": {
"type": "string",
"required": false
}
}
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
A collection of follower.
Returns a list of users that are following this object.
get /groups/{groupId}/followers
Returns a list of users that are following this object.
URI Parameters
-
groupId: required (integer)
Group ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
A collection of attachment.
Returns a list of attachments.
get /groups/{groupId}/attachments
Returns a list of attachments.
URI Parameters
-
groupId: required (integer)
Group ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
A collection of history.
Returns a list of events.
get /groups/{groupId}/history
Returns a list of events.
URI Parameters
-
groupId: required (integer)
Group ID
Query Parameters
- MatrixParam['objectId']: (integer - minimum: 0)
-
MatrixParam['objectType']: (string)
One or more objectTypes can be provided. This parameter can't be used when an objectId is already provided.
-
MatrixParam['accountId']: (string)
One or more accountId can be provided.
-
MatrixParam['severity']: (one of Info, Error, Warn)
One or more severities can be provided.
-
MatrixParam['eventType']: (string)
One or more eventTypes can be provided.
- MatrixParam['ownerId']: (integer - minimum: 0)
-
MatrixParam['from']: (date)
Last modified to date. Supported date formats are:
- dd MMM yyyy hh:mm:ss Z
- dd MMM yyyy hh:mm:ss
- dd MMM yyyy
- now (translated as current date and time)
-
MatrixParam['to']: (date)
Last modified to date. Supported date formats are:
- dd MMM yyyy hh:mm:ss Z
- dd MMM yyyy hh:mm:ss
- dd MMM yyyy
- now (translated as current date and time)
-
MatrixParam['attribute']: (string)
One or more attributes can be provided.
-
MatrixParam['value']: (string)
One or more values can be provided.
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
A collection of reference object links.
Returns a list of references.
get /groups/{groupId}/references
Returns a list of references.
URI Parameters
-
groupId: required (integer)
Group ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns the metadata of a specific group.
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.
get /groups/{groupId}/metadata
Returns the metadata of a specific group.
URI Parameters
-
groupId: required (integer)
Group ID
Headers
-
Accept: (string)
Method will return JSON by default, but will return XML if set to application/xml.
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
put /groups/{groupId}/metadata
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.
URI Parameters
-
groupId: required (integer)
Group ID
Headers
-
Accept: (string)
Method will return JSON by default, but will return XML if set to application/xml.
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+xml
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+xml
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
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.
Returns a list of users that are members of the specific role. Listing is based on supplied filters.
get /groups/{groupId}/members
Returns a list of users that are members of the specific role. Listing is based on supplied filters.
URI Parameters
-
groupId: required (integer)
Group ID
Query Parameters
- MatrixParam['name']: (string)
- MatrixParam['description']: (string)
- MatrixParam['enabled']: (boolean)
- MatrixParam['deleted']: (boolean - default: false)
- MatrixParam['account']: (string)
-
MatrixParam['exactNameMatch']: (string)
Pass it true if you want to search an Object using the exact name.
- MatrixParam['firstName']: (string)
- MatrixParam['lastName']: (string)
- MatrixParam['company']: (string)
- MatrixParam['roleId']: (integer - minimum: 0)
- MatrixParam['email']: (string)
- MatrixParam['accoundId']: (integer - minimum: 0)
- MatrixParam['variant']: (string)
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns a list of external IDs associated with an Account.
Creates new external ID.
get /groups/{groupId}/externalIds
Returns a list of external IDs associated with an Account.
URI Parameters
-
groupId: required (integer)
Group ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
},
"href": {
"type": "string"
}
},
"required": [
"key",
"value",
"href"
]
}
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /groups/{groupId}/externalIds
Creates new external ID.
URI Parameters
-
groupId: required (integer)
Group ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"key",
"value"
]
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns the details for a specific external ID.
Updates the Account/System Property
Deletes a specific external ID.
get /groups/{groupId}/externalIds/{key}
Returns the details for a specific external ID.
URI Parameters
-
groupId: required (integer)
Group ID
- key: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
put /groups/{groupId}/externalIds/{key}
Updates the Account/System Property
URI Parameters
-
groupId: required (integer)
Group ID
- key: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"properties": {
"value": {
"type": "string"
}
},
"required": [
"value"
]
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
delete /groups/{groupId}/externalIds/{key}
Deletes a specific external ID.
URI Parameters
-
groupId: required (integer)
Group ID
- key: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Jobs
This resource is used for viewing, creating and managing Jobs
Returns a list of Jobs. Listing is based on supplied filters
Create new Job for a given asset, action and configuration.
get /jobs
Returns a list of Jobs. Listing is based on supplied filters
Query Parameters
-
MatrixParam['searchText']: (string)
Search for occurrences of searchText in Name, Description, ID, Attachments, Comments and Metadata fields.
-
MatrixParam['owner']: (string - minLength: 1)
Owner user name
-
MatrixParam['variant']: (string - minLength: 1)
List of Variants
-
MatrixParam['excludedVariants']: (string - minLength: 1)
List of Variants
-
MatrixParam['createdFrom']: (date)
Created from date. Supported date formats are:
- dd MMM yyyy hh:mm:ss Z
- dd MMM yyyy hh:mm:ss
- dd MMM yyyy
- now (translated as current date and time)
-
MatrixParam['createdTo']: (date)
Created to date. Supported date formats are:
- dd MMM yyyy hh:mm:ss Z
- dd MMM yyyy hh:mm:ss
- dd MMM yyyy
- now (translated as current date and time)
-
MatrixParam['lastModifiedFrom']: (date)
Last modified from date. Supported date formats are:
- dd MMM yyyy hh:mm:ss Z
- dd MMM yyyy hh:mm:ss
- dd MMM yyyy
- now (translated as current date and time)
-
MatrixParam['lastModifiedTo']: (date)
Last modified to date. Supported date formats are:
- dd MMM yyyy hh:mm:ss Z
- dd MMM yyyy hh:mm:ss
- dd MMM yyyy
- now (translated as current date and time)
-
MatrixParam['enabled']: (one of true, false, all)
Enabled flag
-
MatrixParam['deleted']: (one of true, false, all)
Deleted flag
-
MatrixParam['approved']: (one of true, false, all)
Approved flag
-
MatrixParam['accountId']: (number)
You can list multiple Account Ids separated by a colon, e.g. aId=1; aId=2;
-
MatrixParam['workspaceId']: (number)
You can list multiple Workspace Ids separated by a colon, e.g. wsId=1; wsId=2;
-
MatrixParam['metadataDefinitionId']: (number)
Metadata Definition Id
-
MatrixParam['includeNoVariant']: (boolean)
Includes Objects that do not have a Variant.
- MatrixParam['includeData']: (boolean)
-
MatrixParam['parentId’]: (number)
Returns a list of parent Ids. Please note that this matrix parameter can only be used if the parent is a user defined object.
-
MatrixParam['includeVariables']: (boolean)
Whether or not to include the Variables of Workflows or Jobs in the response.
- MatrixParam['ancestorId']: (number)
- MatrixParam['level']: (number)
- MatrixParam['objectType']: (string)
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['externalId']: (string)
Search for an object via its endpoint (e.g. assets, workflows) and specify the external ID key and value, e.g. For example /api/assets;externalId=key:value
-
MatrixParam['status']: (one of Scheduled, Pending, Queued, WaitingForLock, Running, Completed, Cancelled, Failed, TimedOut)
One or more statuses can be provided.
-
MatrixParam['id']: (string)
Filtering by multiple Ids.Example- /api/jobs;id=1234;id=2345;id=3456
-
MatrixParam['actionType']: (string)
The action type.
-
MatrixParam['actionId']: (integer)
Specifying actionId requires that actionType is also specified.
-
MatrixParam['jobType']: (one of Single, Group)
The job type
-
MatrixParam['priority']: (one of Highest, High, Normal, Low, Lowest)
The priority of the job.
-
MatrixParam['skipCount']: (boolean)
This parameter skips the count query execution when fetching a record.
-
MatrixParam['scheduledDateFrom']: (date)
Search for a specific scheduled date from the given date. Supported date formats are:
- dd MMM yyyy hh:mm:ss Z
- dd MMM yyyy hh:mm:ss
- dd MMM yyyy
- now (translated as current date and time)
-
MatrixParam['scheduledDateTo']: (date)
Search for a specific scheduled date to the given date. Supported date formats are:
- dd MMM yyyy hh:mm:ss Z
- dd MMM yyyy hh:mm:ss
- dd MMM yyyy
- now (translated as current date and time)
-
MatrixParam['startDateFrom']: (date)
Search for a specific start date from the given date. Supported date formats are:
- dd MMM yyyy hh:mm:ss Z
- dd MMM yyyy hh:mm:ss
- dd MMM yyyy
- now (translated as current date and time)
-
MatrixParam['startDateTo']: (date)
Search for a specific start date to the given date. Supported date formats are:
- dd MMM yyyy hh:mm:ss Z
- dd MMM yyyy hh:mm:ss
- dd MMM yyyy
- now (translated as current date and time)
-
MatrixParam['EndDateFrom']: (date)
Search for a specific end date from the given date. Supported date formats are:
- dd MMM yyyy hh:mm:ss Z
- dd MMM yyyy hh:mm:ss
- dd MMM yyyy
- now (translated as current date and time)
-
MatrixParam['EndDateTo']: (date)
Search for a specific end date to the given date. Supported date formats are:
- dd MMM yyyy hh:mm:ss Z
- dd MMM yyyy hh:mm:ss
- dd MMM yyyy
- now (translated as current date and time)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /jobs
Create new Job for a given asset, action and configuration.
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"actionId": {
"type": "integer",
"required": true
},
"assetId": {
"type": "integer",
"required": false
},
"actionConfigId": {
"type": "integer",
"required": false
},
"jobConfiguration ": {
"type": "string",
"required": false
},
"scheduleDate": {
"type": "date",
"required": false
},
"priority": {
"type": "string",
"required": false
},
"contextExpression": {
"type": "string",
"required": false
},
"accountId": {
"type": "integer",
"required": false
},
"workspaceId": {
"type": "integer",
"required": false
}
}
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"name": {
"type": "string",
"required": false
},
"type": {
"type": "string",
"required": false
},
"variant": {
"type": "string",
"required": false
},
"enabled": {
"type": "boolean",
"required": false
},
"deleted": {
"type": "boolean",
"required": false
},
"href": {
"type": "string",
"required": false
},
"owner": {
"type": "string",
"required": false
}
}
}
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
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.
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 /jobs/{jobId}
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.
URI Parameters
-
jobId: required (integer)
Job ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Returns a list of actions that can be performed.
Performs an action. Possible action types are - enable, disable, start, stop, delete, retry, cancel, schedule, approve, unapprove, destroy.
get /jobs/{jobId}/actions
Returns a list of actions that can be performed.
URI Parameters
-
jobId: required (integer)
Job ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /jobs/{jobId}/actions
Performs an action. Possible action types are - enable, disable, start, stop, delete, retry, cancel, schedule, approve, unapprove, destroy.
URI Parameters
-
jobId: required (integer)
Job ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"action": {
"type": "string",
"required": true
}
}
}
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"name": {
"type": "string",
"required": false
},
"type": {
"type": "string",
"required": false
},
"variant": {
"type": "string",
"required": false
},
"enabled": {
"type": "boolean",
"required": false
},
"deleted": {
"type": "boolean",
"required": false
},
"href": {
"type": "string",
"required": false
},
"owner": {
"type": "string",
"required": false
}
}
}
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
A collection of history.
Returns a list of events.
get /jobs/{jobId}/history
Returns a list of events.
URI Parameters
-
jobId: required (integer)
Job ID
Query Parameters
- MatrixParam['objectId']: (integer - minimum: 0)
-
MatrixParam['objectType']: (string)
One or more objectTypes can be provided. This parameter can't be used when an objectId is already provided.
-
MatrixParam['accountId']: (string)
One or more accountId can be provided.
-
MatrixParam['severity']: (one of Info, Error, Warn)
One or more severities can be provided.
-
MatrixParam['eventType']: (string)
One or more eventTypes can be provided.
- MatrixParam['ownerId']: (integer - minimum: 0)
-
MatrixParam['from']: (date)
Last modified to date. Supported date formats are:
- dd MMM yyyy hh:mm:ss Z
- dd MMM yyyy hh:mm:ss
- dd MMM yyyy
- now (translated as current date and time)
-
MatrixParam['to']: (date)
Last modified to date. Supported date formats are:
- dd MMM yyyy hh:mm:ss Z
- dd MMM yyyy hh:mm:ss
- dd MMM yyyy
- now (translated as current date and time)
-
MatrixParam['attribute']: (string)
One or more attributes can be provided.
-
MatrixParam['value']: (string)
One or more values can be provided.
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Perform a callback on the specified resource.
post /jobs/{jobId}/callbacks
URI Parameters
-
jobId: required (integer)
Job ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Set or get the job metadata.
Returns the job configuration including a href to the configuration.
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.
Create a new Metadata Definition
get /jobs/{jobId}/configuration
Returns the job configuration including a href to the configuration.
URI Parameters
-
jobId: required (integer)
Job ID
Headers
-
Accept: (string)
Method will return JSON by default, but will return XML if set to application/xml.
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
put /jobs/{jobId}/configuration
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.
URI Parameters
-
jobId: required (integer)
Job ID
Headers
-
Accept: (string)
Method will return JSON by default, but will return XML if set to application/xml.
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+xml
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+xml
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /jobs/{jobId}/configuration
Create a new Metadata Definition
URI Parameters
-
jobId: required (integer)
Job ID
Headers
-
Accept: (string)
Method will return JSON by default, but will return XML if set to application/xml.
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"jobConfiguration": {
"type": "string",
"required": false
}
}
}
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Metadata Definitions
Perform operations on Metadata Definitions
Returns a list of Metadata Definitions. Listing is based on supplied filters.
Create a new Metadata Definition.
get /metadataDefinitions
Returns a list of Metadata Definitions. Listing is based on supplied filters.
Query Parameters
- MatrixParam['name']: (string)
- MatrixParam['description']: (string)
- MatrixParam['enabled']: (boolean)
- MatrixParam['deleted']: (boolean - default: false)
- MatrixParam['account']: (string)
-
MatrixParam['exactNameMatch']: (string)
Pass it true if you want to search an Object using the exact name.
-
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
-
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
- MatrixParam['sort']: (string)
-
MatrixParam['sortBy']: (string)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['externalId']: (string)
Search for an object via its endpoint (e.g. assets, workflows) and specify the external ID key and value, e.g. For example /api/assets;externalId=key:value
-
MatrixParam['context']: (string)
This query parameter enables you to retrieve a list of objects with references. For example if you wanted to retrieve a list of metadata definitions with references, you would do the following /api/metadataDefinitions?context=reference.
-
MatrixParam['skipCount']: (boolean)
This parameter skips the count query execution when fetching a record.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
post /metadataDefinitions
Create a new Metadata Definition.
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"name": {
"type": "string",
"required": true
},
"description": {
"type": "string",
"required": false
},
"visibilityIds": {
"type": "array",
"items": {
"type": "long"
},
"minItems": 0,
"uniqueItems": true,
"required": true
}
}
}
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"name": {
"type": "string",
"required": false
},
"type": {
"type": "string",
"required": false
},
"variant": {
"type": "string",
"required": false
},
"enabled": {
"type": "boolean",
"required": false
},
"deleted": {
"type": "boolean",
"required": false
},
"href": {
"type": "string",
"required": false
},
"owner": {
"type": "string",
"required": false
}
}
}
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 400
Invalid input.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
HTTP status code 500
Server error.
Perform operations on a specific Metadata Definition.
Returns the details of the Metadata Definition.