Dalet Flex Core
version 7.1.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). While it is not possible to retrieve the full storage location of the Asset via API calls, you can use this endpoint to retrieve the Asset file's originalFileName
and its currentLocation
(for example, the asset location file path on Azure in the response - /ooflexdev.blob.core.windows.net/.../e9f3859c-1821-44a7-a3b5-2c4086f6410c.jpg
). You can also list multiple assets by entering a list of Asset ids separated by a semicolon e.g /api/assets;id=1234;id=2345;id=3456
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). While it is not possible to retrieve the full storage location of the Asset via API calls, you can use this endpoint to retrieve the Asset file's originalFileName
and its currentLocation
(for example, the asset location file path on Azure in the response - /ooflexdev.blob.core.windows.net/.../e9f3859c-1821-44a7-a3b5-2c4086f6410c.jpg
). You can also list multiple assets by entering a list of Asset ids separated by a semicolon e.g /api/assets;id=1234;id=2345;id=3456
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
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
Example:
{
"id": 134633,
"uuid": "7e911477-0bad-4620-9f86-29573091dd34",
"name": "HSS-working.jpg",
"displayName": "HSS-working.jpg",
"size": 143453,
"objectType": {
"id": 3,
"name": "image-asset",
"href": "http://masteraccount.local.nativ.tv:30044/api/objectTypes/3",
"displayName": "Image Asset",
"pluralName": "Image Assets",
"userDefined": false,
"attachmentsSupported": true,
"commentsSupported": true,
"objectDataSupported": false,
"contentMetadataSupported": true,
"metadataSupported": true
},
"externalIds": [],
"isGroup": false,
"href": "http://masteraccount.local.nativ.tv:30044/api/assets/134633",
"owner": {
"id": 5,
"name": "masteruser",
"displayName": "masteruser masteruser",
"href": "http://masteraccount.local.nativ.tv:30044/api/users/5",
"email": "rdoshi1@asite.com",
"accountId": 4
},
"assetOrigin": "Ingest",
"approved": false,
"fileInformation": {
"originalFileName": "HSS-working.jpg",
"currentLocation": "azbs://ooflexdev.blob.core.windows.net/flex-azure-demo/ashok/one/e9f3859c-1821-44a7-a3b5-2c4086f6410c.jpg",
"currentFileName": "e9f3859c-1821-44a7-a3b5-2c4086f6410c.jpg",
"mimeType": "image/jpeg",
"ingestPath": "file://c:/dev/temp/master/workflow/59f0d160-7e00-4835-acf9-d5f1e7b1346c.jpg",
"resource": {
"id": 129502,
"uuid": "b2ae7cf6-c588-420e-9dcf-26c1933ac5eb",
"name": "azure folder itv",
"displayName": "azure folder itv",
"objectType": {
"id": 15,
"name": "resource",
"href": "http://masteraccount.local.nativ.tv:30044/api/objectTypes/15",
"displayName": "Resource",
"pluralName": "Resources",
"userDefined": false,
"attachmentsSupported": false,
"commentsSupported": false,
"objectDataSupported": false,
"contentMetadataSupported": false,
"metadataSupported": false
},
"href": "http://masteraccount.local.nativ.tv:30044/api/resources/129502",
"enabled": true,
"owner": "itvadmin",
"accountId": 119182,
"created": "01 May 2018 15:25:02 +0530",
"lastModified": "30 May 2018 12:34:44 +0530"
}
},
"assetContext": {
"type": "ImageContext",
"fileSize": 0,
"imageFormat": "JPEG",
"width": 897,
"height": 504,
"widthResolution": -1,
"heightResolution": -1,
"bitsPerPixel": 24,
"compressionScheme": "JPEG",
"compressionLevel": "Unknown",
"colorMode": "RGB"
},
"exists": true,
"deleted": false,
"purged": false,
"archived": false,
"created": "11 Jul 2018 16:13:52 +0530",
"published": false,
"live": false,
"locked": false,
"lastModified": "11 Jul 2018 16:13:52 +0530",
"account": {
"id": 4,
"name": "Master Account",
"displayName": "Master Account",
"objectType": {
"id": 24,
"name": "master-account",
"href": "http://masteraccount.local.nativ.tv:30044/api/objectTypes/24",
"displayName": "Master Account",
"pluralName": "Master Accounts",
"userDefined": false,
"attachmentsSupported": false,
"commentsSupported": false,
"objectDataSupported": false,
"contentMetadataSupported": false,
"metadataSupported": false
},
"enabled": true,
"owner": "masteruser masteruser",
"ownerId": 5,
"accountId": 4,
"created": "10 Jun 2015 10:26:05 +0530",
"lastModified": "12 Dec 2017 17:14:58 +0530",
"workspace": {
"id": 3,
"name": "Master Account",
"displayName": "Master Account",
"accountId": 4,
"href": "http://masteraccount.local.nativ.tv:30044/api/workspaces/3"
}
},
"workspace": {
"id": 3,
"name": "Master Account",
"displayName": "Master Account",
"objectType": {
"id": 30,
"name": "account-workspace",
"href": "http://masteraccount.local.nativ.tv:30044/api/objectTypes/30",
"displayName": "Account Workspace",
"pluralName": "Account Workspaces",
"userDefined": false,
"attachmentsSupported": false,
"commentsSupported": false,
"objectDataSupported": false,
"contentMetadataSupported": false,
"metadataSupported": false
},
"enabled": true,
"owner": "masteruser masteruser",
"ownerId": 5,
"accountId": 4,
"created": "10 Jun 2015 10:26:05 +0530",
"lastModified": "03 Oct 2017 11:44:30 +0530"
}
}
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.
Enables a user to post a single annotation on a timeline. When specifying an originatorContext you can enter MioAssetReview, QCReport, or leave the field empty.
get /assets/{assetId}/annotations
Returns a list of existing annotations made against a timeline.
URI Parameters
-
assetId: required (integer)
Asset ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['type']: (string)
Filter all annotations and return just the annotations of the specified type -
comment
,image
, ormetadata
. For example -~/assets/{assetId}/annotations;type=comment
- filter all annotations and return just the annotations of typeMioTimelineComment
;~/assets/{assetId}/annotations;type=image
- filter all annotations and return just the annotations of typeMioImageAnnotation
;~/assets/{assetId}/annotations;type=metadata
- filter all annotations and return just the annotations of typeMetadataAnnotation
. -
MatrixParam['ownerIds']: (string)
Filter all annotations and return just the annotations that have the requested owner ids. For example -
~/assets/${assetId}/annotations;ownerIds=27790,27791,27793
HTTP status code 200
Request has been processed successfully.
Body
Type: application/vnd.nativ.mio.v1+json
Example:
{
"_comment": "This is a metadata annotation type search call for a media asset.",
"_comment": "API call: ~/assets/<media-asset-id>/annotations;type=metadata. Method Type: GET.",
"totalCount": 1,
"limit": 100,
"offset": 0,
"annotations": [
{
"type": "MetadataAnnotation",
"id": 142309,
"creationDate": "28 Aug 2018 06:26:16 +0000",
"owner": {
"id": 10249,
"uuid": "b0ffb54f-9a7b-498a-a493-c12b4f610f6f",
"name": "achalshah",
"displayName": "Achal B Shah",
"href": "https://accountb.qa1.ooflex.net/api/users/10249",
"email": "achalshah@asite.com",
"accountId": 10329
},
"assetId": 168569,
"originatorContext": "Timeline",
"originatorCorrelationId": 4040,
"subjectContext": "MioAsset",
"subjectCorrelationId": 168569,
"href": "https://accountb.qa1.ooflex.net/api/assets/168569/annotations/142309",
"timestampIn": 3492540,
"timestampOut": 5567605,
"metadata": {
"id": 24084085,
"instance": {
"new-text-2": "test1",
"new-complex-3": {}
},
"definitionId": 374486,
"metadataDefinition": {
"id": 62548,
"uuid": "20d2ccc8-961a-4b25-aeba-4d8594cba92a",
"name": "Basic",
"displayName": "Basic",
"objectType": {
"id": 12,
"name": "metadata-definition",
"href": "https://accountb.qa1.ooflex.net/api/objectTypes/12",
"displayName": "Metadata Definition",
"pluralName": "Metadata Definitions",
"userDefined": false,
"attachmentsSupported": true,
"commentsSupported": true,
"objectDataSupported": false,
"contentMetadataSupported": false,
"metadataSupported": false
},
"href": "https://accountb.qa1.ooflex.net/api/metadataDefinitions/62548",
"enabled": true,
"owner": "Achal B Shah",
"ownerId": 10249,
"accountId": 10329,
"created": "15 Mar 2018 08:13:06 +0000",
"lastModified": "26 Jul 2018 10:10:51 +0000"
}
},
"canDelete": false
}
]
}
{
"_comment": "This is an image annotation type search call for a media asset.",
"_comment": "API call: ~/assets/<media-asset-id>/annotations;type=image. Method Type: GET.",
"totalCount": 2,
"limit": 100,
"offset": 0,
"annotations": [
{
"type": "ImageAnnotation",
"id": 142208,
"creationDate": "28 Aug 2018 06:09:25 +0000",
"owner": {
"id": 10249,
"uuid": "b0ffb54f-9a7b-498a-a493-c12b4f610f6f",
"name": "achalshah",
"displayName": "Achal B Shah",
"href": "https://accountb.qa1.ooflex.net/api/users/10249",
"email": "achalshah@asite.com",
"accountId": 10329
},
"assetId": 168570,
"originatorContext": null,
"originatorCorrelationId": null,
"subjectContext": "MioAsset",
"subjectCorrelationId": 168570,
"href": "https://accountb.qa1.ooflex.net/api/assets/168570/annotations/142208",
"timestampIn": null,
"timestampOut": null,
"canDelete": false,
"comment": "Image Annotation comment",
"annotations": [
{
"type": "rectangle",
"color": null,
"x": 22.120831298828126,
"y": 25.697216796875,
"width": 23,
"height": 25.6
},
{
"type": "rectangle",
"color": null,
"x": 57.920831298828126,
"y": 25.497216796875,
"width": 24.8,
"height": 20.8
}
]
},
{
"type": "ImageAnnotation",
"id": 142814,
"creationDate": "30 Aug 2018 12:40:45 +0000",
"owner": {
"id": 10249,
"uuid": "b0ffb54f-9a7b-498a-a493-c12b4f610f6f",
"name": "achalshah",
"displayName": "Achal B Shah",
"href": "https://accountb.qa1.ooflex.net/api/users/10249",
"email": "achalshah@asite.com",
"accountId": 10329
},
"assetId": 168570,
"originatorContext": null,
"originatorCorrelationId": null,
"subjectContext": "MioAsset",
"subjectCorrelationId": 168570,
"href": "https://accountb.qa1.ooflex.net/api/assets/168570/annotations/142814",
"timestampIn": null,
"timestampOut": null,
"canDelete": false,
"comment": "test2\n",
"annotations": [
{
"type": "rectangle",
"color": null,
"x": 57.800689697265625,
"y": 57.599999999999994,
"width": 39.2,
"height": 34
},
{
"type": "rectangle",
"color": null,
"x": 42.46041564941406,
"y": 13.148611068725586,
"width": 53.5,
"height": 10.4
},
{
"type": "rectangle",
"color": null,
"x": 13.160415649414062,
"y": 18.848611068725585,
"width": 27.6,
"height": 15.4
},
{
"type": "rectangle",
"color": null,
"x": 7.560415649414062,
"y": 60.24861106872559,
"width": 14.2,
"height": 22.400000000000002
},
{
"type": "rectangle",
"color": null,
"x": 62.00068969726562,
"y": 26.8,
"width": 19,
"height": 19.2
},
{
"type": "rectangle",
"color": null,
"x": 26.000689697265628,
"y": 39,
"width": 18.6,
"height": 17.8
}
]
}
]
}
{
"_comment": "This is a comment annotation type search call for a media asset.",
"_comment": "API call: ~/assets/<media-asset-id>/annotations;type=comment. Method Type: GET.",
"totalCount": 4,
"limit": 100,
"offset": 0,
"annotations": [
{
"type": "TimelineComment",
"id": 142414,
"creationDate": "28 Aug 2018 10:15:26 +0000",
"owner": {
"id": 10249,
"uuid": "b0ffb54f-9a7b-498a-a493-c12b4f610f6f",
"name": "achalshah",
"displayName": "Achal B Shah",
"href": "https://accountb.qa1.ooflex.net/api/users/10249",
"email": "achalshah@asite.com",
"accountId": 10329
},
"assetId": 168569,
"originatorContext": null,
"originatorCorrelationId": null,
"subjectContext": "MioAsset",
"subjectCorrelationId": 168569,
"href": "https://accountb.qa1.ooflex.net/api/assets/168569/annotations/142414",
"timestampIn": 0,
"timestampOut": 0,
"comment": "MAM1",
"canDelete": false
},
{
"type": "TimelineComment",
"id": 142213,
"creationDate": "28 Aug 2018 06:39:51 +0000",
"owner": {
"id": 159784,
"uuid": "0523e697-aecc-4c6b-a476-ca867532e048",
"name": "jignadabhi",
"displayName": "Jigna Dabhi",
"href": "https://accountb.qa1.ooflex.net/api/users/159784",
"email": "jdabhi@asite.com",
"accountId": 10329
},
"assetId": 168569,
"originatorContext": null,
"originatorCorrelationId": null,
"subjectContext": "MioAsset",
"subjectCorrelationId": 168569,
"href": "https://accountb.qa1.ooflex.net/api/assets/168569/annotations/142213",
"timestampIn": 0,
"timestampOut": 0,
"comment": "JD",
"canDelete": true
},
{
"type": "TimelineComment",
"id": 142210,
"creationDate": "28 Aug 2018 06:25:33 +0000",
"owner": {
"id": 10249,
"uuid": "b0ffb54f-9a7b-498a-a493-c12b4f610f6f",
"name": "achalshah",
"displayName": "Achal B Shah",
"href": "https://accountb.qa1.ooflex.net/api/users/10249",
"email": "achalshah@asite.com",
"accountId": 10329
},
"assetId": 168569,
"originatorContext": null,
"originatorCorrelationId": null,
"subjectContext": "MioAsset",
"subjectCorrelationId": 168569,
"href": "https://accountb.qa1.ooflex.net/api/assets/168569/annotations/142210",
"timestampIn": 304,
"timestampOut": 304,
"comment": "ashish1",
"canDelete": false
},
{
"type": "TimelineComment",
"id": 142211,
"creationDate": "28 Aug 2018 06:25:52 +0000",
"owner": {
"id": 10249,
"uuid": "b0ffb54f-9a7b-498a-a493-c12b4f610f6f",
"name": "achalshah",
"displayName": "Achal B Shah",
"href": "https://accountb.qa1.ooflex.net/api/users/10249",
"email": "achalshah@asite.com",
"accountId": 10329
},
"assetId": 168569,
"originatorContext": null,
"originatorCorrelationId": null,
"subjectContext": "MioAsset",
"subjectCorrelationId": 168569,
"href": "https://accountb.qa1.ooflex.net/api/assets/168569/annotations/142211",
"timestampIn": 3492540,
"timestampOut": 5567605,
"comment": "ashish2",
"canDelete": false
}
]
}
{
"_comment": "This is an annotation search call for media assets with the requested owner ids.",
"_comment": "API call: ~/assets/<media-asset-id>/annotations;ownerIds=10204,10205. Method Type: GET.",
"totalCount": 2,
"limit": 100,
"offset": 0,
"annotations": [
{
"type": "MetadataAnnotation",
"id": 103230,
"creationDate": "06 Sep 2018 16:17:28 +0530",
"owner": {
"id": 10204,
"uuid": "7391cc04-1066-4a22-ae9a-a0c1bdd133d9",
"name": "hbzoomin",
"displayName": "Hardik bhow",
"href": "http://zoomin.local.nativ.tv:30044/api/users/10204",
"email": "ashish@gmail.com",
"accountId": 10202
},
"assetId": 14750,
"originatorContext": "Timeline",
"originatorCorrelationId": 207,
"subjectContext": "MioAsset",
"subjectCorrelationId": 14750,
"href": "http://zoomin.local.nativ.tv:30044/api/assets/14750/annotations/103230",
"timestampIn": 223456,
"timestampOut": 134567,
"metadata": {
"id": 103732,
"instance": {
"name1": "rrrr",
"name2": "jj",
"complex1": {
"complex2": {
"number4": 13
}
}
},
"definitionId": 105744,
"metadataDefinition": {
"id": 14748,
"uuid": "101d1bf3-c0ca-46ee-8cf0-ee1b0ea1d9e8",
"name": "Test1",
"displayName": "Test1",
"objectType": {
"id": 12,
"name": "metadata-definition",
"href": "http://zoomin.local.nativ.tv:30044/api/objectTypes/12",
"displayName": "Metadata Definition",
"pluralName": "Metadata Definitions",
"userDefined": false,
"attachmentsSupported": true,
"commentsSupported": true,
"objectDataSupported": false,
"contentMetadataSupported": false,
"metadataSupported": false
},
"href": "http://zoomin.local.nativ.tv:30044/api/metadataDefinitions/14748",
"enabled": true,
"owner": "Hardik bhow",
"ownerId": 10204,
"accountId": 10202,
"created": "04 Sep 2018 12:39:32 +0530",
"lastModified": "04 Sep 2018 12:58:32 +0530"
}
},
"canDelete": false
},
{
"type": "MetadataAnnotation",
"id": 103231,
"creationDate": "06 Sep 2018 16:43:55 +0530",
"owner": {
"id": 10205,
"uuid": "7391cc04-1066-4a22-ae9a-a0c1bdd133d9",
"name": "hbzoomin",
"displayName": "Hardik bhow",
"href": "http://zoomin.local.nativ.tv:30044/api/users/10204",
"email": "ashish@gmail.com",
"accountId": 10202
},
"assetId": 14750,
"originatorContext": "Timeline",
"originatorCorrelationId": 207,
"subjectContext": "MioAsset",
"subjectCorrelationId": 14750,
"href": "http://zoomin.local.nativ.tv:30044/api/assets/14750/annotations/103231",
"timestampIn": 223456,
"timestampOut": 134567,
"metadata": {
"id": 103739,
"instance": {
"name1": "Dalet",
"complex1": {
"complex2": {
"number4": 12
}
}
},
"definitionId": 105744,
"metadataDefinition": {
"id": 14748,
"uuid": "101d1bf3-c0ca-46ee-8cf0-ee1b0ea1d9e8",
"name": "Test1",
"displayName": "Test1",
"objectType": {
"id": 12,
"name": "metadata-definition",
"href": "http://zoomin.local.nativ.tv:30044/api/objectTypes/12",
"displayName": "Metadata Definition",
"pluralName": "Metadata Definitions",
"userDefined": false,
"attachmentsSupported": true,
"commentsSupported": true,
"objectDataSupported": false,
"contentMetadataSupported": false,
"metadataSupported": false
},
"href": "http://zoomin.local.nativ.tv:30044/api/metadataDefinitions/14748",
"enabled": true,
"owner": "Hardik bhow",
"ownerId": 10204,
"accountId": 10202,
"created": "04 Sep 2018 12:39:32 +0530",
"lastModified": "04 Sep 2018 12:58:32 +0530"
}
},
"canDelete": 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.
post /assets/{assetId}/annotations
Enables a user to post a single annotation on a timeline. When specifying an originatorContext you can enter MioAssetReview, QCReport, or leave the field empty.
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.
Updates an existing comment (annotation).
Deletes an existing annotation.
put /assets/{assetId}/annotations/{annotationId}
Updates an existing comment (annotation).
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.
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.
Enables a user to post one or more annotations on a timeline in MAM. When you post multiple annotations simultaneously, all annotations must be placed within a single array. Please also take note, that when you specify an originatorContext you can enter MioAssetReview, QCReport, or leave the field empty.
post /assets/{assetId}/annotations/bulk
Enables a user to post one or more annotations on a timeline in MAM. When you post multiple annotations simultaneously, all annotations must be placed within a single array. Please also take note, that when you specify an originatorContext you can enter MioAssetReview, QCReport, or leave the field empty.
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.
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.
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. FlexREVIEW now enables exclusive reviews - when such a session is taken by a user, it cannot be assigned to another user unless it is released. If the review session specified in the request is exclusive AND a user has taken the review session, the response will include an exclusiveReviewer
section. This section will NOT be included in the API response if the review session is released (ended or not taken). The possible actions returned in the response, depending on the type of the review session and the current user's permissions, are DOWNLOADED
, WATCHED
, APPROVE
, TAKE
, and RELEASE
.
Enables a user to take action on a review session they are assigned to. The possible actions are DOWNLOADED
, WATCHED
, and APPROVE
. In addition, FlexREVIEW now enables exclusive reviews (when an exclusive review session is taken by a user, it cannot be assigned to another user unless it is released). A review session can only be defined as exclusive or not during its creation. If the review session is exclusive and the current user has sufficient user permissions, two more possible actions are also TAKE
(if the specified review session is exclusive and is not taken, this action enables the current user to take the review session exclusively) and RELEASE
(if the specified review session is taken by the current user, this action unassigns the current user from the exclusive review session and releases that session as available for taking by another user or by the same one again). Please note that all action
values must be capitalized in the POST request. For example, a request for endpoint /api/assets/10105/reviews/102313/actions
with { "action":"TAKE" }
in the request body will assign the exclusive review session with id 102313 to the current user. The TAKE
and RELEASE
actions are only available if the specified review session was created as exclusive AND your user permissions are sufficient (Permissions > Access > Roles > Permissions from the UI). You can force the release of a review session both via the UI and also via the API - if you have the correct permissions for that, there is no need for the review session to have been taken in order to be released. IMPORTANT - if a user is disabled in the system, all exclusive review sessions taken by that user will be released. If the specified review session is exclusive and is taken by the current user, when the current user finishes the review the review will get released. If an exclusive review session is approved, this will automatically release the session if it has been blocked.
get /assets/{assetId}/reviews/{reviewId}/actions
Returns the list of actions available to a user in a specific review session. FlexREVIEW now enables exclusive reviews - when such a session is taken by a user, it cannot be assigned to another user unless it is released. If the review session specified in the request is exclusive AND a user has taken the review session, the response will include an exclusiveReviewer
section. This section will NOT be included in the API response if the review session is released (ended or not taken). The possible actions returned in the response, depending on the type of the review session and the current user's permissions, are DOWNLOADED
, WATCHED
, APPROVE
, TAKE
, and RELEASE
.
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.
Body
Type: application/json
Example:
[
{
"action": "WATCHED"
},
{
"action": "DOWNLOADED"
},
{
"action": "RELEASE"
}
]
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
Enables a user to take action on a review session they are assigned to. The possible actions are DOWNLOADED
, WATCHED
, and APPROVE
. In addition, FlexREVIEW now enables exclusive reviews (when an exclusive review session is taken by a user, it cannot be assigned to another user unless it is released). A review session can only be defined as exclusive or not during its creation. If the review session is exclusive and the current user has sufficient user permissions, two more possible actions are also TAKE
(if the specified review session is exclusive and is not taken, this action enables the current user to take the review session exclusively) and RELEASE
(if the specified review session is taken by the current user, this action unassigns the current user from the exclusive review session and releases that session as available for taking by another user or by the same one again). Please note that all action
values must be capitalized in the POST request. For example, a request for endpoint /api/assets/10105/reviews/102313/actions
with { "action":"TAKE" }
in the request body will assign the exclusive review session with id 102313 to the current user. The TAKE
and RELEASE
actions are only available if the specified review session was created as exclusive AND your user permissions are sufficient (Permissions > Access > Roles > Permissions from the UI). You can force the release of a review session both via the UI and also via the API - if you have the correct permissions for that, there is no need for the review session to have been taken in order to be released. IMPORTANT - if a user is disabled in the system, all exclusive review sessions taken by that user will be released. If the specified review session is exclusive and is taken by the current user, when the current user finishes the review the review will get released. If an exclusive review session is approved, this will automatically release the session if it has been blocked.
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.
post /assets/{assetId}/reviews/{reviewId}/annotations
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.
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.
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.
Returns a list of object hierarchies for the specified media asset. You can use two optional matrix parameters in the request for this endpoint - context
and level
. For example context=upward
is used to request the upward hierarchy for the asset, and level
specifies the number of levels (parents) in the object hierarchy (up to 6). The response should have the following fields - id
, name
, displayName
, objectType
, and a list of parent group assets. Example - /api/assets/31315/hierarchy;context=upward;level=2
get /assets/{assetId}/hierarchy
Returns a list of object hierarchies for the specified media asset. You can use two optional matrix parameters in the request for this endpoint - context
and level
. For example context=upward
is used to request the upward hierarchy for the asset, and level
specifies the number of levels (parents) in the object hierarchy (up to 6). The response should have the following fields - id
, name
, displayName
, objectType
, and a list of parent group assets. Example - /api/assets/31315/hierarchy;context=upward;level=2
URI Parameters
-
assetId: required (integer)
Asset ID
Query Parameters
-
MatrixParam['context']: (string)
The defaut setting
context=upward
is used to get the list of hierarchical parents for the specified asset id. -
MatrixParam['level']: (integer)
Set the value of the
level
parameter to an integer between 1 and 6 to get the parent hierarchy up to the respective level. For example,/api/assets/31315/hierarchy;context=upward;level=4
will return 4 levels up of parent group assets for an asset with id 31315. This parameter is optional - if it is not included in the request, or if its specified value is higher than 6, the default value of 6 hierarchy levels up will be applied in the response.
HTTP status code 200
Body
Type: application/vnd.nativ.mio.v1+json
Example:
{
"id": 31315,
"name": "child-media-asset",
"displayName": "child-media-asset",
"objectType": {
"id": 1,
"name": "media-asset",
"href": "http://masteraccount.local.nativ.tv:30044/api/objectTypes/1",
"displayName": "Media Asset",
"pluralName": "Media Assets",
"userDefined": false,
"attachmentsSupported": true,
"commentsSupported": true,
"objectDataSupported": false,
"contentMetadataSupported": true,
"metadataSupported": true
},
"parentAssetGroups": [
{
"id": 31314,
"name": "GC2",
"displayName": "GC2",
"objectType": {
"id": 2,
"name": "group-asset",
"href": "http://masteraccount.local.nativ.tv:30044/api/objectTypes/2",
"displayName": "Group Asset",
"pluralName": "Group Assets",
"userDefined": false,
"attachmentsSupported": true,
"commentsSupported": true,
"objectDataSupported": false,
"contentMetadataSupported": true,
"metadataSupported": true
},
"parentAssetGroups": [
{
"id": 31312,
"name": "G1",
"displayName": "G1",
"objectType": {
"id": 2,
"name": "group-asset",
"href": "http://masteraccount.local.nativ.tv:30044/api/objectTypes/2",
"displayName": "Group Asset",
"pluralName": "Group Assets",
"userDefined": false,
"attachmentsSupported": true,
"commentsSupported": true,
"objectDataSupported": false,
"contentMetadataSupported": true,
"metadataSupported": true
},
"href": "http://masteraccount.local.nativ.tv:30044/api/assets/31312"
}
],
"href": "http://masteraccount.local.nativ.tv:30044/api/assets/31314"
},
{
"id": 31313,
"name": "GC1",
"displayName": "GC1",
"objectType": {
"id": 2,
"name": "group-asset",
"href": "http://masteraccount.local.nativ.tv:30044/api/objectTypes/2",
"displayName": "Group Asset",
"pluralName": "Group Assets",
"userDefined": false,
"attachmentsSupported": true,
"commentsSupported": true,
"objectDataSupported": false,
"contentMetadataSupported": true,
"metadataSupported": true
},
"parentAssetGroups": [
{
"id": 31312,
"name": "G1",
"displayName": "G1",
"objectType": {
"id": 2,
"name": "group-asset",
"href": "http://masteraccount.local.nativ.tv:30044/api/objectTypes/2",
"displayName": "Group Asset",
"pluralName": "Group Assets",
"userDefined": false,
"attachmentsSupported": true,
"commentsSupported": true,
"objectDataSupported": false,
"contentMetadataSupported": true,
"metadataSupported": true
},
"href": "http://masteraccount.local.nativ.tv:30044/api/assets/31312"
},
{
"id": 33431,
"name": "G0",
"displayName": "G0",
"objectType": {
"id": 2,
"name": "group-asset",
"href": "http://masteraccount.local.nativ.tv:30044/api/objectTypes/2",
"displayName": "Group Asset",
"pluralName": "Group Assets",
"userDefined": false,
"attachmentsSupported": true,
"commentsSupported": true,
"objectDataSupported": false,
"contentMetadataSupported": true,
"metadataSupported": true
},
"href": "http://masteraccount.local.nativ.tv:30044/api/assets/33431"
}
],
"href": "http://masteraccount.local.nativ.tv:30044/api/assets/31313"
}
],
"href": "http://masteraccount.local.nativ.tv:30044/api/assets/31315"
}
Collections
This resource is used for viewing Collections.
Returns a list of Collections.
Creates a new Collection. Please note that you can now use the new fql
property to save an FQL as a dynamic query. This is a new 'type' of collection that you can define by using an FQL query defined instead of a specific asset. The fql
property is an optional string type that can contain up to 2000 characters. You can then use the GET
method with type=dynamic
matrix parameter to retrieve dynamic collections - for example, /api/collections;type=dynamic
(see the GET method description for more information).
get /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.
-
MatrixParam['type']: (string)
The
type
matrix parameter can be used to retrieve a list of 'static' or 'dynamic' collections. A 'dynamic' collection is a new 'type' of collection that is defined by an FQL query instead of a specific asset. The FQL query can contain up to 2000 characters and is specified using thefql
string property when the collection is created via the POST method. If thetype
matrix parameter is not specified in the request, all static and dynamic collections will be returned by default. Examples -/api/collections
will return all collections,/api/collections;type=static
will return non-dynamic collections,/api/collections;type=dynamic
will return only dynamic collections.
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. Please note that you can now use the new fql
property to save an FQL as a dynamic query. This is a new 'type' of collection that you can define by using an FQL query defined instead of a specific asset. The fql
property is an optional string type that can contain up to 2000 characters. You can then use the GET
method with type=dynamic
matrix parameter to retrieve dynamic collections - for example, /api/collections;type=dynamic
(see the GET method description for more information).
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
},
"fql": {
"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.
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.
Enables a user to retrieve a file that is stored in the filestore. This is related to the "File" field type in the Metadata Designer. Files can be associated with the "File" field type, such as an image (thumbnail) or a JSON file.
Returns Event object details (priority, event-type, event-data).
get /events/{files}
Returns Event object details (priority, event-type, event-data).
URI Parameters
- files: 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.
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.
Updates an existing Metadata Definition.
Delete the Metadata Definition.
get /metadataDefinitions/{metadataDefinitionId}
Returns the details of the Metadata Definition.
URI Parameters
-
metadataDefinitionId: required (integer)
Metadata Defintion 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 /metadataDefinitions/{metadataDefinitionId}
Updates an existing Metadata Definition.
URI Parameters
-
metadataDefinitionId: required (integer)
Metadata Defintion ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+xml
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": "string",
"required": false
}
}
}
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.
delete /metadataDefinitions/{metadataDefinitionId}
Delete the Metadata Definition.
URI Parameters
-
metadataDefinitionId: required (integer)
Metadata Defintion 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 /metadataDefinitions/{metadataDefinitionId}/actions
Returns a list of actions that can be performed.
URI Parameters
-
metadataDefinitionId: required (integer)
Metadata Defintion 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 /metadataDefinitions/{metadataDefinitionId}/actions
Performs an action. Possible action types are - enable, disable, start, stop, delete, retry, cancel, schedule, approve, unapprove, destroy.
URI Parameters
-
metadataDefinitionId: required (integer)
Metadata Defintion 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.
Returns the details for a specific attachment.
Updates the comment for an existing attachment.
Deletes an existing attachment.
get /metadataDefinitions/{metadataDefinitionId}/actions/{attachmentId}
Returns the details for a specific attachment.
URI Parameters
-
metadataDefinitionId: required (integer)
Metadata Defintion 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 /metadataDefinitions/{metadataDefinitionId}/actions/{attachmentId}
Updates the comment for an existing attachment.
URI Parameters
-
metadataDefinitionId: required (integer)
Metadata Defintion 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 /metadataDefinitions/{metadataDefinitionId}/actions/{attachmentId}
Deletes an existing attachment.
URI Parameters
-
metadataDefinitionId: required (integer)
Metadata Defintion 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 /metadataDefinitions/{metadataDefinitionId}/history
Returns a list of events.
URI Parameters
-
metadataDefinitionId: required (integer)
Metadata Defintion 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 operations on a specific metadata defintion metadata.
Returns the defintion of the metadata definition.
Updates the metadata instance associated with the definition. A valid XML metadata structure is expected in the body. The updated metadata will be returned if the request was successful.
get /metadataDefinitions/{metadataDefinitionId}/definition
Returns the defintion of the metadata definition.
URI Parameters
-
metadataDefinitionId: required (integer)
Metadata Defintion 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 /metadataDefinitions/{metadataDefinitionId}/definition
Updates the metadata instance associated with the definition. A valid XML metadata structure is expected in the body. The updated metadata will be returned if the request was successful.
URI Parameters
-
metadataDefinitionId: required (integer)
Metadata Defintion 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 /metadataDefinitions/{metadataDefinitionId}/externalIds
Returns a list of external IDs associated with an Account.
URI Parameters
-
metadataDefinitionId: required (integer)
Metadata Defintion 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 /metadataDefinitions/{metadataDefinitionId}/externalIds
Creates new external ID.
URI Parameters
-
metadataDefinitionId: required (integer)
Metadata Defintion 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 /metadataDefinitions/{metadataDefinitionId}/externalIds/{key}
Returns the details for a specific external ID.
URI Parameters
-
metadataDefinitionId: required (integer)
Metadata Defintion 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 /metadataDefinitions/{metadataDefinitionId}/externalIds/{key}
Updates the Account/System Property
URI Parameters
-
metadataDefinitionId: required (integer)
Metadata Defintion 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 /metadataDefinitions/{metadataDefinitionId}/externalIds/{key}
Deletes a specific external ID.
URI Parameters
-
metadataDefinitionId: required (integer)
Metadata Defintion 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.
Message Templates
This resource is used for viewing and managing Message Templates.
Returns a list of Message Template bodies. Listing is based on supplied filters.
Creates a new Message Template.
get /messageTemplates
Returns a list of Message Template bodies. 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['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 /messageTemplates
Creates a new Message Template.
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"name": {
"type": "string",
"required": true
},
"description": {
"type": "string",
"required": false
},
"visibilityIds": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 0,
"uniqueItems": true,
"required": true
},
"subject": {
"type": "string",
"required": false
},
"priority": {
"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.
Perform operations on a specific Message Template.
Returns Message Template object details.
Updates an existi.
Deletes the Message Template.
get /messageTemplates/{messageTemplateId}
Returns Message Template object details.
URI Parameters
- messageTemplateId: 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 /messageTemplates/{messageTemplateId}
Updates an existi.
URI Parameters
- messageTemplateId: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"name": {
"type": "string",
"required": true
},
"description": {
"type": "string",
"required": false
},
"visibilityIds": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 0,
"uniqueItems": true,
"required": true
},
"subject": {
"type": "string",
"required": false
},
"priority": {
"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 /messageTemplates/{messageTemplateId}
Deletes the Message Template.
URI Parameters
- messageTemplateId: 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 actions that can be performed.
Performs an action. Possible action types are - delete, destroy.
get /messageTemplates/{messageTemplateId}/actions
Returns a list of actions that can be performed.
URI Parameters
- messageTemplateId: 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 /messageTemplates/{messageTemplateId}/actions
Performs an action. Possible action types are - delete, destroy.
URI Parameters
- messageTemplateId: 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.
A collection of comment.
Returns a list of Comments.
Adds a new Comment.
get /messageTemplates/{messageTemplateId}/comments
Returns a list of Comments.
URI Parameters
- messageTemplateId: required (string)
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 /messageTemplates/{messageTemplateId}/comments
Adds a new Comment.
URI Parameters
- messageTemplateId: 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.
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 /messageTemplates/{messageTemplateId}/comments/{commentId}
Returns a Comment.
URI Parameters
- messageTemplateId: required (string)
-
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 Message Template.
post /messageTemplates/{messageTemplateId}/copy
Copies an existing Message Template.
URI Parameters
- messageTemplateId: 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": {
"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 /messageTemplates/{messageTemplateId}/followers
Returns a list of users that are following this object.
URI Parameters
- messageTemplateId: required (string)
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 /messageTemplates/{messageTemplateId}/attachments
Returns a list of attachments.
URI Parameters
- messageTemplateId: required (string)
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 /messageTemplates/{messageTemplateId}/attachments
Creates a new attachment.
URI Parameters
- messageTemplateId: 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": {
"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 /messageTemplates/{messageTemplateId}/attachments/{attachmentId}
Returns the details for a specific attachment.
URI Parameters
- messageTemplateId: required (string)
- 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 /messageTemplates/{messageTemplateId}/attachments/{attachmentId}
Updates the comment for an existing attachment.
URI Parameters
- messageTemplateId: required (string)
- 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 /messageTemplates/{messageTemplateId}/attachments/{attachmentId}
Deletes an existing attachment.
URI Parameters
- messageTemplateId: required (string)
- 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 /messageTemplates/{messageTemplateId}/history
Returns a list of events.
URI Parameters
- messageTemplateId: required (string)
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 /messageTemplates/{messageTemplateId}/references
Returns a list of references.
URI Parameters
- messageTemplateId: required (string)
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 HTML body of the Message Template.
Updates the HTML body of the Message Template.
get /messageTemplates/{messageTemplateId}/body
Returns the HTML body of the Message Template.
URI Parameters
- messageTemplateId: required (string)
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 /messageTemplates/{messageTemplateId}/body
Updates the HTML body of the Message Template.
URI Parameters
- messageTemplateId: required (string)
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.
Objects
This resource is used for retrieving Objects.
get /objects
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['objectType']: (string)
You can specify the Object type(eg. Assets, Jobs, Workflows...etc), and then all Objects of that type will be returned. For example if you were to specify "Asset" as your Object Type, a list of all Assets will be returned.
-
MatrixParam['accountId']: (number)
You can list multiple Account Ids separated by a colon, e.g. aId=1; aId=2;
-
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.
Object Types
This resource is used for viewing information about Object Types.
Returns a list of existing User Defined Object Types.
get /objectTypes
Returns a list of existing User Defined Object Types.
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['name']: (string)
Enables you to search for an object using the name of the object.
-
MatrixParam['displayName']: (string)
Enables you to search for an object using the display name.
-
MatrixParam['pluralName']: (string)
Enables you to search for an object using the plural name.
-
MatrixParam['userDefined']: (string)
Enables you to filter out all the non-user defined object types in the system.
-
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 details of a specific object type.
get /objectTypes/{objectTypeId}
Returns the details of a specific object type.
URI Parameters
- objectTypeId: 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 details of a specific user object type.
get /objectTypes/user
Returns the details of a specific user object type.
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 of a specific asset object type.
get /objectTypes/asset
Returns the details of a specific asset object type.
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 of a specific object type.
get /objectTypes/object
Returns the details of a specific object type.
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.
Players
Show existing Players
Returns a list of Players. Listing is based on supplied filters.
get /players
Returns a list of Players. 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['assedId']: (integer - minimum: 0)
- MatrixParam['assetTitle']: (string)
- MatrixParam['definitionId']: (integer - minimum: 0)
-
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.
Returns details of a specific Player
get /players/{playerId}
Returns details of a specific Player
URI Parameters
- playerId: 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 /players/{playerId}/comments
Returns a list of comments.
URI Parameters
- playerId: required (string)
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 /players/{playerId}/comments
Adds a new comment.
URI Parameters
- playerId: 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.
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 /players/{playerId}/comments/{commentId}
Returns a comment.
URI Parameters
- playerId: required (string)
-
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 Player.
post /players/{playerId}/copy
Copies an existing Player.
URI Parameters
- playerId: 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": {
"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 /players/{playerId}/followers
Returns a list of users that are following this object.
URI Parameters
- playerId: required (string)
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 /players/{playerId}/attachments
Returns a list of attachments.
URI Parameters
- playerId: required (string)
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 /players/{playerId}/attachments
Creates a new attachment.
URI Parameters
- playerId: 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": {
"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 /players/{playerId}/attachments/{attachmentId}
Returns the details for a specific attachment.
URI Parameters
- playerId: required (string)
- 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 /players/{playerId}/attachments/{attachmentId}
Updates the comment for an existing attachment.
URI Parameters
- playerId: required (string)
- 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 /players/{playerId}/attachments/{attachmentId}
Deletes an existing attachment.
URI Parameters
- playerId: required (string)
- 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 /players/{playerId}/history
Returns a list of events.
URI Parameters
- playerId: required (string)
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 /players/{playerId}/references
Returns a list of references.
URI Parameters
- playerId: required (string)
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 a list of external IDs associated with an Account.
Creates new external ID.
get /players/{playerId}/externalIds
Returns a list of external IDs associated with an Account.
URI Parameters
- playerId: 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
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 /players/{playerId}/externalIds
Creates new external ID.
URI Parameters
- playerId: 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": {
"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 /players/{playerId}/externalIds/{key}
Returns the details for a specific external ID.
URI Parameters
- playerId: required (string)
- 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 /players/{playerId}/externalIds/{key}
Updates the Account/System Property.
URI Parameters
- playerId: required (string)
- 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 /players/{playerId}/externalIds/{key}
Deletes a specific external ID.
URI Parameters
- playerId: required (string)
- 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.
Player Definitions
This resource is used for viewing and managing Player Definitions.
Returns a list of Player Definitions. Listing is based on supplied filters.
get /playerDefinitions
Returns a list of Player 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['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 Player Definitions.
Returns Player Definition object details.
Deletes a Player Definition.
get /playerDefinitions/{playerDefinitionId}
Returns Player Definition object details.
URI Parameters
-
playerDefinitionId: required (integer)
Player Defintion 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 /playerDefinitions/{playerDefinitionId}
Deletes a Player Definition.
URI Parameters
-
playerDefinitionId: required (integer)
Player Defintion 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 /playerDefinitions/{playerDefinitionId}/actions
Returns a list of actions that can be performed.
URI Parameters
-
playerDefinitionId: required (integer)
Player Defintion 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 /playerDefinitions/{playerDefinitionId}/actions
Performs an action. Possible action types are - enable, disable, start, stop, delete, retry, cancel, schedule, approve, unapprove, destroy.
URI Parameters
-
playerDefinitionId: required (integer)
Player Defintion 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 /playerDefinitions/{playerDefinitionId}/comments
Returns a list of Comments.
URI Parameters
-
playerDefinitionId: required (integer)
Player Defintion 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 /playerDefinitions/{playerDefinitionId}/comments
Adds a new Comment.
URI Parameters
-
playerDefinitionId: required (integer)
Player Defintion 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 /playerDefinitions/{playerDefinitionId}/comments/{commentId}
Returns a Comment.
URI Parameters
-
playerDefinitionId: required (integer)
Player Defintion 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 Player Definition.
post /playerDefinitions/{playerDefinitionId}/copy
Copies an existing Player Definition.
URI Parameters
-
playerDefinitionId: required (integer)
Player Defintion 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 /playerDefinitions/{playerDefinitionId}/followers
Returns a list of users that are following this object.
URI Parameters
-
playerDefinitionId: required (integer)
Player Defintion 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 /playerDefinitions/{playerDefinitionId}/attachments
Returns a list of attachments.
URI Parameters
-
playerDefinitionId: required (integer)
Player Defintion 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 /playerDefinitions/{playerDefinitionId}/attachments
Creates a new attachment.
URI Parameters
-
playerDefinitionId: required (integer)
Player Defintion 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 /playerDefinitions/{playerDefinitionId}/attachments/{attachmentId}
Returns the details for a specific attachment.
URI Parameters
-
playerDefinitionId: required (integer)
Player Defintion 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 /playerDefinitions/{playerDefinitionId}/attachments/{attachmentId}
Updates the comment for an existing attachment.
URI Parameters
-
playerDefinitionId: required (integer)
Player Defintion 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 /playerDefinitions/{playerDefinitionId}/attachments/{attachmentId}
Deletes an existing attachment.
URI Parameters
-
playerDefinitionId: required (integer)
Player Defintion 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 /playerDefinitions/{playerDefinitionId}/history
Returns a list of events.
URI Parameters
-
playerDefinitionId: required (integer)
Player Defintion 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 /playerDefinitions/{playerDefinitionId}/references
Returns a list of references.
URI Parameters
-
playerDefinitionId: required (integer)
Player Defintion 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 player's configuration.
Returns the player's 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 /playerDefinitions/{playerDefinitionId}/configuration
Returns the player's configuration including a href to the configuration.
URI Parameters
-
playerDefinitionId: required (integer)
Player Defintion 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 /playerDefinitions/{playerDefinitionId}/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
-
playerDefinitionId: required (integer)
Player Defintion 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 /playerDefinitions/{playerDefinitionId}/externalIds
Returns a list of external IDs associated with an Account.
URI Parameters
-
playerDefinitionId: required (integer)
Player Defintion 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 /playerDefinitions/{playerDefinitionId}/externalIds
Creates new external ID.
URI Parameters
-
playerDefinitionId: required (integer)
Player Defintion 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 /playerDefinitions/{playerDefinitionId}/externalIds/{key}
Returns the details for a specific external ID.
URI Parameters
-
playerDefinitionId: required (integer)
Player Defintion 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 /playerDefinitions/{playerDefinitionId}/externalIds/{key}
Updates the Account/System Property
URI Parameters
-
playerDefinitionId: required (integer)
Player Defintion 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 /playerDefinitions/{playerDefinitionId}/externalIds/{key}
Deletes a specific external ID.
URI Parameters
-
playerDefinitionId: required (integer)
Player Defintion 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 file instances from the Metadata of a Player Definition, Action configuration, or resource configuration.
get /playerDefinitions/{playerDefinitionId}/configuration/files
Returns file instances from the Metadata of a Player Definition, Action configuration, or resource configuration.
URI Parameters
-
playerDefinitionId: required (integer)
Player Defintion 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.
Plugins
This resource is used for viewing existing Plugins
Returns a list of Plugins. Listing is based on supplied filters.
get /plugins
Returns a list of Plugins. Listing is based on supplied filters.
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['className']: (string)
The class name to search for.
-
MatrixParam['type']: (one of Action, Resource, Event Handler, Quota, Wizard, Timed Action, Player Definition)
The plugin type to search for.
-
MatrixParam['actionType']: (string)
The action type to search for.
-
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.
Profiles
Perform operations on Profiles
Returns a list of Profiles. Listing is based on supplied filters.
Create a new profile.
get /profiles
Returns a list of Profiles. Listing is based on supplied filters.
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['type']: (one of Media Validate, Media Transcode, Image Validate, Image Transcode)
The system metadata type to search for.
-
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 /profiles
Create a new profile.
Perform operations on a specific Profile
Returns the details of the Profile
Update the profile.
Deletes the Profile
get /profiles/{profileId}
Returns the details of the Profile
URI Parameters
-
profileId: required (integer)
Profile 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 /profiles/{profileId}
Update the profile.
URI Parameters
-
profileId: required (integer)
Profile 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 /profiles/{profileId}
Deletes the Profile
URI Parameters
-
profileId: required (integer)
Profile 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 /profiles/{profileId}/actions
Returns a list of actions that can be performed.
URI Parameters
-
profileId: required (integer)
Profile 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 /profiles/{profileId}/actions
Performs an action. Possible action types are - enable, disable, start, stop, delete, retry, cancel, schedule, approve, unapprove, destroy.
URI Parameters
-
profileId: required (integer)
Profile 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 /profiles/{profileId}/comments
Returns a list of Comments.
URI Parameters
-
profileId: required (integer)
Profile 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 /profiles/{profileId}/comments
Adds a new Comment.
URI Parameters
-
profileId: required (integer)
Profile 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 /profiles/{profileId}/comments/{commentId}
Returns a Comment.
URI Parameters
-
profileId: required (integer)
Profile 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 Profile.
post /profiles/{profileId}/copy
Copies an existing Profile.
URI Parameters
-
profileId: required (integer)
Profile 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 /profiles/{profileId}/followers
Returns a list of users that are following this object.
URI Parameters
-
profileId: required (integer)
Profile 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 /profiles/{profileId}/attachments
Returns a list of attachments.
URI Parameters
-
profileId: required (integer)
Profile 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 /profiles/{profileId}/attachments
Creates a new attachment.
URI Parameters
-
profileId: required (integer)
Profile 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 /profiles/{profileId}/attachments/{attachmentId}
Returns the details for a specific attachment.
URI Parameters
-
profileId: required (integer)
Profile 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 /profiles/{profileId}/attachments/{attachmentId}
Updates the comment for an existing attachment.
URI Parameters
-
profileId: required (integer)
Profile 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 /profiles/{profileId}/attachments/{attachmentId}
Deletes an existing attachment.
URI Parameters
-
profileId: required (integer)
Profile 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 /profiles/{profileId}/history
Returns a list of events.
URI Parameters
-
profileId: required (integer)
Profile 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 /profiles/{profileId}/references
Returns a list of references.
URI Parameters
-
profileId: required (integer)
Profile 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 instance of the profile including a href link 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 /profiles/{profileId}/configuration
Returns the metadata instance of the profile including a href link to the metadata definition.
URI Parameters
-
profileId: required (integer)
Profile 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 /profiles/{profileId}/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
-
profileId: required (integer)
Profile 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 /profiles/{profileId}/externalIds
Returns a list of external IDs associated with an Account.
URI Parameters
-
profileId: required (integer)
Profile 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 /profiles/{profileId}/externalIds
Creates new external ID.
URI Parameters
-
profileId: required (integer)
Profile 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 /profiles/{profileId}/externalIds/{key}
Returns the details for a specific external ID.
URI Parameters
-
profileId: required (integer)
Profile 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 /profiles/{profileId}/externalIds/{key}
Updates the Account/System Property
URI Parameters
-
profileId: required (integer)
Profile 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 /profiles/{profileId}/externalIds/{key}
Deletes a specific external ID.
URI Parameters
-
profileId: required (integer)
Profile 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.
Quotas
This resource is used for viewing and managing Quotas
Returns a list of Quotas. Listing is based on supplied filters.
Creates a new Quota.
get /quotas
Returns a list of Quotas. 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['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 /quotas
Creates a new Quota.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"name": {
"type": "string",
"required": true
},
"description": {
"type": "string",
"required": false
},
"pluginClass": {
"type": "string",
"required": true
},
"assignment": {
"type": "integer",
"required": true
},
"resources": {
"type": "integer",
"required": true
},
"timeout": {
"type": "string",
"required": true
}
}
}
Perform operations on a specific Quota.
Returns Quota object details.
Updates an existing a new Quota.
Deletes a Quota
get /quotas/{quotaId}
Returns Quota object details.
URI Parameters
-
quotaId: required (integer)
Quota 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 /quotas/{quotaId}
Updates an existing a new Quota.
URI Parameters
-
quotaId: required (integer)
Quota 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
},
"assignment": {
"type": "integer",
"required": true
},
"resources": {
"type": "integer",
"required": true
},
"timeout": {
"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 /quotas/{quotaId}
Deletes a Quota
URI Parameters
-
quotaId: required (integer)
Quota 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 /quotas/{quotaId}/actions
Returns a list of actions that can be performed.
URI Parameters
-
quotaId: required (integer)
Quota 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 /quotas/{quotaId}/actions
Performs an action. Possible action types are - delete, destroy.
URI Parameters
-
quotaId: required (integer)
Quota 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 /quotas/{quotaId}/comments
Returns a list of Comments.
URI Parameters
-
quotaId: required (integer)
Quota 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 /quotas/{quotaId}/comments
Adds a new Comment.
URI Parameters
-
quotaId: required (integer)
Quota 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 /quotas/{quotaId}/comments/{commentId}
Returns a Comment.
URI Parameters
-
quotaId: required (integer)
Quota 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 Quota.
post /quotas/{quotaId}/copy
Copies an existing Quota.
URI Parameters
-
quotaId: required (integer)
Quota 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 /quotas/{quotaId}/followers
Returns a list of users that are following this object.
URI Parameters
-
quotaId: required (integer)
Quota 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 /quotas/{quotaId}/attachments
Returns a list of attachments.
URI Parameters
-
quotaId: required (integer)
Quota 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 /quotas/{quotaId}/attachments
Creates a new attachment.
URI Parameters
-
quotaId: required (integer)
Quota 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 /quotas/{quotaId}/attachments/{attachmentId}
Returns the details for a specific attachment.
URI Parameters
-
quotaId: required (integer)
Quota 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 /quotas/{quotaId}/attachments/{attachmentId}
Updates the comment for an existing attachment.
URI Parameters
-
quotaId: required (integer)
Quota 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 /quotas/{quotaId}/attachments/{attachmentId}
Deletes an existing attachment.
URI Parameters
-
quotaId: required (integer)
Quota 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 /quotas/{quotaId}/history
Returns a list of events.
URI Parameters
-
quotaId: required (integer)
Quota 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 /quotas/{quotaId}/references
Returns a list of references.
URI Parameters
-
quotaId: required (integer)
Quota 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 quota's configuration.
Returns the quota's 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 /quotas/{quotaId}/configuration
Returns the quota's configuration including a href to the configuration.
URI Parameters
-
quotaId: required (integer)
Quota 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 /quotas/{quotaId}/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
-
quotaId: required (integer)
Quota 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 /quotas/{quotaId}/externalIds
Returns a list of external IDs associated with an Account.
URI Parameters
-
quotaId: required (integer)
Quota 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 /quotas/{quotaId}/externalIds
Creates new external ID.
URI Parameters
-
quotaId: required (integer)
Quota 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 /quotas/{quotaId}/externalIds/{key}
Returns the details for a specific external ID.
URI Parameters
-
quotaId: required (integer)
Quota 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 /quotas/{quotaId}/externalIds/{key}
Updates the Account/System Property
URI Parameters
-
quotaId: required (integer)
Quota 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 /quotas/{quotaId}/externalIds/{key}
Deletes a specific external ID.
URI Parameters
-
quotaId: required (integer)
Quota 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.
Report Definitions
This resource is used for viewing Report Definitions
Returns a list of Report Definitions. Listing is based on supplied filters.
get /reportDefinitions
Returns a list of Report 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['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 details of a specific Report Definition
Deletes a Report Definition
get /reportDefinitions/{reportDefinitionId}
Returns details of a specific Report Definition
URI Parameters
- reportDefinitionId: 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 /reportDefinitions/{reportDefinitionId}
Deletes a Report Definition
URI Parameters
- reportDefinitionId: 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 actions that can be performed.
Performs an action. Possible action types are - enable, disable, start, stop, delete, destroy.
get /reportDefinitions/{reportDefinitionId}/actions
Returns a list of actions that can be performed.
URI Parameters
- reportDefinitionId: 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 /reportDefinitions/{reportDefinitionId}/actions
Performs an action. Possible action types are - enable, disable, start, stop, delete, destroy.
URI Parameters
- reportDefinitionId: 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.
A collection of comment.
Returns a list of Comments.
Adds a new Comment.
get /reportDefinitions/{reportDefinitionId}/comments
Returns a list of Comments.
URI Parameters
- reportDefinitionId: required (string)
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 /reportDefinitions/{reportDefinitionId}/comments
Adds a new Comment.
URI Parameters
- reportDefinitionId: 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.
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 /reportDefinitions/{reportDefinitionId}/comments/{commentId}
Returns a Comment.
URI Parameters
- reportDefinitionId: required (string)
-
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 Report Definition.
post /reportDefinitions/{reportDefinitionId}/copy
Copies an existing Report Definition.
URI Parameters
- reportDefinitionId: 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": {
"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 /reportDefinitions/{reportDefinitionId}/followers
Returns a list of users that are following this object.
URI Parameters
- reportDefinitionId: required (string)
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 /reportDefinitions/{reportDefinitionId}/attachments
Returns a list of attachments.
URI Parameters
- reportDefinitionId: required (string)
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 /reportDefinitions/{reportDefinitionId}/attachments
Creates a new attachment.
URI Parameters
- reportDefinitionId: 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": {
"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 /reportDefinitions/{reportDefinitionId}/attachments/{attachmentId}
Returns the details for a specific attachment.
URI Parameters
- reportDefinitionId: required (string)
- 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 /reportDefinitions/{reportDefinitionId}/attachments/{attachmentId}
Updates the comment for an existing attachment.
URI Parameters
- reportDefinitionId: required (string)
- 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 /reportDefinitions/{reportDefinitionId}/attachments/{attachmentId}
Deletes an existing attachment.
URI Parameters
- reportDefinitionId: required (string)
- 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 /reportDefinitions/{reportDefinitionId}/history
Returns a list of events.
URI Parameters
- reportDefinitionId: required (string)
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 /reportDefinitions/{reportDefinitionId}/references
Returns a list of references.
URI Parameters
- reportDefinitionId: required (string)
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 a list of external IDs associated with an Account.
Creates new external ID.
get /reportDefinitions/{reportDefinitionId}/externalIds
Returns a list of external IDs associated with an Account.
URI Parameters
- reportDefinitionId: 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
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 /reportDefinitions/{reportDefinitionId}/externalIds
Creates new external ID.
URI Parameters
- reportDefinitionId: 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": {
"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 /reportDefinitions/{reportDefinitionId}/externalIds/{key}
Returns the details for a specific external ID.
URI Parameters
- reportDefinitionId: required (string)
- 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 /reportDefinitions/{reportDefinitionId}/externalIds/{key}
Updates the Account/System Property
URI Parameters
- reportDefinitionId: required (string)
- 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 /reportDefinitions/{reportDefinitionId}/externalIds/{key}
Deletes a specific external ID.
URI Parameters
- reportDefinitionId: required (string)
- 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.
Resources
Perform operations on Resources
Returns a list of Resources. Listing is based on supplied filters.
get /resources
Returns a list of Resources. 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)
The status of the resource.
-
MatrixParam['resourceSubType']: (one of Transcode, Extract, Inject, Transfer, Storage, Folder, Inbox, Hot Folder, Shared Folder, QC)
A resource sub-type to filter results.
-
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 resources with references, you would do the following /api/recources?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.
Perform operations on a specific Resource
Returns details of the Resource
Deletes the Resource
get /resources/{resourceId}
Returns details of the Resource
URI Parameters
-
resourceId: required (integer)
Resource 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 /resources/{resourceId}
Deletes the Resource
URI Parameters
-
resourceId: required (integer)
Resource ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['deepDelete']: (one of Started, Stopped, Failed)
User can specify "deepDelete" value as True in order to remove physical files for selected storage resource.
-
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 that can be performed.
Performs an action. Possible action types are - enable, disable, start, stop, delete, destroy.
get /resources/{resourceId}/actions
Returns a list of actions that can be performed.
URI Parameters
-
resourceId: required (integer)
Resource 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 /resources/{resourceId}/actions
Performs an action. Possible action types are - enable, disable, start, stop, delete, destroy.
URI Parameters
-
resourceId: required (integer)
Resource 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 /resources/{resourceId}/comments
Returns a list of Comments.
URI Parameters
-
resourceId: required (integer)
Resource 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 /resources/{resourceId}/comments
Adds a new Comment.
URI Parameters
-
resourceId: required (integer)
Resource 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 /resources/{resourceId}/comments/{commentId}
Returns a Comment.
URI Parameters
-
resourceId: required (integer)
Resource 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 Resource.
post /resources/{resourceId}/copy
Copies an existing Resource.
URI Parameters
-
resourceId: required (integer)
Resource 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 /resources/{resourceId}/followers
Returns a list of users that are following this object.
URI Parameters
-
resourceId: required (integer)
Resource 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 /resources/{resourceId}/attachments
Returns a list of attachments.
URI Parameters
-
resourceId: required (integer)
Resource 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 /resources/{resourceId}/attachments
Creates a new attachment.
URI Parameters
-
resourceId: required (integer)
Resource 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 /resources/{resourceId}/attachments/{attachmentId}
Returns the details for a specific attachment.
URI Parameters
-
resourceId: required (integer)
Resource 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 /resources/{resourceId}/attachments/{attachmentId}
Updates the comment for an existing attachment.
URI Parameters
-
resourceId: required (integer)
Resource 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 /resources/{resourceId}/attachments/{attachmentId}
Deletes an existing attachment.
URI Parameters
-
resourceId: required (integer)
Resource 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 /resources/{resourceId}/history
Returns a list of events.
URI Parameters
-
resourceId: required (integer)
Resource 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.
Performs a callback.
post /resources/{resourceId}/callbacks
Performs a callback.
URI Parameters
-
resourceId: required (integer)
Resource 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 the metadata instance of the resource including a href to the metadata definition.
Updates the metadata instance of the resource including a href to the metadata definition.
get /resources/{resourceId}/configuration
Returns the metadata instance of the resource including a href to the metadata definition.
URI Parameters
-
resourceId: required (integer)
Resource 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 /resources/{resourceId}/configuration
Updates the metadata instance of the resource including a href to the metadata definition.
URI Parameters
-
resourceId: required (integer)
Resource 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.
A collection of item.
Returns a list of resource items based on specified filters.
get /resources/{resourceId}/items
Returns a list of resource items based on specified filters.
URI Parameters
-
resourceId: required (integer)
Resource 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['name']: (string)
Search for a specific 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 details of a resource item
get /resources/{resourceId}/items/{resourceItemId}
Returns details of a resource item
URI Parameters
-
resourceId: required (integer)
Resource ID
-
resourceItemId: required (integer)
Resource Item 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 storageResource.
Returns the storage resources for a folder resource.
get /resources/{resourceId}/storageResources
Returns the storage resources for a folder resource.
URI Parameters
-
resourceId: required (integer)
Resource 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.
Returns a list of external IDs associated with an Account.
Creates new external ID.
get /resources/{resourceId}/externalIds
Returns a list of external IDs associated with an Account.
URI Parameters
-
resourceId: required (integer)
Resource 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 /resources/{resourceId}/externalIds
Creates new external ID.
URI Parameters
-
resourceId: required (integer)
Resource 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 /resources/{resourceId}/externalIds/{key}
Returns the details for a specific external ID.
URI Parameters
-
resourceId: required (integer)
Resource 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 /resources/{resourceId}/externalIds/{key}
Updates the Account/System Property
URI Parameters
-
resourceId: required (integer)
Resource 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 /resources/{resourceId}/externalIds/{key}
Deletes a specific external ID.
URI Parameters
-
resourceId: required (integer)
Resource 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.
Roles
Perform operation on Roles
Returns a list of Roles. Listing is based on supplied filters.
Creates a Role
get /roles
Returns a list of Roles. Listing is based on supplied filters.
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['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 /roles
Creates a Role
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['accountId']: (integer - minimum: 0)
Search for a role inside of a specific account.
-
MatrixParam['skipCount']: (boolean)
This parameter skips the count query execution when fetching a record.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"name": {
"type": "string",
"required": true
},
"description": {
"type": "string",
"required": false
},
"privileged": {
"type": "string",
"required": false
},
"accountId": {
"type": "long",
"required": false
},
"permissions": {
"type": "array",
"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.
Perform operations on a specific Role
Returns Role object details.
Updates the role that the Id belongs to.
Deletes a Role
get /roles/{roleId}
Returns Role object details.
URI Parameters
-
roleId: required (integer)
Role 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 /roles/{roleId}
Updates the role that the Id belongs to.
URI Parameters
-
roleId: required (integer)
Role 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
},
"privileged": {
"type": "string",
"required": false
},
"permissions": {
"type": "array",
"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 /roles/{roleId}
Deletes a Role
URI Parameters
-
roleId: required (integer)
Role 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, destroy.
get /roles/{roleId}/actions
Returns a list of actions that can be performed.
URI Parameters
-
roleId: required (integer)
Role 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 /roles/{roleId}/actions
Performs an action. Possible action types are - enable, disable, delete, destroy.
URI Parameters
-
roleId: required (integer)
Role 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 /roles/{roleId}/comments
Returns a list of Comments.
URI Parameters
-
roleId: required (integer)
Role 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 /roles/{roleId}/comments
Adds a new Comment.
URI Parameters
-
roleId: required (integer)
Role 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 /roles/{roleId}/comments/{commentId}
Returns a Comment.
URI Parameters
-
roleId: required (integer)
Role 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 Role.
post /roles/{roleId}/copy
Copies an existing Role.
URI Parameters
-
roleId: required (integer)
Role 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 /roles/{roleId}/followers
Returns a list of users that are following this object.
URI Parameters
-
roleId: required (integer)
Role 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 /roles/{roleId}/attachments
Returns a list of attachments.
URI Parameters
-
roleId: required (integer)
Role 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 /roles/{roleId}/attachments
Creates a new attachment.
URI Parameters
-
roleId: required (integer)
Role 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 /roles/{roleId}/attachments/{attachmentId}
Returns the details for a specific attachment.
URI Parameters
-
roleId: required (integer)
Role 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 /roles/{roleId}/attachments/{attachmentId}
Updates the comment for an existing attachment.
URI Parameters
-
roleId: required (integer)
Role 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 /roles/{roleId}/attachments/{attachmentId}
Deletes an existing attachment.
URI Parameters
-
roleId: required (integer)
Role 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 /roles/{roleId}/history
Returns a list of events.
URI Parameters
-
roleId: required (integer)
Role 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 /roles/{roleId}/references
Returns a list of references.
URI Parameters
-
roleId: required (integer)
Role 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 a list of users that are members of the specific role. Listing is based on supplied filters.
get /roles/{roleId}/members
Returns a list of users that are members of the specific role. Listing is based on supplied filters.
URI Parameters
-
roleId: required (integer)
Role 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 /roles/{roleId}/externalIds
Returns a list of external IDs associated with an Account.
URI Parameters
-
roleId: required (integer)
Role 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 /roles/{roleId}/externalIds
Creates new external ID.
URI Parameters
-
roleId: required (integer)
Role 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 /roles/{roleId}/externalIds/{key}
Returns the details for a specific external ID.
URI Parameters
-
roleId: required (integer)
Role 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 /roles/{roleId}/externalIds/{key}
Updates the Account/System Property
URI Parameters
-
roleId: required (integer)
Role 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 /roles/{roleId}/externalIds/{key}
Deletes a specific external ID.
URI Parameters
-
roleId: required (integer)
Role 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.
Tasks
Perform operation on Tasks
Returns a list of Tasks. Listing is based on supplied filters.
get /tasks
Returns a list of Tasks. 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['taskDefinitionName']: (string)
- MatrixParam['taskDefinitionId']: (integer - minimum: 0)
- MatrixParam['assetId']: (integer - minimum: 0)
- MatrixParam['workflowInstanceId']: (integer - minimum: 0)
-
MatrixParam['status']: (one of Closed, Open, Started, Taken, Cancelled)
The status of the task.
-
MatrixParam['id']: (string)
Filtering by multiple Ids.Example- /api/tasks;id=1234;id=2345;id=3456
-
MatrixParam['startedFrom']: (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['StartedTo']: (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['CompletedFrom']: (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['CompletedTo']: (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['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 Task
Returns Task object details. You can also list multiple Tasks by entering a list of Task ids separated by a semicolon e.g /api/assets;id=1234;id=2345;id=3456
get /tasks/{taskId}
Returns Task object details. You can also list multiple Tasks by entering a list of Task ids separated by a semicolon e.g /api/assets;id=1234;id=2345;id=3456
URI Parameters
-
taskId: required (integer)
Task 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.
Update the status of the task.
post /tasks/{taskId}/status
Update the status of the task.
URI Parameters
-
taskId: required (integer)
Task 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": {
"status": {
"type": "string",
"required": true
}
}
}
HTTP status code 200
Returns the updated task object.
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.
Task Definitions
This resource is used for viewing Task Definitions
Returns a list of Task Definitions. Listing is based on supplied filters.
Creates a new Task Definition.
get /taskDefintions
Returns a list of Task 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 task definitions with references, you would do the following /api/taskDefinitions?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 /taskDefintions
Creates a new Task Definition.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"accountId": {
"type": "string",
"required": true
},
"name": {
"type": "string",
"required": true
},
"description": {
"type": "string",
"required": true
},
"wizardId": {
"type": "string",
"required": false
},
"expressionAssignment": {
"type": "string",
"required": false
},
"Assignment": {
"type": "long",
"required": false
},
"visibilityIds": {
"type": "long",
"required": true
}
}
}
Returns details of a specific Task Definition
Creates a new Task Definition.
Deletes a Task Definition
get /taskDefintions/{taskDefinitionId}
Returns details of a specific Task Definition
URI Parameters
- taskDefinitionId: 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 /taskDefintions/{taskDefinitionId}
Creates a new Task Definition.
URI Parameters
- taskDefinitionId: 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": {
"accountId": {
"type": "string",
"required": true
},
"name": {
"type": "string",
"required": true
},
"description": {
"type": "string",
"required": true
},
"wizardId": {
"type": "string",
"required": false
},
"expressionAssignment": {
"type": "string",
"required": false
},
"Assignment": {
"type": "long",
"required": false
},
"visibilityIds": {
"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 /taskDefintions/{taskDefinitionId}
Deletes a Task Definition
URI Parameters
- taskDefinitionId: 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 actions that can be performed.
Performs an action. Possible action types are - enable, disable, start, stop, delete, retry, cancel, schedule, approve, unapprove, destroy.
get /taskDefintions/{taskDefinitionId}/actions
Returns a list of actions that can be performed.
URI Parameters
- taskDefinitionId: 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 /taskDefintions/{taskDefinitionId}/actions
Performs an action. Possible action types are - enable, disable, start, stop, delete, retry, cancel, schedule, approve, unapprove, destroy.
URI Parameters
- taskDefinitionId: 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.
A collection of comment.
Returns a list of Comments.
Adds a new Comment.
get /taskDefintions/{taskDefinitionId}/comments
Returns a list of Comments.
URI Parameters
- taskDefinitionId: required (string)
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 /taskDefintions/{taskDefinitionId}/comments
Adds a new Comment.
URI Parameters
- taskDefinitionId: 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.
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 /taskDefintions/{taskDefinitionId}/comments/{commentId}
Returns a Comment.
URI Parameters
- taskDefinitionId: required (string)
-
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 Task Definition.
post /taskDefintions/{taskDefinitionId}/copy
Copies an existing Task Definition.
URI Parameters
- taskDefinitionId: 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": {
"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 /taskDefintions/{taskDefinitionId}/followers
Returns a list of users that are following this object.
URI Parameters
- taskDefinitionId: required (string)
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 /taskDefintions/{taskDefinitionId}/attachments
Returns a list of attachments.
URI Parameters
- taskDefinitionId: required (string)
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 /taskDefintions/{taskDefinitionId}/attachments
Creates a new attachment.
URI Parameters
- taskDefinitionId: 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": {
"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 /taskDefintions/{taskDefinitionId}/attachments/{attachmentId}
Returns the details for a specific attachment.
URI Parameters
- taskDefinitionId: required (string)
- 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 /taskDefintions/{taskDefinitionId}/attachments/{attachmentId}
Updates the comment for an existing attachment.
URI Parameters
- taskDefinitionId: required (string)
- 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 /taskDefintions/{taskDefinitionId}/attachments/{attachmentId}
Deletes an existing attachment.
URI Parameters
- taskDefinitionId: required (string)
- 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 /taskDefintions/{taskDefinitionId}/history
Returns a list of events.
URI Parameters
- taskDefinitionId: required (string)
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 a list of external IDs associated with an Account.
Creates new external ID.
get /taskDefintions/{taskDefinitionId}/externalIds
Returns a list of external IDs associated with an Account.
URI Parameters
- taskDefinitionId: 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
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 /taskDefintions/{taskDefinitionId}/externalIds
Creates new external ID.
URI Parameters
- taskDefinitionId: 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": {
"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 /taskDefintions/{taskDefinitionId}/externalIds/{key}
Returns the details for a specific external ID.
URI Parameters
- taskDefinitionId: required (string)
- 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 /taskDefintions/{taskDefinitionId}/externalIds/{key}
Updates the Account/System Property
URI Parameters
- taskDefinitionId: required (string)
- 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 /taskDefintions/{taskDefinitionId}/externalIds/{key}
Deletes a specific external ID.
URI Parameters
- taskDefinitionId: required (string)
- 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.
Timelines
This resource is used for viewing, creating and managing timelines
Returns the details of all timelines.
Enables a user to create a new timeline.
get /timelines
Returns the details of all timelines.
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 /timelines
Enables a user to create a new timeline.
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['displayName']: required (string)
This is the display name for the timeline.
-
MatrixParam['type']: required (string)
This is the type of timeline. The types are as follows - METADATA, CLIP, ANNOTATION.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"name": {
"type": "string",
"required": true
},
"metadataDefinitionId": {
"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 details of a specific timeline.
Enables a user to update the details of a specific timeline.
Deletes a specific timeline.
get /timelines/{timelineId}
Returns the details of a specific timeline.
URI Parameters
- timelineId: 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 /timelines/{timelineId}
Enables a user to update the details of a specific timeline.
URI Parameters
- timelineId: 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": {
"name": {
"type": "string",
"required": true
},
"metadataDefinitionId": {
"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.
delete /timelines/{timelineId}
Deletes a specific timeline.
URI Parameters
- timelineId: 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.
Timed Actions
This resource is used for viewing, creating and managing Timed Actions
Returns a list of Timed Actions. Listing is based on supplied filters.
Creates a new Timed Action
get /timedActions
Returns a list of Timed 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['status']: (one of Started, Stopped, Failed)
The status of the timed action.
-
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 /timedActions
Creates a new Timed Action
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
},
"interval": {
"type": "integer",
"required": true
},
"pluginClass": {
"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.
Perform operations on a specific Timed Action
Returns details of the Timed Action
Update the details of a Timed Action
Deletes a Timed Action
get /timedActions/{timedActionId}
Returns details of the Timed Action
URI Parameters
-
timedActionId: required (integer)
Timed 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 /timedActions/{timedActionId}
Update the details of a Timed Action
URI Parameters
-
timedActionId: required (integer)
Timed 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
},
"interval": {
"type": "integer",
"required": false
},
"pluginClass": {
"type": "string",
"required": false
}
}
}
HTTP status code 200
Returns an updated Timed 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 /timedActions/{timedActionId}
Deletes a Timed Action
URI Parameters
-
timedActionId: required (integer)
Timed 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 - start, stop, delete, destroy.
get /timedActions/{timedActionId}/actions
Returns a list of actions that can be performed.
URI Parameters
-
timedActionId: required (integer)
Timed 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 /timedActions/{timedActionId}/actions
Performs an action. Possible action types are - start, stop, delete, destroy.
URI Parameters
-
timedActionId: required (integer)
Timed 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 /timedActions/{timedActionId}/comments
Returns a list of Comments.
URI Parameters
-
timedActionId: required (integer)
Timed 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 /timedActions/{timedActionId}/comments
Adds a new Comment.
URI Parameters
-
timedActionId: required (integer)
Timed 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 /timedActions/{timedActionId}/comments/{commentId}
Returns a Comment.
URI Parameters
-
timedActionId: required (integer)
Timed 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 Metadata Definition.
post /timedActions/{timedActionId}/copy
Copies an existing Metadata Definition.
URI Parameters
-
timedActionId: required (integer)
Timed 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 /timedActions/{timedActionId}/followers
Returns a list of users that are following this object.
URI Parameters
-
timedActionId: required (integer)
Timed 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 /timedActions/{timedActionId}/attachments
Returns a list of attachments.
URI Parameters
-
timedActionId: required (integer)
Timed 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 /timedActions/{timedActionId}/attachments
Creates a new attachment.
URI Parameters
-
timedActionId: required (integer)
Timed 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 /timedActions/{timedActionId}/attachments/{attachmentId}
Returns the details for a specific attachment.
URI Parameters
-
timedActionId: required (integer)
Timed 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 /timedActions/{timedActionId}/attachments/{attachmentId}
Updates the comment for an existing attachment.
URI Parameters
-
timedActionId: required (integer)
Timed 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 /timedActions/{timedActionId}/attachments/{attachmentId}
Deletes an existing attachment.
URI Parameters
-
timedActionId: required (integer)
Timed 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 /timedActions/{timedActionId}/history
Returns a list of events.
URI Parameters
-
timedActionId: required (integer)
Timed 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.
A collection of reference object links.
Returns a list of references.
get /timedActions/{timedActionId}/references
Returns a list of references.
URI Parameters
-
timedActionId: required (integer)
Timed 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.
Set or get configuration of the timed-action.
Returns the timed-action's 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 /timedActions/{timedActionId}/configuration
Returns the timed-action's configuration including a href to the configuration.
URI Parameters
-
timedActionId: required (integer)
Timed 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 /timedActions/{timedActionId}/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
-
timedActionId: required (integer)
Timed 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 a list of external IDs associated with an Account.
Creates new external ID.
get /timedActions/{timedActionId}/externalIds
Returns a list of external IDs associated with an Account.
URI Parameters
-
timedActionId: required (integer)
Timed 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 /timedActions/{timedActionId}/externalIds
Creates new external ID.
URI Parameters
-
timedActionId: required (integer)
Timed 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 /timedActions/{timedActionId}/externalIds/{key}
Returns the details for a specific external ID.
URI Parameters
-
timedActionId: required (integer)
Timed 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 /timedActions/{timedActionId}/externalIds/{key}
Updates the Account/System Property
URI Parameters
-
timedActionId: required (integer)
Timed 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 /timedActions/{timedActionId}/externalIds/{key}
Deletes a specific external ID.
URI Parameters
-
timedActionId: required (integer)
Timed 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.
Users
This resource is used for managing Users
Returns a list of Users. Listing is based on supplied filters.
Creates a new user
get /users
Returns a list of Users. Listing is based on supplied filters.
Query Parameters
- 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['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['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 /users
Creates a new user
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
},
"accountId": {
"type": "string",
"required": false
},
"roleId": {
"type": "long",
"required": true
},
"variant": {
"type": "string",
"required": false
},
"metadataDefinitionId": {
"type": "long",
"required": false
},
"firstName": {
"type": "string",
"required": true
},
"lastName": {
"type": "string",
"required": true
},
"email": {
"type": "string",
"required": true
},
"phoneNumber": {
"type": "string",
"required": false
},
"company": {
"type": "string",
"required": false
},
"addressLine1": {
"type": "string",
"required": false
},
"addressLine2": {
"type": "string",
"required": false
},
"addressLine3": {
"type": "string",
"required": false
},
"locale": {
"type": "string",
"required": false
},
"timezone": {
"type": "string",
"required": false
},
"accountExpiryDate": {
"type": "string",
"required": false
},
"emailNotificationInfo": {
"type": "boolean",
"required": false
},
"emailNotificationWarning": {
"type": "boolean",
"required": false
},
"emailNotificationError": {
"type": "boolean",
"required": false
},
"emailNotificationInfo": {
"type": "boolean",
"required": false
},
"smsNotificationWarning": {
"type": "boolean",
"required": false
},
"smsNotificationError": {
"type": "boolean",
"required": false
},
"quote": {
"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.
Perform operations on a specific User
Returns User object details.
Deletes a User
updates the user that the Id belongs to.
get /users/{userId}
Returns User object details.
URI Parameters
- userId: 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 /users/{userId}
Deletes a User
URI Parameters
- userId: 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 /users/{userId}
updates the user that the Id belongs to.
URI Parameters
- userId: 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": {
"name": {
"type": "string",
"required": true
},
"accountId": {
"type": "string",
"required": false
},
"roleId": {
"type": "long",
"required": true
},
"variant": {
"type": "string",
"required": false
},
"metadataDefinitionId": {
"type": "long",
"required": false
},
"firstName": {
"type": "string",
"required": true
},
"lastName": {
"type": "string",
"required": true
},
"email": {
"type": "string",
"required": true
},
"phoneNumber": {
"type": "string",
"required": false
},
"company": {
"type": "string",
"required": false
},
"addressLine1": {
"type": "string",
"required": false
},
"addressLine2": {
"type": "string",
"required": false
},
"addressLine3": {
"type": "string",
"required": false
},
"locale": {
"type": "string",
"required": false
},
"timezone": {
"type": "string",
"required": false
},
"accountExpiryDate": {
"type": "string",
"required": false
},
"emailNotificationInfo": {
"type": "boolean",
"required": false
},
"emailNotificationWarning": {
"type": "boolean",
"required": false
},
"emailNotificationError": {
"type": "boolean",
"required": false
},
"emailNotificationInfo": {
"type": "boolean",
"required": false
},
"smsNotificationWarning": {
"type": "boolean",
"required": false
},
"smsNotificationError": {
"type": "boolean",
"required": false
},
"quote": {
"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 actions that can be performed.
Performs an action. Possible action types are - enable, disable, delete, retry, destroy.
get /users/{userId}/actions
Returns a list of actions that can be performed.
URI Parameters
- userId: 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 /users/{userId}/actions
Performs an action. Possible action types are - enable, disable, delete, retry, destroy.
URI Parameters
- userId: 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.
A collection of comment.
Returns a list of Comments.
Adds a new Comment.
get /users/{userId}/comments
Returns a list of Comments.
URI Parameters
- userId: required (string)
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 /users/{userId}/comments
Adds a new Comment.
URI Parameters
- userId: 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.
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 /users/{userId}/comments/{commentId}
Returns a Comment.
URI Parameters
- userId: required (string)
-
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 /users/{userId}/copy
Copies an existing Action.
URI Parameters
- userId: 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": {
"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 /users/{userId}/followers
Returns a list of users that are following this object.
URI Parameters
- userId: required (string)
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 /users/{userId}/attachments
Returns a list of attachments.
URI Parameters
- userId: required (string)
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 /users/{userId}/attachments
Creates a new attachment.
URI Parameters
- userId: 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": {
"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 /users/{userId}/attachments/{attachmentId}
Returns the details for a specific attachment.
URI Parameters
- userId: required (string)
- 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 /users/{userId}/attachments/{attachmentId}
Updates the comment for an existing attachment.
URI Parameters
- userId: required (string)
- 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 /users/{userId}/attachments/{attachmentId}
Deletes an existing attachment.
URI Parameters
- userId: required (string)
- 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 /users/{userId}/history
Returns a list of events.
URI Parameters
- userId: required (string)
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 /users/{userId}/references
Returns a list of references.
URI Parameters
- userId: required (string)
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 associated with the user, 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 /users/{userId}/metadata
Returns the metadata associated with the user, including a href link to the metadata definition.
URI Parameters
- userId: required (string)
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 /users/{userId}/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
- userId: required (string)
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 group object links.
Returns a list of groups associated with the user. Listing composed of href links to the group resource and is based on supplied filters.
get /users/{userId}/groups
Returns a list of groups associated with the user. Listing composed of href links to the group resource and is based on supplied filters.
URI Parameters
- userId: required (string)
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['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).
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 a list of workspaces associated with the user. Listing composed of href links to the workspace resource and is based on supplied filters.
get /users/{userId}/workspaces
Returns a list of workspaces associated with the user. Listing composed of href links to the workspace resource and is based on supplied filters.
URI Parameters
- userId: required (string)
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['variant']: (string)
- MatrixParam['userId']: (integer - minimum: 0)
- 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 accessibleWorkspace object links.
Returns a list of accessible workspaces for the user. Listing composed of href links to the workspace resource and is based on supplied filters.
get /users/{userId}/accessibleWorkspaces
Returns a list of accessible workspaces for the user. Listing composed of href links to the workspace resource and is based on supplied filters.
URI Parameters
- userId: required (string)
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.
Returns the user's picture if one has been uploaded.
Updates the user profile picture.
get /users/{userId}/image
Returns the user's picture if one has been uploaded.
URI Parameters
- userId: 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 /users/{userId}/image
Updates the user profile picture.
URI Parameters
- userId: required (string)
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
Body
Type: multipart/form-data
Form Parameters-
file: required (file)
The image file to be uploaded. The key must be called 'file'. Value must be changed to 'File'.
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 an image.
get /users/{userId}/image/{imageId}
URI Parameters
- userId: required (string)
- imageId: 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 activity.
Returns a list of user's events. Listing is based on supplied filters.
get /users/{userId}/activity
Returns a list of user's events. Listing is based on supplied filters.
URI Parameters
- userId: required (string)
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.
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 following object links.
Returns a list of objects that are followed by the specific user. Listing is based on supplied filters.
get /users/{userId}/following
Returns a list of objects that are followed by the specific user. Listing is based on supplied filters.
URI Parameters
- userId: required (string)
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.
Returns a list of external IDs associated with an Account.
Creates new external ID.
get /users/{userId}/externalIds
Returns a list of external IDs associated with an Account.
URI Parameters
- userId: 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
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 /users/{userId}/externalIds
Creates new external ID.
URI Parameters
- userId: 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": {
"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 /users/{userId}/externalIds/{key}
Returns the details for a specific external ID.
URI Parameters
- userId: required (string)
- 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 /users/{userId}/externalIds/{key}
Updates the Account/System Property
URI Parameters
- userId: required (string)
- 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 /users/{userId}/externalIds/{key}
Deletes a specific external ID.
URI Parameters
- userId: required (string)
- 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.
User Defined Object Type Definitions
This resource is used for managing user defined object type definitions.
Returns the hierarchy information associated with user defined object types.
Enables a user to create a new user defined object type.
get /userDefinedObjectTypes
Returns the hierarchy information associated with user defined object types.
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 /userDefinedObjectTypes
Enables a user to create a new user defined object type.
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": {
"runRuleExpression": {
"type": "string",
"required": true
},
"displayName": {
"type": "string",
"required": true
},
"pluralName": {
"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 hierarchy information associated with a sepcific user defined object type.
Enables a user to update the information for a specific user defined object type.
get /userDefinedObjectTypes/{userDefinedObjectTypeId}
Returns the hierarchy information associated with a sepcific user defined object type.
URI Parameters
- userDefinedObjectTypeId: 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 /userDefinedObjectTypes/{userDefinedObjectTypeId}
Enables a user to update the information for a specific user defined object type.
URI Parameters
- userDefinedObjectTypeId: 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": {
"runRuleExpression": {
"type": "string",
"required": true
},
"displayName": {
"type": "string",
"required": true
},
"pluralName": {
"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.
User Defined Object Type Instances
This resource is used for managing user defined object type instances.
Returns a list of custom objects created by a user. For example if a user creates a custom object type called 'Episodes', you would simply need to type 'api/episodes/' in order to view all objects of that type.
Creates a new user defined object. Fields are as follows- name, description, parentObjectId, accountId, and workspaceId.
get /{userDefinedObjectTypePluralName}
Returns a list of custom objects created by a user. For example if a user creates a custom object type called 'Episodes', you would simply need to type 'api/episodes/' in order to view all objects of that type.
URI Parameters
- userDefinedObjectTypePluralName: required (string)
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['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 /{userDefinedObjectTypePluralName}
Creates a new user defined object. Fields are as follows- name, description, parentObjectId, accountId, and workspaceId.
URI Parameters
- userDefinedObjectTypePluralName: 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": {
"parentObjectId": {
"type": "long",
"required": false
},
"accountId": {
"type": "long",
"required": false
},
"workspaceId": {
"type": "long",
"required": false
},
"String 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.
Enables a user to delete a user defined object instance by specifying the ID of the instance.
delete /{userDefinedObjectTypePluralName}/{instanceId}
Enables a user to delete a user defined object instance by specifying the ID of the instance.
URI Parameters
- userDefinedObjectTypePluralName: required (string)
- instanceId: 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.
Enables a user to destroy a User Defined Object Type Instance. You can do this by specifying "destroy" in the action field in the body of the call.
post /{userDefinedObjectTypePluralName}/{instanceId}/actions
Enables a user to destroy a User Defined Object Type Instance. You can do this by specifying "destroy" in the action field in the body of the call.
URI Parameters
- userDefinedObjectTypePluralName: required (string)
- instanceId: 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.
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 details of a specific User Defined Object. For example if you wanted to view the details for a specific custom object such as an individual episode, you would type 'api/episodes/{userDefinedObjectTypePluralNameId}. You can also list multiple User Defined Objects by entering a list of User Defined Object ids separated by a semicolon e.g /api/episodes;id=1234;id=2345;id=3456
Updates a specific user defined object. Fields are as follows- name, description.
get /{userDefinedObjectTypePluralName}/{userDefinedObjectTypePluralNameId}
Returns details of a specific User Defined Object. For example if you wanted to view the details for a specific custom object such as an individual episode, you would type 'api/episodes/{userDefinedObjectTypePluralNameId}. You can also list multiple User Defined Objects by entering a list of User Defined Object ids separated by a semicolon e.g /api/episodes;id=1234;id=2345;id=3456
URI Parameters
- userDefinedObjectTypePluralName: required (string)
- userDefinedObjectTypePluralNameId: 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 /{userDefinedObjectTypePluralName}/{userDefinedObjectTypePluralNameId}
Updates a specific user defined object. Fields are as follows- name, description.
URI Parameters
- userDefinedObjectTypePluralName: required (string)
- userDefinedObjectTypePluralNameId: 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": {
"String 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 data for a specific user defined object.
Updates the data for a specific user defined object.
get /{userDefinedObjectTypePluralName}/data
Returns a list of data for a specific user defined object.
URI Parameters
- userDefinedObjectTypePluralName: 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 /{userDefinedObjectTypePluralName}/data
Updates the data for a specific user defined object.
URI Parameters
- userDefinedObjectTypePluralName: 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 about a specific user defined object.
Posts a new comment on a specific user defined object.
get /{userDefinedObjectTypePluralName}/comments
Returns a list of comments about a specific user defined object.
URI Parameters
- userDefinedObjectTypePluralName: required (string)
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 /{userDefinedObjectTypePluralName}/comments
Posts a new comment on a specific user defined object.
URI Parameters
- userDefinedObjectTypePluralName: 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.
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.
Returns a list of details for a specific comment.
Updates an existing comment on a specific user defined object.
Deletes an existing comment on a specific user defined object.
get /{userDefinedObjectTypePluralName}/comments/{commentId}
Returns a list of details for a specific comment.
URI Parameters
- userDefinedObjectTypePluralName: 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 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 /{userDefinedObjectTypePluralName}/comments/{commentId}
Updates an existing comment on a specific user defined object.
URI Parameters
- userDefinedObjectTypePluralName: 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 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 /{userDefinedObjectTypePluralName}/comments/{commentId}
Deletes an existing comment on a specific user defined object.
URI Parameters
- userDefinedObjectTypePluralName: 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 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 User Defined Object.
post /{userDefinedObjectTypePluralName}/copy
Copies an existing User Defined Object.
URI Parameters
- userDefinedObjectTypePluralName: 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": {
"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 who are currently following a specific user defined object.
get /{userDefinedObjectTypePluralName}/followers
Returns a list of users who are currently following a specific user defined object.
URI Parameters
- userDefinedObjectTypePluralName: required (string)
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 the details for the history of a specific user defined object.
get /{userDefinedObjectTypePluralName}/history
Returns the details for the history of a specific user defined object.
URI Parameters
- userDefinedObjectTypePluralName: required (string)
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 for a specific user defined object.
Creates a new attachment.
get /{userDefinedObjectTypePluralName}/attachments
Returns a list of attachments for a specific user defined object.
URI Parameters
- userDefinedObjectTypePluralName: required (string)
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 /{userDefinedObjectTypePluralName}/attachments
Creates a new attachment.
URI Parameters
- userDefinedObjectTypePluralName: 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": {
"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.
A collection of reference.
Returns of references for a specific user defined object.
get /{userDefinedObjectTypePluralName}/references
Returns of references for a specific user defined object.
URI Parameters
- userDefinedObjectTypePluralName: required (string)
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 a list of external IDs associated with an Account.
Creates new external ID.
get /{userDefinedObjectTypePluralName}/externalIds
Returns a list of external IDs associated with an Account.
URI Parameters
- userDefinedObjectTypePluralName: 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
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 /{userDefinedObjectTypePluralName}/externalIds
Creates new external ID.
URI Parameters
- userDefinedObjectTypePluralName: 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": {
"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 /{userDefinedObjectTypePluralName}/externalIds/{key}
Returns the details for a specific external ID.
URI Parameters
- userDefinedObjectTypePluralName: required (string)
- 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 /{userDefinedObjectTypePluralName}/externalIds/{key}
Updates the Account/System Property
URI Parameters
- userDefinedObjectTypePluralName: required (string)
- 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 /{userDefinedObjectTypePluralName}/externalIds/{key}
Deletes a specific external ID.
URI Parameters
- userDefinedObjectTypePluralName: required (string)
- 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.
Variants
This is used for viewing a list of Variants.
Returns a list of existing Variants.
Allows you to create a new variant.
get /variants
Returns a list of existing Variants.
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.
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.
post /variants
Allows you to create a new variant.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"properties": {
"objectTypeId": {
"type": "integer"
},
"name": {
"type": "string"
},
"defaultVariant": {
"type": "boolean"
},
"metadataDefinitionIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"defaultMetadataDefinition": {
"type": "integer"
}
},
"required": [
"objectTypeId",
"name"
]
}
HTTP status code 200
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"objectTypeId": 42,
"name": "bla",
"defaultVariant": true,
"metadataDefinitionIds": [ 1, 2, 3 ],
"defaultMetadataDefinition": 3
}
Returns the details of a particular Variant.
Allows you to edit a specific Variant.
Allows you to delete a specific variant.
put /variants/{variantId}
Allows you to edit a specific Variant.
URI Parameters
- variantId: required (string)
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"properties": {
"objectTypeId": {
"type": "integer"
},
"name": {
"type": "string"
},
"defaultVariant": {
"type": "boolean"
},
"metadataDefinitionIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"defaultMetadataDefinition": {
"type": "integer"
}
},
"required": [
"objectTypeId",
"name"
]
}
HTTP status code 200
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"objectTypeId": 42,
"name": "bla",
"defaultVariant": true,
"metadataDefinitionIds": [ 1, 2, 3 ],
"defaultMetadataDefinition": 3
}
Copies an existing Variant.
post /variants/copy
Copies an existing Variant.
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 /variants/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 /variants/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 /variants/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 /variants/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 /variants/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.
Wizards
This resource is used for viewing Wizards
Returns a list of Wizards. Listing is based on supplied filters.
Creates a new Wizard. When specifying the details for your new Wizard, you must indicate if the Wizard is a Toolbar Wizard, a Task Wizard, or a Stand Alone Wizard. Possible action types are - enable, disable, start, stop, delete, retry, cancel, schedule, approve, unapprove, destroy.
get /wizards
Returns a list of Wizards. 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['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 /wizards
Creates a new Wizard. When specifying the details for your new Wizard, you must indicate if the Wizard is a Toolbar Wizard, a Task Wizard, or a Stand Alone Wizard. Possible action types are - enable, disable, start, stop, delete, retry, cancel, schedule, approve, unapprove, destroy.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"accountId": {
"type": "string",
"required": true
},
"name": {
"type": "string",
"required": true
},
"description": {
"type": "string",
"required": false
},
"pluginClass": {
"type": "string",
"required": true
},
"visibilityIds": {
"type": "long",
"required": true
},
"standAloneWizard": {
"type": "boolean",
"required": false
},
"taskWizard": {
"type": "boolean",
"required": false
},
"toolbarWizard": {
"type": "boolean",
"required": false
},
"runRuleExpression": {
"type": "string",
"required": false
}
}
}
Returns details of a specific Wizard
Updates the details for an existing Wizard. Possible action types are - enable, disable, start, stop, delete, retry, cancel, schedule, approve, unapprove, destroy.
Deletes a Wizard
get /wizards/{wizardId}
Returns details of a specific Wizard
URI Parameters
- wizardId: 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 /wizards/{wizardId}
Updates the details for an existing Wizard. Possible action types are - enable, disable, start, stop, delete, retry, cancel, schedule, approve, unapprove, destroy.
URI Parameters
- wizardId: 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": {
"accountId": {
"type": "string",
"required": true
},
"name": {
"type": "string",
"required": true
},
"description": {
"type": "string",
"required": false
},
"pluginClass": {
"type": "string",
"required": true
},
"visibilityIds": {
"type": "long",
"required": true
},
"standAloneWizard": {
"type": "boolean",
"required": false
},
"taskWizard": {
"type": "boolean",
"required": false
},
"toolbarWizard": {
"type": "boolean",
"required": false
},
"runRuleExpression": {
"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 /wizards/{wizardId}
Deletes a Wizard
URI Parameters
- wizardId: 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 actions that can be performed.
Performs an action. Possible action types are - enable, disable, start, stop, delete, retry, cancel, schedule, approve, unapprove, destroy.
get /wizards/{wizardId}/actions
Returns a list of actions that can be performed.
URI Parameters
- wizardId: 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 /wizards/{wizardId}/actions
Performs an action. Possible action types are - enable, disable, start, stop, delete, retry, cancel, schedule, approve, unapprove, destroy.
URI Parameters
- wizardId: 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.
A collection of comment.
Returns a list of Comments.
Adds a new Comment.
get /wizards/{wizardId}/comments
Returns a list of Comments.
URI Parameters
- wizardId: required (string)
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 /wizards/{wizardId}/comments
Adds a new Comment.
URI Parameters
- wizardId: 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.
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 /wizards/{wizardId}/comments/{commentId}
Returns a Comment.
URI Parameters
- wizardId: required (string)
-
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 Wizard.
post /wizards/{wizardId}/copy
Copies an existing Wizard.
URI Parameters
- wizardId: 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": {
"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 /wizards/{wizardId}/followers
Returns a list of users that are following this object.
URI Parameters
- wizardId: required (string)
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 /wizards/{wizardId}/attachments
Returns a list of attachments.
URI Parameters
- wizardId: required (string)
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 /wizards/{wizardId}/attachments
Creates a new attachment.
URI Parameters
- wizardId: 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": {
"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 /wizards/{wizardId}/attachments/{attachmentId}
Returns the details for a specific attachment.
URI Parameters
- wizardId: required (string)
- 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 /wizards/{wizardId}/attachments/{attachmentId}
Updates the comment for an existing attachment.
URI Parameters
- wizardId: required (string)
- 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 /wizards/{wizardId}/attachments/{attachmentId}
Deletes an existing attachment.
URI Parameters
- wizardId: required (string)
- 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 /wizards/{wizardId}/history
Returns a list of events.
URI Parameters
- wizardId: required (string)
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 /wizards/{wizardId}/references
Returns a list of references.
URI Parameters
- wizardId: required (string)
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 all active Wizard instances
get /wizards/{wizardId}/instances
Returns all active Wizard instances
URI Parameters
- wizardId: 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 external IDs associated with an Account.
Creates new external ID.
get /wizards/{wizardId}/externalIds
Returns a list of external IDs associated with an Account.
URI Parameters
- wizardId: 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
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 /wizards/{wizardId}/externalIds
Creates new external ID.
URI Parameters
- wizardId: 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": {
"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 /wizards/{wizardId}/externalIds/{key}
Returns the details for a specific external ID.
URI Parameters
- wizardId: required (string)
- 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 /wizards/{wizardId}/externalIds/{key}
Updates the Account/System Property
URI Parameters
- wizardId: required (string)
- 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 /wizards/{wizardId}/externalIds/{key}
Deletes a specific external ID.
URI Parameters
- wizardId: required (string)
- 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.
Workflows
This resource is used for viewing Workflows
Returns a list of Workflows. Listing is based on supplied filters.
Creates a new workflow.
get /workflows
Returns a list of Workflows. 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']: (integer - minimum: 0)
-
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)
- MatrixParam['definitionVersion']: (integer - minimum: 0)
-
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 Running, Ended, Failed, Cancelled, Cancelling, Completed)
You can search for multiple statuses.
-
MatrixParam['id']: (string)
Filtering by multiple Ids.Example- /api/workflows;id=1234;id=2345;id=3456
-
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)
-
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 /workflows
Creates a new workflow.
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"definitionId": {
"type": "integer",
"required": true
},
"assetId": {
"type": "integer",
"required": false
},
"stringVariables": {
"type": "object",
"required": false
},
"objectVariables": {
"type": "object",
"required": false
},
"accountId": {
"type": "integer",
"required": false
},
"workspaceId": {
"type": "integer",
"required": false
}
}
}
HTTP status code 201
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
}
}
}
View details of a Workflow group.
Creates a Workflow group.
post /workflows/groups
Creates a Workflow 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": {
"maxWorkflows": {
"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": "long",
"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.
Returns the details for a specific Workflow group.
Updates the details of a Workflow group.
get /workflows/groups/{groupId}
Returns the details for a specific Workflow group.
URI Parameters
- groupId: 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 /workflows/groups/{groupId}
Updates the details of a Workflow group.
URI Parameters
- groupId: 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": {
"maxWorkflows": {
"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.
View details of a specific Workflow
Returns details of the workflow including a href link to the asset and a href link to the workflow definition.
get /workflows/{workflowId}
Returns details of the workflow including a href link to the asset and a href link to the workflow definition.
URI Parameters
-
workflowId: required (integer)
Workflow 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 /workflows/{workflowId}/actions
Returns a list of actions that can be performed.
URI Parameters
-
workflowId: required (integer)
Workflow 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 /workflows/{workflowId}/actions
Performs an action. Possible action types are - enable, disable, start, stop, delete, retry, cancel, schedule, approve, unapprove, destroy.
URI Parameters
-
workflowId: required (integer)
Workflow 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 /workflows/{workflowId}/comments
Returns a list of Comments.
URI Parameters
-
workflowId: required (integer)
Workflow 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 /workflows/{workflowId}/comments
Adds a new Comment.
URI Parameters
-
workflowId: required (integer)
Workflow 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 /workflows/{workflowId}/comments/{commentId}
Returns a Comment.
URI Parameters
-
workflowId: required (integer)
Workflow 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 Workflow.
post /workflows/{workflowId}/copy
Copies an existing Workflow.
URI Parameters
-
workflowId: required (integer)
Workflow 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 /workflows/{workflowId}/followers
Returns a list of users that are following this object.
URI Parameters
-
workflowId: required (integer)
Workflow 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 /workflows/{workflowId}/attachments
Returns a list of attachments.
URI Parameters
-
workflowId: required (integer)
Workflow 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 /workflows/{workflowId}/attachments
Creates a new attachment.
URI Parameters
-
workflowId: required (integer)
Workflow 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 /workflows/{workflowId}/attachments/{attachmentId}
Returns the details for a specific attachment.
URI Parameters
-
workflowId: required (integer)
Workflow 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 /workflows/{workflowId}/attachments/{attachmentId}
Updates the comment for an existing attachment.
URI Parameters
-
workflowId: required (integer)
Workflow 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 /workflows/{workflowId}/attachments/{attachmentId}
Deletes an existing attachment.
URI Parameters
-
workflowId: required (integer)
Workflow 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 /workflows/{workflowId}/history
Returns a list of events.
URI Parameters
-
workflowId: required (integer)
Workflow 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 /workflows/{workflowId}/references
Returns a list of references.
URI Parameters
-
workflowId: required (integer)
Workflow 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.
View the jobs for the workflow instance.
Returns a list of jobs for the current workflow. The listing composed of href links to the job resource and based on supplied filters.
get /workflows/{workflowId}/jobs
Returns a list of jobs for the current workflow. The listing composed of href links to the job resource and based on supplied filters.
URI Parameters
-
workflowId: required (integer)
Workflow 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.
Returns the JSON representation of a workflow instance. Each node will link to an array of running jobs or tasks.
Returns the workflow nodes found by specified id.
get /workflows/{workflowId}/structure
Returns the workflow nodes found by specified id.
URI Parameters
-
workflowId: required (integer)
Workflow 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.
Perform operations on Workflow signals.
Returns a list of signals for the workflow.
Signal the workflow.
get /workflows/{workflowId}/signals
Returns a list of signals for the workflow.
URI Parameters
-
workflowId: required (integer)
Workflow 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 /workflows/{workflowId}/signals
Signal the workflow.
URI Parameters
-
workflowId: required (integer)
Workflow 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": {
"nodeName": {
"type": "string",
"required": true
},
"variables": {
"type": "object",
"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 a hashmap of all the JBPM variables for that Workflow.
get /workflows/{workflowId}/variables
Returns a hashmap of all the JBPM variables for that Workflow.
URI Parameters
-
workflowId: required (integer)
Workflow 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 /workflows/{workflowId}/externalIds
Returns a list of external IDs associated with an Account.
URI Parameters
-
workflowId: required (integer)
Workflow 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 /workflows/{workflowId}/externalIds
Creates new external ID.
URI Parameters
-
workflowId: required (integer)
Workflow 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 /workflows/{workflowId}/externalIds/{key}
Returns the details for a specific external ID.
URI Parameters
-
workflowId: required (integer)
Workflow 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 /workflows/{workflowId}/externalIds/{key}
Updates the Account/System Property
URI Parameters
-
workflowId: required (integer)
Workflow 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 /workflows/{workflowId}/externalIds/{key}
Deletes a specific external ID.
URI Parameters
-
workflowId: required (integer)
Workflow 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.
Workflow Definitions
Perform operations on Workflow Definitions
Returns a list of Workflow Definitions. Listing is based on supplied filters.
Create a new Workflow Definition
get /workflowDefinitions
Returns a list of Workflow 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 workflow definitions with references, you would do the following /api/workflowDefinitions?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 /workflowDefinitions
Create a new 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
},
"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 Workflow Definition
Returns the details of an Workflow Definition. This includes a list of nodes with href links to the corresponding action.You can also list multiple Workflow definitions by entering a number of Workflow Definition ids separated by a semicolon e.g /api/workflowDefinitions;id=1234;id=2345;id=3456
Update the details of the Workflow Definition
Deletes the Workflow Definition
get /workflowDefinitions/{workflowDefinitionId}
Returns the details of an Workflow Definition. This includes a list of nodes with href links to the corresponding action.You can also list multiple Workflow definitions by entering a number of Workflow Definition ids separated by a semicolon e.g /api/workflowDefinitions;id=1234;id=2345;id=3456
URI Parameters
-
workflowDefinitionId: required (integer)
Workflow Definition 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 /workflowDefinitions/{workflowDefinitionId}
Update the details of the Workflow Definition
URI Parameters
-
workflowDefinitionId: required (integer)
Workflow Definition 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
},
"visibilityIds": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 0,
"uniqueItems": true,
"required": false
}
}
}
HTTP status code 200
Returns an updated Workflow Definition
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 /workflowDefinitions/{workflowDefinitionId}
Deletes the Workflow Definition
URI Parameters
-
workflowDefinitionId: required (integer)
Workflow Definition 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 /workflowDefinitions/{workflowDefinitionId}/actions
Returns a list of actions that can be performed.
URI Parameters
-
workflowDefinitionId: required (integer)
Workflow Definition 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 /workflowDefinitions/{workflowDefinitionId}/actions
Performs an action. Possible action types are - enable, disable, start, stop, delete, retry, cancel, schedule, approve, unapprove, destroy.
URI Parameters
-
workflowDefinitionId: required (integer)
Workflow Definition 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 /workflowDefinitions/{workflowDefinitionId}/comments
Returns a list of Comments.
URI Parameters
-
workflowDefinitionId: required (integer)
Workflow Definition 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 /workflowDefinitions/{workflowDefinitionId}/comments
Adds a new Comment.
URI Parameters
-
workflowDefinitionId: required (integer)
Workflow Definition 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 /workflowDefinitions/{workflowDefinitionId}/comments/{commentId}
Returns a Comment.
URI Parameters
-
workflowDefinitionId: required (integer)
Workflow Definition 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 Workflow Definition.
post /workflowDefinitions/{workflowDefinitionId}/copy
Copies an existing Workflow Definition.
URI Parameters
-
workflowDefinitionId: required (integer)
Workflow Definition 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 /workflowDefinitions/{workflowDefinitionId}/followers
Returns a list of users that are following this object.
URI Parameters
-
workflowDefinitionId: required (integer)
Workflow Definition 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 /workflowDefinitions/{workflowDefinitionId}/attachments
Returns a list of attachments.
URI Parameters
-
workflowDefinitionId: required (integer)
Workflow Definition 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 /workflowDefinitions/{workflowDefinitionId}/attachments
Creates a new attachment.
URI Parameters
-
workflowDefinitionId: required (integer)
Workflow Definition 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 /workflowDefinitions/{workflowDefinitionId}/attachments/{attachmentId}
Returns the details for a specific attachment.
URI Parameters
-
workflowDefinitionId: required (integer)
Workflow Definition 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 /workflowDefinitions/{workflowDefinitionId}/attachments/{attachmentId}
Updates the comment for an existing attachment.
URI Parameters
-
workflowDefinitionId: required (integer)
Workflow Definition 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 /workflowDefinitions/{workflowDefinitionId}/attachments/{attachmentId}
Deletes an existing attachment.
URI Parameters
-
workflowDefinitionId: required (integer)
Workflow Definition 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 /workflowDefinitions/{workflowDefinitionId}/history
Returns a list of events.
URI Parameters
-
workflowDefinitionId: required (integer)
Workflow Definition 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.
Get the workflow definition graph image.
Updates the workflow-defintion. A valid XML metadata structure is expected in the body.
get /workflowDefinitions/{workflowDefinitionId}/image
Get the workflow definition graph image.
URI Parameters
-
workflowDefinitionId: required (integer)
Workflow Definition 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 /workflowDefinitions/{workflowDefinitionId}/image
Updates the workflow-defintion. A valid XML metadata structure is expected in the body.
URI Parameters
-
workflowDefinitionId: required (integer)
Workflow Definition 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 JSON representation of a workflow definition. Each node will link to an action or task-definition and contain a layout object. Available from 5.1.1 onwards- replaces /nodes.
Updates a Workflow Definition. Available from 5.1.1 onwards- replaces /nodes.
get /workflowDefinitions/{workflowDefinitionId}/structure
Returns the JSON representation of a workflow definition. Each node will link to an action or task-definition and contain a layout object. Available from 5.1.1 onwards- replaces /nodes.
URI Parameters
-
workflowDefinitionId: required (integer)
Workflow Definition ID
Body
Type: application/vnd.nativ.mio.v1+xml
put /workflowDefinitions/{workflowDefinitionId}/structure
Updates a Workflow Definition. Available from 5.1.1 onwards- replaces /nodes.
URI Parameters
-
workflowDefinitionId: required (integer)
Workflow Definition ID
Body
Type: application/vnd.nativ.mio.v1+xml
Returns a list of external IDs associated with an Account.
Creates new external ID.
get /workflowDefinitions/{workflowDefinitionId}/externalIds
Returns a list of external IDs associated with an Account.
URI Parameters
-
workflowDefinitionId: required (integer)
Workflow Definition 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 /workflowDefinitions/{workflowDefinitionId}/externalIds
Creates new external ID.
URI Parameters
-
workflowDefinitionId: required (integer)
Workflow Definition 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 /workflowDefinitions/{workflowDefinitionId}/externalIds/{key}
Returns the details for a specific external ID.
URI Parameters
-
workflowDefinitionId: required (integer)
Workflow Definition 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 /workflowDefinitions/{workflowDefinitionId}/externalIds/{key}
Updates the Account/System Property
URI Parameters
-
workflowDefinitionId: required (integer)
Workflow Definition 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 /workflowDefinitions/{workflowDefinitionId}/externalIds/{key}
Deletes a specific external ID.
URI Parameters
-
workflowDefinitionId: required (integer)
Workflow Definition 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.
Workspaces
This resource is used for viewing and managing Workspaces
Returns a list of Workspaces. Listing is based on supplied filters.#
Creates a new Workspace
get /workspaces
Returns a list of Workspaces. Listing is based on supplied filters.#
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['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 /workspaces
Creates a new Workspace
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['accountId']: (integer - minimum: 0)
- 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.
Perform operations on a specific Workspace
Returns Workspace object details.
Updates a Workspace.
Deletes a Workspace
get /workspaces/{workspaceId}
Returns Workspace object details.
URI Parameters
-
workspaceId: required (integer)
Workspace 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 /workspaces/{workspaceId}
Updates a Workspace.
URI Parameters
-
workspaceId: required (integer)
Workspace 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": "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 /workspaces/{workspaceId}
Deletes a Workspace
URI Parameters
-
workspaceId: required (integer)
Workspace 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, approve, unapprove, destroy.
get /workspaces/{workspaceId}/actions
Returns a list of actions that can be performed.
URI Parameters
-
workspaceId: required (integer)
Workspace 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 /workspaces/{workspaceId}/actions
Performs an action. Possible action types are - enable, disable, delete, retry, approve, unapprove, destroy.
URI Parameters
-
workspaceId: required (integer)
Workspace 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 /workspaces/{workspaceId}/comments
Returns a list of Comments.
URI Parameters
-
workspaceId: required (integer)
Workspace 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 /workspaces/{workspaceId}/comments
Adds a new Comment.
URI Parameters
-
workspaceId: required (integer)
Workspace 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 /workspaces/{workspaceId}/comments/{commentId}
Returns a Comment.
URI Parameters
-
workspaceId: required (integer)
Workspace 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 Workspace.
post /workspaces/{workspaceId}/copy
Copies an existing Workspace.
URI Parameters
-
workspaceId: required (integer)
Workspace 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 /workspaces/{workspaceId}/followers
Returns a list of users that are following this object.
URI Parameters
-
workspaceId: required (integer)
Workspace 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 /workspaces/{workspaceId}/attachments
Returns a list of attachments.
URI Parameters
-
workspaceId: required (integer)
Workspace 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 /workspaces/{workspaceId}/attachments
Creates a new attachment.
URI Parameters
-
workspaceId: required (integer)
Workspace 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 /workspaces/{workspaceId}/attachments/{attachmentId}
Returns the details for a specific attachment.
URI Parameters
-
workspaceId: required (integer)
Workspace 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 /workspaces/{workspaceId}/attachments/{attachmentId}
Updates the comment for an existing attachment.
URI Parameters
-
workspaceId: required (integer)
Workspace 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 /workspaces/{workspaceId}/attachments/{attachmentId}
Deletes an existing attachment.
URI Parameters
-
workspaceId: required (integer)
Workspace 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 /workspaces/{workspaceId}/history
Returns a list of events.
URI Parameters
-
workspaceId: required (integer)
Workspace 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 /workspaces/{workspaceId}/references
Returns a list of references.
URI Parameters
-
workspaceId: required (integer)
Workspace 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 metadata of the workspace.
Returns the workspace's metadata including a href to the 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.
get /workspaces/{workspaceId}/metadata
Returns the workspace's metadata including a href to the metadata.
URI Parameters
-
workspaceId: required (integer)
Workspace 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 /workspaces/{workspaceId}/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
-
workspaceId: required (integer)
Workspace ID
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.
The workspace members
Returns the workspace members found by the specified ID.
get /workspaces/{workspaceId}/members
Returns the workspace members found by the specified ID.
URI Parameters
-
workspaceId: required (integer)
Workspace 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.
Returns a list of external IDs associated with an Account.
Creates new external ID.
get /workspaces/{workspaceId}/externalIds
Returns a list of external IDs associated with an Account.
URI Parameters
-
workspaceId: required (integer)
Workspace 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 /workspaces/{workspaceId}/externalIds
Creates new external ID.
URI Parameters
-
workspaceId: required (integer)
Workspace 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 /workspaces/{workspaceId}/externalIds/{key}
Returns the details for a specific external ID.
URI Parameters
-
workspaceId: required (integer)
Workspace 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 /workspaces/{workspaceId}/externalIds/{key}
Updates the Account/System Property
URI Parameters
-
workspaceId: required (integer)
Workspace 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 /workspaces/{workspaceId}/externalIds/{key}
Deletes a specific external ID.
URI Parameters
-
workspaceId: required (integer)
Workspace 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.