Dalet Flex Core
version 5.1
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)
-
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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
},
"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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Returns a list of actions that can be performed.
Performs an action. Possible action types are - enable, disable, delete, approve, unapprove.
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.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
post /accounts/{accountId}/actions
Performs an action. Possible action types are - enable, disable, delete, approve, unapprove.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
A collection of reference object links.
Returns a list of references.
get /accounts/{accountId}/references
Returns a list of references.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Returns the metadata associated with the Account, including an 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 an 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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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['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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
-
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)
- MatrixParam['userId']: (integer - minimum: 0)
- MatrixParam['variant']: (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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
-
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)
- 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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
-
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Account Properties
Used for performing operations on Account/System Properties.
Returns a list of Account/System Properties.
Create a new accountProperty.
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)
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
post /accountProperties
Create a new accountProperty.
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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['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)
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['type']: (string)
The action 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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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
},
"tineout": {
"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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Perform operations on a specific Action.
Returns details of the Action.
Update the details of the Action.
Deletes 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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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
},
"tineout": {
"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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
delete /actions/{actionId}
Deletes 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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
post /actions/{actionId}/actions
Performs an action. Possible action types are - enable, disable, start, stop, delete, retry, cancel, schedule, approve, unapprove.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
A collection of reference object links.
Returns a list of references.
get /actions/{actionId}/references
Returns a list of references.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Returns the metadata instance of the action including an 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 an 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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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['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)
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['includeMetadata']: (boolean)
Includes 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.
-
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 sprecific 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
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Perform operations on a specific Asset.
Returns the Asset object details (account, workspace, owner, title etc.), asset file information and technical information (media or image contexts). You can also list multiple assets by entering a list of Asset ids separated by a semicolon e.g /api/assets;id=1234;id=2345;id=3456
Update an Asset details (only editable properties).
get /assets/{assetId}
Returns the Asset object details (account, workspace, owner, title etc.), asset file information and technical information (media or image contexts). You can also list multiple assets by entering a list of Asset ids separated by a semicolon e.g /api/assets;id=1234;id=2345;id=3456
URI Parameters
-
assetId: required (integer)
Asset ID
Query Parameters
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['includeMetadata']: (boolean)
Include metadata in the response
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
put /assets/{assetId}
Update an Asset details (only editable properties).
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
},
"creationContext": {
"type": "string",
"required": false
},
"variant": {
"type": "string",
"required": false
},
"metadataDefinitionId": {
"type": "integer",
"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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Returns a list of actions that can be performed.
Performs an action. Possible action types are - delete, approve, unapprove.
get /assets/{assetId}/actions
Returns a list of actions that can be performed.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
post /assets/{assetId}/actions
Performs an action. Possible action types are - delete, approve, unapprove.
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": {
"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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Returns the metadata associated with the asset, including an 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 /assets/{assetId}/metadata
Returns the metadata associated with the asset, including an href link to the metadata definition.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
-
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
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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['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)
-
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['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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Operations on asset keyframes.
Returns a list of keyframes, based on supplied filters.
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)
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Returns details of the specific 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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Returns a list of Actions which can be executed on the asset based on its current state.
Returns a list of Actions which can be executed on the asset based on its current state.
get /assets/{assetId}/jobActions
Returns a list of Actions which 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)
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
-
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
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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": "object",
"required": true,
"properties": {
"id": {
"type": "integer",
"description": "The asset ID of the parent group.",
"required": true
},
"membershipName": {
"type": "string",
"required": false
}
}
}
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)
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
put /assets/{assetId}/parentGroups/{membershipId}
Updates the membership with the parent group.
URI Parameters
-
assetId: required (integer)
Asset ID
-
membershipId: 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": {
"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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
delete /assets/{assetId}/parentGroups/{membershipId}
Delete the membership with the parent group.
URI Parameters
-
assetId: required (integer)
Asset ID
-
membershipId: 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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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.
Creates a new membership with a child asset.
Delete the membership with the child member.
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)
-
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
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
post /assets/{assetId}/members
Creates a new membership with a child asset.
URI Parameters
-
assetId: required (integer)
Asset ID
Body
Type: application/vnd.nativ.mio.v1+json
Schema:
{
"type": "object",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": true
},
"membershipName": {
"type": "string",
"required": false
}
}
}
delete /assets/{assetId}/members
Delete the membership with the child member.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
-
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
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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
}
}
}
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)
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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['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)
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['status']: (one of Started, Stopped, Failed)
Status of the EventHandler.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Returns a list of actions that can be performed.
Performs an action. Possible action types are - delete.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
post /eventHandlers/{eventHandlerId}/actions
Performs an action. Possible action types are - delete.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Set or get the event configuration.
Returns the event handler configuration including an 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 an 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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
-
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)
- 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).
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Returns a list of actions that can be performed.
Performs an action. Possible action types are - enable, disable, delete, retry.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
post /groups/{groupId}/actions
Performs an action. Possible action types are - enable, disable, delete, retry.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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['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)
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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['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)
-
callback: (string)
Specifies the call back function for JSONP response.
-
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['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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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
},
"dateVariables": {
"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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 an href link to the asset, an href link to any parent job, href link to any associated workflow instance, an href link to the action and an Href links to any sub-jobs (in the case of a group job) would also be returned.
get /jobs/{jobId}
Returns details of the Job, including the action type, plugin, state etc. This includes an href link to the asset, an href link to any parent job, href link to any associated workflow instance, an href link to the action and an Href links to any sub-jobs (in the case of a group job) would also be returned.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
post /jobs/{jobId}/actions
Performs an action. Possible action types are - enable, disable, start, stop, delete, retry, cancel, schedule, approve, unapprove.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
A collection of comment.
Returns a list of Comments.
Adds a new Comment.
get /jobs/{jobId}/comments
Returns a list of Comments.
URI Parameters
-
jobId: required (integer)
Job 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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
post /jobs/{jobId}/comments
Adds a new Comment.
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": {
"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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Performs operations on a single Comment.
Returns a Comment.
get /jobs/{jobId}/comments/{commentId}
Returns a Comment.
URI Parameters
-
jobId: required (integer)
Job 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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
A collection of follower.
Returns a list of users that are following this object.
get /jobs/{jobId}/followers
Returns a list of users that are following this object.
URI Parameters
-
jobId: required (integer)
Job 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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
A collection of attachment.
Returns a list of attachments.
Creates a new attachment.
Updates the comment for an existing attachment.
Deletes an existing attachment.
get /jobs/{jobId}/attachments
Returns a list of attachments.
URI Parameters
-
jobId: required (integer)
Job 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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
post /jobs/{jobId}/attachments
Creates a new attachment.
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": {
"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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
put /jobs/{jobId}/attachments
Updates the comment for an existing attachment.
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": {
"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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
delete /jobs/{jobId}/attachments
Deletes an existing attachment.
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
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
A collection of reference object links.
Returns a list of references.
get /jobs/{jobId}/references
Returns a list of references.
URI Parameters
-
jobId: required (integer)
Job 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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Set or get the job metadata.
Returns the job configuration including an 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 an 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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
-
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Returns a list of actions that can be performed.
Performs an action. Possible action types are - delete.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
post /messageTemplates/{messageTemplateId}/actions
Performs an action. Possible action types are - delete.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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['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)
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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": "string"
},
"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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Perform operations on a specific Metadata Definition.
Returns the details of the Metadata Definition.
Updates the metadata instance associated with the metadataDefinitions. A valid XML metadata structure is expected in the body. The updated metadata will be returned if the request was successful.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
put /metadataDefinitions/{metadataDefinitionId}
Updates the metadata instance associated with the metadataDefinitions. 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
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
post /metadataDefinitions/{metadataDefinitionId}/actions
Performs an action. Possible action types are - enable, disable, start, stop, delete, retry, cancel, schedule, approve, unapprove.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
A collection of comment.
Returns a list of Comments.
Adds a new Comment.
get /metadataDefinitions/{metadataDefinitionId}/comments
Returns a list of Comments.
URI Parameters
-
metadataDefinitionId: required (integer)
Metadata 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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
post /metadataDefinitions/{metadataDefinitionId}/comments
Adds a new Comment.
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": {
"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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Performs operations on a single Comment.
Returns a Comment.
get /metadataDefinitions/{metadataDefinitionId}/comments/{commentId}
Returns a Comment.
URI Parameters
-
metadataDefinitionId: required (integer)
Metadata 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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
A collection of follower.
Returns a list of users that are following this object.
get /metadataDefinitions/{metadataDefinitionId}/followers
Returns a list of users that are following this object.
URI Parameters
-
metadataDefinitionId: required (integer)
Metadata 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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
A collection of attachment.
Returns a list of attachments.
Creates a new attachment.
get /metadataDefinitions/{metadataDefinitionId}/attachments
Returns a list of attachments.
URI Parameters
-
metadataDefinitionId: required (integer)
Metadata 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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
post /metadataDefinitions/{metadataDefinitionId}/attachments
Creates a new attachment.
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": {
"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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Returns the details for a specific attachment.
Updates the comment for an existing attachment.
Deletes an existing attachment.
get /metadataDefinitions/{metadataDefinitionId}/attachments/{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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
put /metadataDefinitions/{metadataDefinitionId}/attachments/{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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
delete /metadataDefinitions/{metadataDefinitionId}/attachments/{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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
A collection of reference object links.
Returns a list of references.
get /metadataDefinitions/{metadataDefinitionId}/references
Returns a list of references.
URI Parameters
-
metadataDefinitionId: required (integer)
Metadata 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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Object Types
This resource is used for viewing information about Object Types including custom Objects Types created by users.
Returns a list of existing Object Types.
get /objectTypes
Returns a list of existing 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)
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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['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)
-
callback: (string)
Specifies the call back function for JSONP response.
- MatrixParam['assedId']: (integer - minimum: 0)
- MatrixParam['assetTitle']: (string)
- MatrixParam['definitionId']: (integer - minimum: 0)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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['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)
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
post /playerDefinitions/{playerDefinitionId}/actions
Performs an action. Possible action types are - enable, disable, start, stop, delete, retry, cancel, schedule, approve, unapprove.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Set or get the player's configuration.
Returns the player's configuration including an 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 an 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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
-
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.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
-
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.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
post /profiles
Create a new profile.
Perform operations on a specific Profile.
Returns the details of the Profile.
Update the profile.
Delete 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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
delete /profiles/{profileId}
Delete 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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
post /profiles/{profileId}/actions
Performs an action. Possible action types are - enable, disable, start, stop, delete, retry, cancel, schedule, approve, unapprove.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Returns the metadata instance of the profile including an 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 an 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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Quotas
This resource is used for viewing and managing Quotas.
Returns a list of Quotas. Listing is based on supplied filters.
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['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)
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Perform operations on a specific Quota.
Returns Quota object details.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Returns a list of actions that can be performed.
Performs an action. Possible action types are - delete.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
post /quotas/{quotaId}/actions
Performs an action. Possible action types are - delete.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Set or get the quota's configuration.
Returns the quota's configuration including an 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 an 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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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['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)
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Returns a list of actions that can be performed.
Performs an action. Possible action types are - enable, disable, start, stop, delete.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
post /reportDefinitions/{reportDefinitionId}/actions
Performs an action. Possible action types are - enable, disable, start, stop, delete.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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['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)
-
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.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Returns a list of actions that can be performed.
Performs an action. Possible action types are - enable, disable, start, stop, delete.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
post /resources/{resourceId}/actions
Performs an action. Possible action types are - enable, disable, start, stop, delete.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
A collection of reference object links.
Returns a list of references.
get /resources/{resourceId}/references
Returns a list of references.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Returns the metadata instance of the resource including an 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 /resources/{resourceId}/configuration
Returns the metadata instance of the resource including an 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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
put /resources/{resourceId}/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
-
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.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['name']: (string)
Search for a specific name.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
post /roles
Creates a Role
Query Parameters
- MatrixParam['name']: (string)
- MatrixParam['description']: (string)
- MatrixParam['enabled']: (boolean)
- MatrixParam['deleted']: (boolean - default: false)
- MatrixParam['account']: (string)
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['accountId']: (integer - minimum: 0)
Search for a role inside of a specific account.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Returns a list of actions that can be performed.
Performs an action. Possible action types are - enable, disable, delete.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
post /roles/{roleId}/actions
Performs an action. Possible action types are - enable, disable, delete.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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['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)
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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['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)
-
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Task Definitions
This resource is used for viewing Task Definitions.
Returns a list of Task Definitions. Listing is based on supplied filters.
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['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)
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Returns details of a specific 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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
post /taskDefintions/{taskDefinitionId}/actions
Performs an action. Possible action types are - enable, disable, start, stop, delete, retry, cancel, schedule, approve, unapprove.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
A collection of reference object links.
Returns a list of references.
get /taskDefintions/{taskDefinitionId}/references
Returns a list of references.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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['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)
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['status']: (one of Started, Stopped, Failed)
The status of the timed action.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Returns a list of actions that can be performed.
Performs an action. Possible action types are - start, stop, delete.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
post /timedActions/{timedActionId}/actions
Performs an action. Possible action types are - start, stop, delete.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Set or get configuration of the timed-action.
Returns the timed-action's configuration including an 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 an 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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
-
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Returns a list of actions that can be performed.
Performs an action. Possible action types are - enable, disable, delete, retry.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
post /users/{userId}/actions
Performs an action. Possible action types are - enable, disable, delete, retry.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Returns the metadata associated with the user, including an 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 an 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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
-
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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['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)
-
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).
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
User Defined Object Types
This resource is used for viewing User Defined Object Types.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
-
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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
}
Wizards
This resource is used for viewing Wizards.
Returns a list of Wizards. Listing is based on supplied filters.
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['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)
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Returns details of a specific Wizard.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
post /wizards/{wizardId}/actions
Performs an action. Possible action types are - enable, disable, start, stop, delete, retry, cancel, schedule, approve, unapprove.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Workflows
This resource is used for viewing Workflows.
Returns a list of Workflows. Listing is based on supplied filters.
Create 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['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)
-
callback: (string)
Specifies the call back function for JSONP response.
-
MatrixParam['priority']: (string)
You can search for Workflows by priority. Priorities that can be searched for are as follows- highest, high, normal, low, lowest.
-
MatrixParam['nodeId']: (string)
You can search for a specific node by entering the ID. definitionId and definitionVersion must both be specified first.
- MatrixParam['definitionId']: (integer - minimum: 0)
- MatrixParam['definitionVersion']: (integer - minimum: 0)
-
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
post /workflows
Create 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
},
"dateVariables": {
"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 specific Workflow.
Returns details of the Workflow, including an href link to the asset and an href link to the workflow definition.
get /workflows/{workflowId}
Returns details of the Workflow, including an href link to the asset and an 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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
post /workflows/{workflowId}/actions
Performs an action. Possible action types are - enable, disable, start, stop, delete, retry, cancel, schedule, approve, unapprove.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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['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)
-
callback: (string)
Specifies the call back function for JSONP response.
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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": "string"
},
"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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
post /workflowDefinitions/{workflowDefinitionId}/actions
Performs an action. Possible action types are - enable, disable, start, stop, delete, retry, cancel, schedule, approve, unapprove.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
A collection of reference object links.
Returns a list of references.
get /workflowDefinitions/{workflowDefinitionId}/references
Returns a list of references.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Get the workflow definition graph image.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
View and create worflow-defintion nodes.
Returns the workflow-definition nodes found by specified id.
Updates the workflow-defintion. A valid XML metadata structure is expected in the body.
get /workflowDefinitions/{workflowDefinitionId}/nodes
Returns the workflow-definition nodes found by specified id.
URI Parameters
-
workflowDefinitionId: required (integer)
Workflow Definition 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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
put /workflowDefinitions/{workflowDefinitionId}/nodes
Updates the workflow-defintion. A valid XML metadata structure is expected in the body.
URI Parameters
-
workflowDefinitionId: required (integer)
Workflow Definition 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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
-
callback: (string)
Specifies the call back function for JSONP response.
- MatrixParam['accountId']: (integer - minimum: 0)
- MatrixParam['userId']: (integer - minimum: 0)
- MatrixParam['variant']: (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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Returns a list of actions that can be performed.
Performs an action. Possible action types are - enable, disable, delete, retry, approve, unapprove.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
post /workspaces/{workspaceId}/actions
Performs an action. Possible action types are - enable, disable, delete, retry, approve, unapprove.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
Set or get metadata of the workspace.
Returns the workspace's metadata including an 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 an 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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.
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['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)
HTTP status code 200
Request has been processed successfully.
HTTP status code 201
Request has been processed successfully and a new resource has been created.
HTTP status code 401
The credentials presented when making a request are invalid.
HTTP status code 404
The requested resource has not been found.