Dalet Flex Core

Accounts

Used for performing operations on Accounts

/accounts get post

get

Returns a list of Accounts

post

Creates a new account.

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": true
    },
    "description": {
      "type": "string",
      "required": false
    },
    "variant": {
      "type": "string",
      "required": false
      }
    }
  }

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/accounts/{accountId} get delete put

Performs operations on a single Account.

get

Returns the Account

delete

Deletes the Account

put

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.

HTTP status code 500

Server error.

/accounts/{accountId}/actions get post put

get

Returns a list of actions that can be performed.

post

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

put

Updates an account.

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

URI Parameters

accountId: required (integer)
Account ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "action": {
      "type": "string",
      "required": true

    }
  }
}

HTTP status code 200

Request has been processed successfully.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "id": {
    "type": "integer",
    "required": false
    },
    "name": {
    "type": "string",
    "required": false
    },
    "type": {
    "type": "string",
    "required": false
    },
    "variant": {
    "type": "string",
    "required": false
    },
    "enabled": {
    "type": "boolean",
    "required": false
    },
    "deleted": {
    "type": "boolean",
    "required": false
    },
    "href": {
    "type": "string",
    "required": false
    },
    "owner": {
    "type": "string",
    "required": false
    }
  }
}

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/accounts/{accountId}/comments get post

A collection of comment.

get

Returns a list of Comments.

post

Adds a new Comment.

/accounts/{accountId}/comments/{commentId} get

Performs operations on a single Comment.

get

Returns a Comment.

/accounts/{accountId}/copy post

post

Copies an existing Account

URI Parameters

accountId: required (integer)
Account ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": true
    },
    "description": {
      "type": "string",
      "required": false
    }
  }
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/accounts/{accountId}/followers get

A collection of follower.

get

Returns a list of users that are following this object.

/accounts/{accountId}/attachments get post

A collection of attachment.

get

Returns a list of attachments.

post

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.

HTTP status code 500

Server error.

/accounts/{accountId}/attachments/{attachmentId} get put delete

get

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

put

Updates the comment for an existing attachment.

delete

Deletes an existing attachment.

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.

HTTP status code 500

Server error.

/accounts/{accountId}/history get

A collection of history.

get

Returns a list of events.

/accounts/{accountId}/metadata get put

get

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

put

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

/accounts/{accountId}/members get

A collection of member object links.

get

Returns the Users associated with the Account.

/accounts/{accountId}/workspaces get

A collection of workspace object links.

get

Returns the Workspaces defined for the Account.

/accounts/{accountId}/subAccounts get

A collection of subAccount object links.

get

Returns the Sub-Accounts defined for the Account.

/accounts/{accountId}/properties get post put delete

A collection of property object links.

get

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

post

Creates a new Account/System Property

put

Updates the properties for the Account.

delete

Deletes the properties for the Account.

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": "bollean",
        "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.

HTTP status code 500

Server error.

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.

HTTP status code 500

Server error.

/accounts/{accountId}/roles get

A collection of role object links.

get

Returns the Roles defined for the Account.

/accounts/{accountId}/accountWorkspace get

get

Returns the Account Workspace defined for the Account.

/accounts/{accountId}/variants get

get

Returns a list of Variants a specific Account.

/accounts/{accountId}/externalIds get post

get

Returns a list of external IDs associated with an Account.

post

Creates new external ID.

Returns a list of external IDs associated with an Account.

URI Parameters

accountId: required (integer)
Account ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

HTTP status code 200

Request has been processed successfully.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    },
    "href": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value",
    "href"
  ]
}

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Creates new external ID.

URI Parameters

accountId: required (integer)
Account ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/accounts/{accountId}/externalIds/{key} get put delete

get

Returns the details for a specific external ID.

put

Updates the Account/System Property

delete

Deletes a specific external ID.

Updates the Account/System Property

URI Parameters

accountId: required (integer)
Account ID
key: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Account Properties

Used for performing operations on Account/System Properties

/accountProperties get post

get

Returns a list of Account/System Properties

post

Returns a list of Account/System Properties

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "key": {
      "type": "string",
      "required": true
    },
    "value": {
      "type": "string",
      "required": true
    }
  }
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/accountProperties/{accountPropertyId} get put delete

Performs operations on a single Account/System Property

get

Returns the Account/System Property

put

Updates the Account/System Property

delete

Deletes the Account/System Property

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": "bollean",
        "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.

HTTP status code 500

Server error.

/accountProperties/{accountPropertyId}/copy post

post

Copies an existing Workflow Definition.

URI Parameters

accountPropertyId: required (integer)
Account Property ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": true
    },
    "description": {
      "type": "string",
      "required": false
    }
  }
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/accountProperties/{accountPropertyId}/externalIds get post

get

Returns a list of external IDs associated with an Account.

post

Creates new external ID.

Returns a list of external IDs associated with an Account.

URI Parameters

accountPropertyId: required (integer)
Account Property ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

HTTP status code 200

Request has been processed successfully.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    },
    "href": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value",
    "href"
  ]
}

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Creates new external ID.

URI Parameters

accountPropertyId: required (integer)
Account Property ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/accountProperties/{accountPropertyId}/externalIds/{key} get put delete

get

Returns the details for a specific external ID.

put

Updates the Account/System Property

delete

Deletes a specific external ID.

Updates the Account/System Property

URI Parameters

accountPropertyId: required (integer)
Account Property ID
key: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Account Workspace

/accountWorkspace get

get

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

/accountWorkspace/copy post

post

Copies an existing Workflow Definition.

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": true
    },
    "description": {
      "type": "string",
      "required": false
    }
  }
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/accountWorkspace/externalIds get post

get

Returns a list of external IDs associated with an Account.

post

Creates new external ID.

Returns a list of external IDs associated with an Account.

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

HTTP status code 200

Request has been processed successfully.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    },
    "href": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value",
    "href"
  ]
}

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Creates new external ID.

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/accountWorkspace/externalIds/{key} get put delete

get

Returns the details for a specific external ID.

put

Updates the Account/System Property

delete

Deletes a specific external ID.

Updates the Account/System Property

URI Parameters

key: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Actions

Perform operations on Actions

/actions get post

get

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

post

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.

HTTP status code 500

Server error.

/actions/{actionId} get put delete

Perform operations on a specific Action

get

Returns details of the Action

put

Update the details of the Action

delete

Delete the Action

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.

HTTP status code 500

Server error.

/actions/{actionId}/actions get post

get

Returns a list of actions that can be performed.

post

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

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.

HTTP status code 500

Server error.

/actions/{actionId}/comments get post

A collection of comment.

get

Returns a list of Comments.

post

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.

HTTP status code 500

Server error.

/actions/{actionId}/comments/{commentId} get

Performs operations on a single Comment.

get

Returns a 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": {
    "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.

HTTP status code 500

Server error.

/actions/{actionId}/followers get

A collection of follower.

get

Returns a list of users that are following this object.

/actions/{actionId}/attachments get post

A collection of attachment.

get

Returns a list of attachments.

post

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.

HTTP status code 500

Server error.

/actions/{actionId}/attachments/{attachmentId} get put delete

get

Returns the details for a specific attachment.

put

Updates the comment for an existing attachment.

delete

Deletes an existing attachment.

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.

HTTP status code 500

Server error.

/actions/{actionId}/history get

A collection of history.

get

Returns a list of events.

/actions/{actionId}/configuration get put

get

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

put

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

/actions/{actionId}/configuration/files get

get

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

/actions/{actionId}/externalIds get post

get

Returns a list of external IDs associated with an Account.

post

Creates new external ID.

Returns a list of external IDs associated with an Account.

URI Parameters

actionId: required (integer)
Action ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

HTTP status code 200

Request has been processed successfully.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    },
    "href": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value",
    "href"
  ]
}

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Creates new external ID.

URI Parameters

actionId: required (integer)
Action ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/actions/{actionId}/externalIds/{key} get put delete

get

Returns the details for a specific external ID.

put

Updates the Account/System Property

delete

Deletes a specific external ID.

Updates the Account/System Property

URI Parameters

actionId: required (integer)
Action ID
key: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/actions/{actionId}/variables get

get

Returns a list of variables associated with a specific action.

/actions/{actionId}/variables/{variableId} get

get

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

/actions/{actionId}/variables/{variableId}/values get

get

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

Assets

This resource is used for managing Assets

/assets get post

get

Returns a list of Assets Listing is based on supplied filters

post

Create new placeholder asset.

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:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['createdTo']: (date)
Created to date. Supported date formats are:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['lastModifiedFrom']: (date)
Last modified from date. Supported date formats are:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['lastModifiedTo']: (date)
Last modified to date. Supported date formats are:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['enabled']: (one of true, false, all)
Enabled flag
MatrixParam['deleted']: (one of true, false, all)
Deleted flag
MatrixParam['approved']: (one of true, false, all)
Approved flag
MatrixParam['accountId']: (number)
You can list multiple Account Ids separated by a colon, e.g. aId=1; aId=2;
MatrixParam['workspaceId']: (number)
You can list multiple Workspace Ids separated by a colon, e.g. wsId=1; wsId=2;
MatrixParam['metadataDefinitionId']: (number)
Metadata Definition Id
MatrixParam['includeNoVariant']: (boolean)
Includes Objects that do not have a Variant.
MatrixParam['includeData']: (boolean)
MatrixParam['parentId’]: (number)
Returns a list of parent Ids. Please note that this matrix parameter can only be used if the parent is a user defined object.
MatrixParam['includeVariables']: (boolean)
Whether or not to include the Variables of Workflows or Jobs in the response.
MatrixParam['ancestorId']: (number)
MatrixParam['level']: (number)
MatrixParam['objectType']: (string)
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
MatrixParam['sort']: (string)
MatrixParam['sortBy']: (string)
callback: (string)
Specifies the call back function for JSONP response.
MatrixParam['includeMetadata']: (boolean)
Include metadata in the response
MatrixParam['assetType']: (one of Group, File)
Type of Assets
MatrixParam['fileType']: (string - default: all types - minLength: 1)
One or more file types of Assets. An Asset Type must be specified before specifying a file type.
MatrixParam['id']: (string)
Filtering by multiple Ids.Example- /api/assets;id=1234;id=2345;id=3456.
MatrixParam['status']: (one of ARCHIVED, DELETED, PUBLISHED, PURGED)
Status of Assets
MatrixParam['creationContext']: (one of ingest, proxy, copy, transcode, new, transform)
The creation context of Assets.
MatrixParam['referenceName']: (string)
MatrixParam['managed']: (string)
Whether the Assets are managed or not
MatrixParam['folderResourceId']: (integer - minimum: 0)
ID of the folder resource
MatrixParam['originalFileName']: (string)
The original filename
MatrixParam['technicalType']: (one of Media, Image)
Different criteria can be applied to Assets depending on which technical type has been chosen.
MatrixParam['format']: (string)
Only applies to Media
MatrixParam['streamCount']: (integer)
Only applies to Media
MatrixParam['audioStreamCount']: (integer)
Only applies to Media
MatrixParam['videoStreamCount']: (string)
Only applies to Media
MatrixParam['internalMetadata']: (string)
Only applies to Media
MatrixParam['bitRate']: (integer)
Only applies to Media
MatrixParam['bitRateUnits']: (string - default: bit/s)
Only applies to Media
MatrixParam['fileSize']: (integer)
Only applies to Media
MatrixParam['fileSizeUnits']: (string - default: B)
Only applies to Media
MatrixParam['duration']: (integer)
Only applies to Media
MatrixParam['durationUnits']: (string - default: µs)
Only applies to Media
MatrixParam['keyframeDescription']: (string)
Search for a specific keyframe description. Only applies to Media.
MatrixParam['videoCodec']: (string)
Only applies to Media
MatrixParam['frameRate']: (string)
Only applies to Media
MatrixParam['pixelAspectRatio']: (string)
Only applies to Media
MatrixParam['frameWidth']: (integer)
Only applies to Media
MatrixParam['frameHeight']: (integer)
Only applies to Media
MatrixParam['interlaceFormat']: (string)
Only applies to Media
MatrixParam['pixelFormat']: (string)
Only applies to Media
MatrixParam['standard']: (string)
Only applies to Media
MatrixParam['videoLanguage']: (string)
Only applies to Media
MatrixParam['videoBitRate']: (integer)
Only applies to Media
MatrixParam['videoBitRateUnits']: (string - default: bit/s)
Only applies to Media
MatrixParam['audioCodec']: (string)
Only applies to Media
MatrixParam['sampleRate']: (string)
Only applies to Media
MatrixParam['channels']: (integer)
Only applies to Media
MatrixParam['bitsPerSample']: (integer)
Only applies to Media
MatrixParam['audioLanguage']: (string)
Only applies to Media
MatrixParam['audioBitRate']: (integer)
Only applies to Media
MatrixParam['audioBitRateUnits']: (string - default: bit/s)
Only applies to Media
MatrixParam['imageFormat']: (string)
Only applies to Image
MatrixParam['width']: (integer)
Only applies to Image
MatrixParam['height']: (integer)
Only applies to Image
MatrixParam['widthResolution']: (string)
Only applies to Image
MatrixParam['heightResolution']: (string)
Only applies to Image
MatrixParam['colorMode']: (string)
Only applies to Image
MatrixParam['bitsPerPixel']: (integer)
Only applies to Image
MatrixParam['exactNameMatch']: (string)
Pass it true if you want to search asset with exact name
MatrixParam['externalId']: (string)
Search for an object via its endpoint (e.g. assets, workflows) and specify the external ID key and value, e.g. For example /api/assets;externalId=key:value
MatrixParam['signedURL']: (string)
Returns a link to an asset stored in s3. This link enables you to download a file stored in s3 without needing to log in.

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

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.

HTTP status code 500

Server error.

/assets/{assetId} get put

Perform operations on a specific Asset

get

Returns the details for a specific Asset (account, workspace, owner, title), asset file information and technical information (including GOP, bitrate type, media contexts, image contexts). You can also retreive the details for multiple assets by entering a list of Asset IDs separated by a semicolon e.g. /api/assets;id=1234;id=2345;id=3456

put

Update an Asset details (only editable properties).

URI Parameters

assetId: required (integer)
Asset ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": false
    },
    "description": {
      "type": "string",
      "required": false
    },
    "referenceName": {
      "type": "string",
      "required": false
    },
    "assetOrigin": {
      "type": "string",
      "required": false
    },
    "variant": {
      "type": "string",
      "required": false
    },
    "metadataDefinitionId": {
      "type": "integer",
      "required": false
    }
  }
}

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.

HTTP status code 500

Server error.

/assets/{assetId}/annotations get post

get

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

post

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

URI Parameters

assetId: required (integer)
Asset ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
   "type": "object",
   "properties": {
     "timelineComment": {
       "type": "object",
       "properties": {
         "comment": {
           "type": "string"
         },
         "timestampIn": {
           "type": "integer"
         },
         "timestampOut": {
           "type": "integer"
         },
         "originatorContext": {
           "type": "string"
           }
         }
       }
     }
   }

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/assets/{assetId}/annotations/{annotationId} put delete

Performs operations on a specific Annotation.

put

Adds a new Comment.

delete

Deletes an existing annotation a ne.

Adds a new Comment.

URI Parameters

assetId: required (integer)
Asset ID
annotationId: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "comment": {
      "type": "string",
      "required": true
    },
    "timestampIn": {
      "type": "integer"
    },
    "timestampOut": {
      "type": "integer"

    }
  }
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/assets/{assetId}/comments get post

A collection of comment.

get

Returns a list of Comments.

post

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.

HTTP status code 500

Server error.

/assets/{assetId}/comments/{commentId} get

Performs operations on a single Comment.

get

Returns a Comment.

/assets/{assetId}/copy post

post

Copies an existing Asset.

URI Parameters

assetId: required (integer)
Asset ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": true
    },
    "description": {
      "type": "string",
      "required": false
    }
  }
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/assets/{assetId}/followers get

A collection of follower.

get

Returns a list of users that are following this object.

/assets/{assetId}/attachments get post

A collection of attachment.

get

Returns a list of attachments.

post

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.

HTTP status code 500

Server error.

/assets/{assetId}/attachments/{attachmentId} get put delete

get

Returns the details for a specific attachment.

put

Updates the comment for an existing attachment.

delete

Deletes an existing attachment.

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.

HTTP status code 500

Server error.

/assets/{assetId}/history get

A collection of history.

get

Returns a list of events.

/assets/{assetId}/references get

A collection of reference object links.

get

Returns a list of references.

/assets/{assetId}/metadata get put

get

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

put

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

/assets/{assetId}/jobs get

A collection of job object links.

get

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

/assets/{assetId}/workflows get

A collection of workflow object links.

get

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:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['createdTo']: (date)
Created to date. Supported date formats are:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['lastModifiedFrom']: (date)
Last modified from date. Supported date formats are:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['lastModifiedTo']: (date)
Last modified to date. Supported date formats are:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['enabled']: (one of true, false, all)
Enabled flag
MatrixParam['deleted']: (one of true, false, all)
Deleted flag
MatrixParam['approved']: (one of true, false, all)
Approved flag
MatrixParam['accountId']: (number)
You can list multiple Account Ids separated by a colon, e.g. aId=1; aId=2;
MatrixParam['workspaceId']: (number)
You can list multiple Workspace Ids separated by a colon, e.g. wsId=1; wsId=2;
MatrixParam['metadataDefinitionId']: (number)
Metadata Definition Id
MatrixParam['includeNoVariant']: (boolean)
Includes Objects that do not have a Variant.
MatrixParam['includeData']: (boolean)
MatrixParam['parentId’]: (number)
Returns a list of parent Ids. Please note that this matrix parameter can only be used if the parent is a user defined object.
MatrixParam['includeVariables']: (boolean)
Whether or not to include the Variables of Workflows or Jobs in the response.
MatrixParam['ancestorId']: (number)
MatrixParam['level']: (number)
MatrixParam['objectType']: (string)
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
MatrixParam['sort']: (string)
MatrixParam['sortBy']: (string)
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:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['startDateTo']: (date)
Supported date formats are:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['endDateFrom']: (date)
Supported date formats are:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['endDateTo']: (date)
Supported date formats are:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. 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.

HTTP status code 500

Server error.

/assets/{assetId}/keyframes get post

Operations on asset keyframes.

get

Returns a list of keyframes, based on supplied filters.

post

Creates a new keyframe from an existing Asset.

Request

URI Parameters

assetId: required (integer)
Asset ID

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "title": {
      "type": "string",
      "required": true
    },
    "description": {
      "type": "string",
      "required": false
    },
    "approved": {
      "type": "boolean",
      "required": false

    },
    "master": {
      "type": "boolean",
      "required": false
    },
    "timecode": {
      "type": "long",
      "required": false
    },
    "mimeType": {
      "type": "string",
      "required": false
    },
    "image": {
      "type": "string",
      "required": false
    }
  }
}

/assets/{assetId}/keyframes/{keyframeId} get put delete

get

Returns details of the specific keyframe.

put

Updates details of the keyframe.

delete

Deletes the keyframe.

Updates details of the keyframe.

URI Parameters

assetId: required (integer)
Asset ID
keyframeId: required (integer)
Keyframe ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "title": {
      "type": "string",
      "required": true
    },
    "description": {
      "type": "string",
      "required": false
    },
    "approved": {
      "type": "boolean",
      "required": false

    },
    "master": {
      "type": "boolean",
      "required": false

    }
  }
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/assets/{assetId}/keyframes/{keyframeId}/image get

get

Returns the keyframe image.

/assets/{assetId}/keyframes/{keyframeId}/raw get

get

Returns a stream of bytes.

/assets/{assetId}/players get

Used for viewing published players.

get

Returns a list of associated players.

URI Parameters

assetId: required (integer)
Asset ID

Query Parameters

MatrixParam['searchText']: (string)
Search for occurrences of searchText in Name, Description, ID, Attachments, Comments and Metadata fields.
MatrixParam['owner']: (string - minLength: 1)
Owner user name
MatrixParam['variant']: (string - minLength: 1)
List of Variants
MatrixParam['excludedVariants']: (string - minLength: 1)
List of Variants
MatrixParam['createdFrom']: (date)
Created from date. Supported date formats are:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['createdTo']: (date)
Created to date. Supported date formats are:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['lastModifiedFrom']: (date)
Last modified from date. Supported date formats are:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['lastModifiedTo']: (date)
Last modified to date. Supported date formats are:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['enabled']: (one of true, false, all)
Enabled flag
MatrixParam['deleted']: (one of true, false, all)
Deleted flag
MatrixParam['approved']: (one of true, false, all)
Approved flag
MatrixParam['accountId']: (number)
You can list multiple Account Ids separated by a colon, e.g. aId=1; aId=2;
MatrixParam['workspaceId']: (number)
You can list multiple Workspace Ids separated by a colon, e.g. wsId=1; wsId=2;
MatrixParam['metadataDefinitionId']: (number)
Metadata Definition Id
MatrixParam['includeNoVariant']: (boolean)
Includes Objects that do not have a Variant.
MatrixParam['includeData']: (boolean)
MatrixParam['parentId’]: (number)
Returns a list of parent Ids. Please note that this matrix parameter can only be used if the parent is a user defined object.
MatrixParam['includeVariables']: (boolean)
Whether or not to include the Variables of Workflows or Jobs in the response.
MatrixParam['ancestorId']: (number)
MatrixParam['level']: (number)
MatrixParam['objectType']: (string)
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
MatrixParam['sort']: (string)
MatrixParam['sortBy']: (string)
callback: (string)
Specifies the call back function for JSONP response.
MatrixParam['definitionId']: (integer - minimum: 0)
The player definition ID
MatrixParam['assetTitle']: (string)
The asset title

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/assets/{assetId}/actions get

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

get

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

/assets/{assetId}/{groupAssetId}/members delete

Performs operations on parent asset group memberships.

delete

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

/assets/{assetId}/parentGroups get post

Performs operations on parent asset group memberships.

get

Returns a list of parent group memberships.

post

Creates a new membership with a parent group.

URI Parameters

assetId: required (integer)
Asset ID

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "integer",
        "required": true
      },
      "membershipName": {
        "type": "string",
        "required": true
      }
    }
  }
}

HTTP status code 201

Returns the new membership.

Body

Type: application/vnd.nativ.mio.v1+json

/assets/{assetId}/parentGroups/{membershipId} get put delete

get

Returns details of the specific asset membership.

put

Updates the membership with the parent group.

delete

Delete the membership with the parent group.

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.

HTTP status code 500

Server error.

/assets/{assetId}/members get post

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

get

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

post

Creates a new membership with a child asset.

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

HTTP status code 201

Returns the new membership.

Body

Type: application/vnd.nativ.mio.v1+json

/assets/{assetId}/members/{membershipId} get put delete

get

Returns details of the specific asset membership.

put

Updates the membership with the child member.

delete

Delete the membership with the child member.

Updates the membership with the child member.

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.

HTTP status code 500

Server error.

/assets/{assetId}/children get

A collection of child object links.

get

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

/assets/{assetId}/parent get

get

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

/assets/{assetId}/proxies get

get

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

/assets/{assetId}/externalIds get post

get

Returns a list of external IDs associated with an Account.

post

Creates new external ID.

Returns a list of external IDs associated with an Account.

URI Parameters

assetId: required (integer)
Asset ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

HTTP status code 200

Request has been processed successfully.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    },
    "href": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value",
    "href"
  ]
}

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Creates new external ID.

URI Parameters

assetId: required (integer)
Asset ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/assets/{assetId}/externalIds/{key} get put delete

get

Returns the details for a specific external ID.

put

Updates the Account/System Property

delete

Deletes a specific external ID.

Updates the Account/System Property

URI Parameters

assetId: required (integer)
Asset ID
key: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/assets/{assetId}/mediaRegions get post put delete

get

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

post

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

put

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

delete

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

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

URI Parameters

assetId: required (integer)
Asset ID

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "sourceTimestampIn": {
      "type": "long",
      "required": true
    },
    "sourceTimestampOut": {
      "type": "long",
      "required": true
    }
  }
}

HTTP status code 201

Body

Type: application/vnd.nativ.mio.v1+json

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

URI Parameters

assetId: required (integer)
Asset ID

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "sourceTimestampIn": {
      "type": "long",
      "required": true
    },
    "sourceTimestampOut": {
      "type": "long",
      "required": true
    }
  }
}

HTTP status code 200

Body

Type: application/vnd.nativ.mio.v1+json

/assets/{assetId}/placedMediaRegions get post

get

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

post

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

Request

URI Parameters

assetId: required (integer)
Asset ID

Body

Type: application/vnd.nativ.mio.v1+json

Schema:


{
  "type": "object",
  "required": true,
  "properties": {
    "sourceTimestampIn": {
      "type": "long",
      "required": true
    },
    "sourceTimestampOut": {
      "type": "long",
      "required": true
    },
    "assetCorrelationId": {
      "type": "long",
      "required": true
    },
    "targetTimestampIn": {
      "type": "long",
      "required": true
    },
    "targetTimestampOut": {
      "type": "long",
      "required": true
    }
  }
}

/assets/{assetId}/placedMediaRegions/{placedMediaRegionId} get put

get

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

put

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

URI Parameters

assetId: required (integer)
Asset ID
placedMediaRegionId: required (string)

Body

Type: application/vnd.nativ.mio.v1+json

Schema:


{
  "type": "object",
  "required": true,
  "properties": {
    "sourceTimestampIn": {
      "type": "long",
      "required": true
    },
    "sourceTimestampOut": {
      "type": "long",
      "required": true
    },
    "assetCorrelationId": {
      "type": "long",
      "required": true
    },
    "targetTimestampIn": {
      "type": "long",
      "required": true
    },
    "targetTimestampOut": {
      "type": "long",
      "required": true
    }
  }
}

HTTP status code 200

Collections

This resource is used for viewing Collections.

/collections get post

get

Returns a list of Collections.

post

Creates a new Collection.

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": true
    },
    "description": {
      "type": "string",
      "required": false
    },
    "assets": {
      "type": "array",
      "items": {
      "type": "long"
      }
    },
    "subCollections": {
      "required": "false",
      "type": "array",
      "items": {
        "type": "long"
      }
    },
    "parentId": {
      "type": "long",
      "required": false
    },
    "variant": {
      "type": "string",
      "required": false
    },
    "metadataDefintionId": {
      "type": "long",
      "required": false
    },
    "accountId": {
      "type": "long",
      "required": false
    },
    "workspaceId": {
      "type": "long",
      "required": false
    }
  }
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "id": {
    "type": "integer",
    "required": false
    },
    "name": {
    "type": "string",
    "required": false
    },
    "type": {
    "type": "string",
    "required": false
    },
    "variant": {
    "type": "string",
    "required": false
    },
    "enabled": {
    "type": "boolean",
    "required": false
    },
    "deleted": {
    "type": "boolean",
    "required": false
    },
    "href": {
    "type": "string",
    "required": false
    },
    "owner": {
    "type": "string",
    "required": false
    }
  }
}

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/collections/{collectionId} get put delete

get

Returns Collection found by specified id.

put

Updates the collection.

delete

Deletes a Collection found by specified id.

Updates the collection.

URI Parameters

collectionId: required (integer)
Asset Membership ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": false
    },
    "description": {
      "type": "string",
      "required": false
    },
    "parentId": {
      "type": "long",
      "required": false
    },
    "Variant": {
      "type": "string",
      "required": false
    },
    "metadataDefinitionId": {
      "type": "long",
      "required": false
    }
  }
}

HTTP status code 200

Request has been processed successfully.

Body

Type: application/vnd.nativ.mio.v1+json

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/collections/{collectionId}/items put get

put

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

get

Returns a list of items.

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

URI Parameters

collectionId: required (integer)
Asset Membership ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "assetsToRemove": {
      "type": "long",
      "description": "A list of IDs",
      "required": false
    },
    "assetsToAdd": {
     "type": "long",
      "description": "A list of IDs",
      "required": false

    }
  }
}

HTTP status code 200

Request has been processed successfully.

Body

Type: application/vnd.nativ.mio.v1+json

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/collections/{collectionId}/comments get post

A collection of comment.

get

Returns comments for a specific collection.

post

Posts a new comment on a specific collection.

URI Parameters

collectionId: required (integer)
Asset Membership ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "message": {
      "type": "string",
      "required": true

    }
  }
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "id": {
    "type": "integer",
    "required": false
    },
    "name": {
    "type": "string",
    "required": false
    },
    "type": {
    "type": "string",
    "required": false
    },
    "variant": {
    "type": "string",
    "required": false
    },
    "enabled": {
    "type": "boolean",
    "required": false
    },
    "deleted": {
    "type": "boolean",
    "required": false
    },
    "href": {
    "type": "string",
    "required": false
    },
    "owner": {
    "type": "string",
    "required": false
    }
  }
}

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/collections/{collectionId}/comments/{commentId} get put delete

Performs operations on a single Comment.

get

Returns a specific comment for a specific collection.

put

Updates a comment for a specified Object within a collection.

delete

Deletes a comment on a specific object within a collection.

/collections/{collectionId}/comments/copy post

post

Copies an existing Collection.

URI Parameters

collectionId: required (integer)
Asset Membership ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": true
    },
    "description": {
      "type": "string",
      "required": false
    }
  }
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/collections/{collectionId}/followers get

A collection of follower.

get

Returns comments for a specific collection.

/collections/{collectionId}/attachments get post

A collection of attachment.

get

Returns attachments for a specific collection.

post

Adds a new attachment to the collection.

URI Parameters

collectionId: required (integer)
Asset Membership ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "id": {
    "type": "integer",
    "required": false
    },
    "name": {
    "type": "string",
    "required": false
    },
    "type": {
    "type": "string",
    "required": false
    },
    "variant": {
    "type": "string",
    "required": false
    },
    "enabled": {
    "type": "boolean",
    "required": false
    },
    "deleted": {
    "type": "boolean",
    "required": false
    },
    "href": {
    "type": "string",
    "required": false
    },
    "owner": {
    "type": "string",
    "required": false
    }
  }
}

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/collections/{collectionId}/attachments/{attachmentId} get put delete

get

Returns the details for a specific attachment.

put

Updates the comment for an existing attachment.

delete

Deletes an existing attachment.

Updates the comment for an existing attachment.

URI Parameters

collectionId: required (integer)
Asset Membership ID
attachmentId: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:


{
  "type": "object",
  "required": true,
  "properties": {
    "description": {
      "type": "string",
      "required": true
    }
  }
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/collections/{collectionId}/history get

A collection of history.

get

Returns the history for the given collection.

/collections/{collectionId}/references get

A collection of reference object links.

get

Returns the references for the given collection.

/collections/{collectionId}/metadata/{variableInstanceId}/comments get post

get

Returns the comments for the given Variable Instance.

post

Adds a new comment to the Variable Instance.

URI Parameters

collectionId: required (integer)
Asset Membership ID
variableInstanceId: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "message": {
      "type": "string",
      "required": true

    }
  }
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "id": {
    "type": "integer",
    "required": false
    },
    "name": {
    "type": "string",
    "required": false
    },
    "type": {
    "type": "string",
    "required": false
    },
    "variant": {
    "type": "string",
    "required": false
    },
    "enabled": {
    "type": "boolean",
    "required": false
    },
    "deleted": {
    "type": "boolean",
    "required": false
    },
    "href": {
    "type": "string",
    "required": false
    },
    "owner": {
    "type": "string",
    "required": false
    }
  }
}

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/collections/{collectionId}/metadata/{variableInstanceId}/comments/{commentId} delete

delete

Deletes a comment on a specific object within a collection.

/collections/{collectionId}/subCollections get

get

Returns Sub-collections for the given collection.

/collections/{collectionId}/subCollections/keyframe get post put delete

A collection of keyframe.

get

Get all keyframe, optionally filtered

post

Sets a new Keyframe to the collection.

put

Updates the Collection's Keyframe with an existing one.

delete

Deletes a Keyframe for a collection.

Sets a new Keyframe to the collection.

URI Parameters

collectionId: required (integer)
Asset Membership ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "image": {
      "type": "string",
      "description": "Base64 encoded file content",
      "required": true
    },
    "mimeType": {
      "type": "string",
      "required": true
    }
  }
}

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Updates the Collection's Keyframe with an existing one.

URI Parameters

collectionId: required (integer)
Asset Membership ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

HTTP status code 200

Request has been processed successfully.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "image": {
      "type": "string",
      "description": "Base64 encoded file content",
      "required": true
    },
    "mimeType": {
      "type": "string",
      "required": true
    }
  }
}

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/collections/{collectionId}/subCollections/externalIds get post

get

Returns a list of external IDs associated with an Account.

post

Creates new external ID.

Returns a list of external IDs associated with an Account.

URI Parameters

collectionId: required (integer)
Asset Membership ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

HTTP status code 200

Request has been processed successfully.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    },
    "href": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value",
    "href"
  ]
}

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Creates new external ID.

URI Parameters

collectionId: required (integer)
Asset Membership ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/collections/{collectionId}/subCollections/externalIds/{key} get put delete

get

Returns the details for a specific external ID.

put

Updates the Account/System Property

delete

Deletes a specific external ID.

Updates the Account/System Property

URI Parameters

collectionId: required (integer)
Asset Membership ID
key: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Events

This resource is used for viewing Events

/events get post

get

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

post

Create a new Event

Request

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

/events/{eventId} get

Perform operations on a specific Event

get

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

Event Handlers

This resource is used for viewing and managing EventHandlers

/eventHandlers get

get

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

/eventHandlers/{eventHandlerId} get delete

Perform operations on a specific EventHandler

get

Returns EventHandler object details.

delete

Deletes the EventHandler

/eventHandlers/{eventHandlerId}/actions get post

get

Returns a list of actions that can be performed.

post

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

URI Parameters

eventHandlerId: required (integer)
Event Handler ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "action": {
      "type": "string",
      "required": true

    }
  }
}

HTTP status code 200

Request has been processed successfully.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "id": {
    "type": "integer",
    "required": false
    },
    "name": {
    "type": "string",
    "required": false
    },
    "type": {
    "type": "string",
    "required": false
    },
    "variant": {
    "type": "string",
    "required": false
    },
    "enabled": {
    "type": "boolean",
    "required": false
    },
    "deleted": {
    "type": "boolean",
    "required": false
    },
    "href": {
    "type": "string",
    "required": false
    },
    "owner": {
    "type": "string",
    "required": false
    }
  }
}

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/eventHandlers/{eventHandlerId}/comments get post

A collection of comment.

get

Returns a list of Comments.

post

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.

HTTP status code 500

Server error.

/eventHandlers/{eventHandlerId}/comments/{commentId} get

Performs operations on a single Comment.

get

Returns a Comment.

/eventHandlers/{eventHandlerId}/copy post

post

Copies an existing Event Handler.

URI Parameters

eventHandlerId: required (integer)
Event Handler ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": true
    },
    "description": {
      "type": "string",
      "required": false
    }
  }
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/eventHandlers/{eventHandlerId}/followers get

A collection of follower.

get

Returns a list of users that are following this object.

/eventHandlers/{eventHandlerId}/attachments get post

A collection of attachment.

get

Returns a list of attachments.

post

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.

HTTP status code 500

Server error.

/eventHandlers/{eventHandlerId}/attachments/{attachmentId} get put delete

get

Returns the details for a specific attachment.

put

Updates the comment for an existing attachment.

delete

Deletes an existing attachment.

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.

HTTP status code 500

Server error.

/eventHandlers/{eventHandlerId}/history get

A collection of history.

get

Returns a list of events.

/eventHandlers/{eventHandlerId}/references get

A collection of reference object links.

get

Returns a list of references.

/eventHandlers/{eventHandlerId}/configuration get put

Set or get the event configuration.

get

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

put

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

/eventHandlers/{eventHandlerId}/externalIds get post

get

Returns a list of external IDs associated with an Account.

post

Creates new external ID.

Returns a list of external IDs associated with an Account.

URI Parameters

eventHandlerId: required (integer)
Event Handler ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

HTTP status code 200

Request has been processed successfully.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    },
    "href": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value",
    "href"
  ]
}

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Creates new external ID.

URI Parameters

eventHandlerId: required (integer)
Event Handler ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/eventHandlers/{eventHandlerId}/externalIds/{key} get put delete

get

Returns the details for a specific external ID.

put

Updates the Account/System Property

delete

Deletes a specific external ID.

Updates the Account/System Property

URI Parameters

eventHandlerId: required (integer)
Event Handler ID
key: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Groups

Perform operation on Groups

/groups get post

get

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

post

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.

HTTP status code 500

Server error.

/groups/{groupId} get put delete

Perform operations on a specific Group.

get

Returns Group object details.

put

Updates the group that the id belongs to.

delete

Deletes the Group

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.

HTTP status code 500

Server error.

/groups/{groupId}/actions get post

get

Returns a list of actions that can be performed.

post

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

URI Parameters

groupId: required (integer)
Group ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "action": {
      "type": "string",
      "required": true

    }
  }
}

HTTP status code 200

Request has been processed successfully.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "id": {
    "type": "integer",
    "required": false
    },
    "name": {
    "type": "string",
    "required": false
    },
    "type": {
    "type": "string",
    "required": false
    },
    "variant": {
    "type": "string",
    "required": false
    },
    "enabled": {
    "type": "boolean",
    "required": false
    },
    "deleted": {
    "type": "boolean",
    "required": false
    },
    "href": {
    "type": "string",
    "required": false
    },
    "owner": {
    "type": "string",
    "required": false
    }
  }
}

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/groups/{groupId}/comments get post

A collection of comment.

get

Returns a list of Comments.

post

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.

HTTP status code 500

Server error.

/groups/{groupId}/comments/{commentId} get

Performs operations on a single Comment.

get

Returns a Comment.

/groups/{groupId}/copy post

post

Copies an existing Group.

URI Parameters

groupId: required (integer)
Group ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": true
    },
    "description": {
      "type": "string",
      "required": false
    }
  }
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/groups/{groupId}/followers get

A collection of follower.

get

Returns a list of users that are following this object.

/groups/{groupId}/attachments get

A collection of attachment.

get

Returns a list of attachments.

/groups/{groupId}/history get

A collection of history.

get

Returns a list of events.

/groups/{groupId}/references get

A collection of reference object links.

get

Returns a list of references.

/groups/{groupId}/metadata get put

get

Returns the metadata of a specific group.

put

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

/groups/{groupId}/members get

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

get

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

/groups/{groupId}/externalIds get post

get

Returns a list of external IDs associated with an Account.

post

Creates new external ID.

Returns a list of external IDs associated with an Account.

URI Parameters

groupId: required (integer)
Group ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

HTTP status code 200

Request has been processed successfully.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    },
    "href": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value",
    "href"
  ]
}

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Creates new external ID.

URI Parameters

groupId: required (integer)
Group ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/groups/{groupId}/externalIds/{key} get put delete

get

Returns the details for a specific external ID.

put

Updates the Account/System Property

delete

Deletes a specific external ID.

Updates the Account/System Property

URI Parameters

groupId: required (integer)
Group ID
key: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Jobs

This resource is used for viewing, creating and managing Jobs

/jobs get post

get

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

post

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

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:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['createdTo']: (date)
Created to date. Supported date formats are:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['lastModifiedFrom']: (date)
Last modified from date. Supported date formats are:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['lastModifiedTo']: (date)
Last modified to date. Supported date formats are:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['enabled']: (one of true, false, all)
Enabled flag
MatrixParam['deleted']: (one of true, false, all)
Deleted flag
MatrixParam['approved']: (one of true, false, all)
Approved flag
MatrixParam['accountId']: (number)
You can list multiple Account Ids separated by a colon, e.g. aId=1; aId=2;
MatrixParam['workspaceId']: (number)
You can list multiple Workspace Ids separated by a colon, e.g. wsId=1; wsId=2;
MatrixParam['metadataDefinitionId']: (number)
Metadata Definition Id
MatrixParam['includeNoVariant']: (boolean)
Includes Objects that do not have a Variant.
MatrixParam['includeData']: (boolean)
MatrixParam['parentId’]: (number)
Returns a list of parent Ids. Please note that this matrix parameter can only be used if the parent is a user defined object.
MatrixParam['includeVariables']: (boolean)
Whether or not to include the Variables of Workflows or Jobs in the response.
MatrixParam['ancestorId']: (number)
MatrixParam['level']: (number)
MatrixParam['objectType']: (string)
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
MatrixParam['sort']: (string)
MatrixParam['sortBy']: (string)
callback: (string)
Specifies the call back function for JSONP response.
MatrixParam['externalId']: (string)
Search for an object via its endpoint (e.g. assets, workflows) and specify the external ID key and value, e.g. For example /api/assets;externalId=key:value
MatrixParam['status']: (one of Scheduled, Pending, Queued, WaitingForLock, Running, Completed, Cancelled, Failed, TimedOut)
One or more statuses can be provided.
MatrixParam['id']: (string)
Filtering by multiple Ids.Example- /api/jobs;id=1234;id=2345;id=3456
MatrixParam['actionType']: (string)
The action type.
MatrixParam['actionId']: (integer)
Specifying actionId requires that actionType is also specified.
MatrixParam['jobType']: (one of Single, Group)
The job type
MatrixParam['priority']: (one of Highest, High, Normal, Low, Lowest)
The priority of the job.
MatrixParam['scheduledDateFrom']: (date)
Search for a specific scheduled date from the given date. Supported date formats are:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['scheduledDateTo']: (date)
Search for a specific scheduled date to the given date. Supported date formats are:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['startDateFrom']: (date)
Search for a specific start date from the given date. Supported date formats are:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['startDateTo']: (date)
Search for a specific start date to the given date. Supported date formats are:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['EndDateFrom']: (date)
Search for a specific end date from the given date. Supported date formats are:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['EndDateTo']: (date)
Search for a specific end date to the given date. Supported date formats are:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. 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.

HTTP status code 500

Server error.

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

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "actionId": {
      "type": "integer",
      "required": true
    },
    "assetId": {
      "type": "integer",
      "required": false
    },
    "actionConfigId": {
      "type": "integer",
      "required": false
    },
    "jobConfiguration ": {
      "type": "string",
      "required": false
    },
    "scheduleDate": {
      "type": "date",
      "required": false
    },
    "priority": {
      "type": "string",
      "required": false
    },
    "contextExpression": {
      "type": "string",
      "required": false
    },
    "accountId": {
      "type": "integer",
      "required": false
    },
    "workspaceId": {
      "type": "integer",
      "required": false
    }
  }
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "id": {
    "type": "integer",
    "required": false
    },
    "name": {
    "type": "string",
    "required": false
    },
    "type": {
    "type": "string",
    "required": false
    },
    "variant": {
    "type": "string",
    "required": false
    },
    "enabled": {
    "type": "boolean",
    "required": false
    },
    "deleted": {
    "type": "boolean",
    "required": false
    },
    "href": {
    "type": "string",
    "required": false
    },
    "owner": {
    "type": "string",
    "required": false
    }
  }
}

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/jobs/{jobId} get

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

get

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

/jobs/{jobId}/actions get post

get

Returns a list of actions that can be performed.

post

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

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.

HTTP status code 500

Server error.

/jobs/{jobId}/comments get post

A collection of comment.

get

Returns a list of Comments.

post

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.

HTTP status code 500

Server error.

/jobs/{jobId}/comments/{commentId} get

Performs operations on a single Comment.

get

Returns a Comment.

/jobs/{jobId}/copy post

post

Copies an existing Job.

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": {
    "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.

HTTP status code 500

Server error.

/jobs/{jobId}/followers get

A collection of follower.

get

Returns a list of users that are following this object.

/jobs/{jobId}/attachments get post put delete

A collection of attachment.

get

Returns a list of attachments.

post

Creates a new attachment.

put

Updates the comment for an existing attachment.

delete

Deletes an existing attachment.

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.

HTTP status code 500

Server error.

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.

HTTP status code 500

Server error.

/jobs/{jobId}/history get

A collection of history.

get

Returns a list of events.

/jobs/{jobId}/references get

A collection of reference object links.

get

Returns a list of references.

/jobs/{jobId}/callbacks post

Perform a callback on the specified resource.

post

/jobs/{jobId}/configuration get put post

Set or get the job metadata.

get

Returns the job configuration including an href to the configuration.

put

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

post

Create a new Metadata Definition

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.

HTTP status code 500

Server error.

/jobs/{jobId}/externalIds get post

get

Returns a list of external IDs associated with an Account.

post

Creates new external ID.

Returns a list of external IDs associated with an Account.

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.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    },
    "href": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value",
    "href"
  ]
}

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Creates new external ID.

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",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/jobs/{jobId}/externalIds/{key} get put delete

get

Returns the details for a specific external ID.

put

Updates the Account/System Property

delete

Deletes a specific external ID.

Updates the Account/System Property

URI Parameters

jobId: required (integer)
Job ID
key: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Metadata Definitions

Perform operations on Metadata Definitions

/metadataDefinitions get post

get

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

post

Create a new Metadata Definition.

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": true
    },
    "description": {
      "type": "string",
      "required": false
    },
    "visibilityIds": {
      "type": "array",
      "items": {
          "type": "long"
      },
      "minItems": 0,
      "uniqueItems": true,
      "required": true
    }
  }
}

HTTP status code 200

Request has been processed successfully.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "id": {
    "type": "integer",
    "required": false
    },
    "name": {
    "type": "string",
    "required": false
    },
    "type": {
    "type": "string",
    "required": false
    },
    "variant": {
    "type": "string",
    "required": false
    },
    "enabled": {
    "type": "boolean",
    "required": false
    },
    "deleted": {
    "type": "boolean",
    "required": false
    },
    "href": {
    "type": "string",
    "required": false
    },
    "owner": {
    "type": "string",
    "required": false
    }
  }
}

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/metadataDefinitions/{metadataDefinitionId} get put delete

Perform operations on a specific Metadata Definition.

get

Returns the details of the Metadata Definition.

put

Updates an existing Metadata Definition.

delete

Delete the Metadata Definition.

Updates an existing Metadata Definition.

URI Parameters

metadataDefinitionId: required (integer)
Metadata Defintion ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+xml

Type: application/vnd.nativ.mio.v1+json

Schema:


{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": true
    },
    "description": {
      "type": "string",
      "required": false
    },
    "visibilityIds": {
      "type": "string",
      "required": false
    }
  }
}

HTTP status code 200

Request has been processed successfully.

Body

Type: application/vnd.nativ.mio.v1+xml

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/metadataDefinitions/{metadataDefinitionId}/actions get post

get

Returns a list of actions that can be performed.

post

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

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.

HTTP status code 500

Server error.

/metadataDefinitions/{metadataDefinitionId}/copy post

post

Copies an existing Metadata Definition.

URI Parameters

metadataDefinitionId: required (integer)
Metadata Defintion ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": true
    },
    "description": {
      "type": "string",
      "required": false
    }
  }
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/metadataDefinitions/{metadataDefinitionId}/comments get post

A collection of comment.

get

Returns a list of Comments.

post

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.

HTTP status code 500

Server error.

/metadataDefinitions/{metadataDefinitionId}/comments/{commentId} get put delete

Performs operations on a single Comment.

get

Returns a Comment.

put

Upates a comment made against a specific Metdata Definition.

delete

Deletes an existing comment made againsts a specific Metdata Defintion.

Upates a comment made against a specific Metdata Definition.

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.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "message": {
      "type": "string",
      "required": true

    }
  }
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/metadataDefinitions/{metadataDefinitionId}/followers get

A collection of follower.

get

Returns a list of users that are following this object.

/metadataDefinitions/{metadataDefinitionId}/attachments get post

A collection of attachment.

get

Returns a list of attachments.

post

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.

HTTP status code 500

Server error.

/metadataDefinitions/{metadataDefinitionId}/attachments/{attachmentId} get put delete

get

Returns the details for a specific attachment.

put

Updates the comment for an existing attachment.

delete

Deletes an existing attachment.

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.

HTTP status code 500

Server error.

/metadataDefinitions/{metadataDefinitionId}/history get

A collection of history.

get

Returns a list of events.

/metadataDefinitions/{metadataDefinitionId}/definition get put

Perform operations on a specific metadata defintion metadata.

get

Returns the defintion of the metadata definition.

put

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

/metadataDefinitions/{metadataDefinitionId}/externalIds get post

get

Returns a list of external IDs associated with an Account.

post

Creates new external ID.

Returns a list of external IDs associated with an Account.

URI Parameters

metadataDefinitionId: required (integer)
Metadata Defintion ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

HTTP status code 200

Request has been processed successfully.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    },
    "href": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value",
    "href"
  ]
}

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Creates new external ID.

URI Parameters

metadataDefinitionId: required (integer)
Metadata Defintion ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/metadataDefinitions/{metadataDefinitionId}/externalIds/{key} get put delete

get

Returns the details for a specific external ID.

put

Updates the Account/System Property

delete

Deletes a specific external ID.

Updates the Account/System Property

URI Parameters

metadataDefinitionId: required (integer)
Metadata Defintion ID
key: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Message Templates

This resource is used for viewing and managing Message Templates.

/messageTemplates get post

get

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

post

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.

HTTP status code 500

Server error.

/messageTemplates/{messageTemplateId} get put delete

Perform operations on a specific Message Template.

get

Returns Message Template object details.

put

Updates an existi.

delete

Deletes the Message Template.

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.

HTTP status code 500

Server error.

/messageTemplates/{messageTemplateId}/actions get post

get

Returns a list of actions that can be performed.

post

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

URI Parameters

messageTemplateId: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "action": {
      "type": "string",
      "required": true

    }
  }
}

HTTP status code 200

Request has been processed successfully.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "id": {
    "type": "integer",
    "required": false
    },
    "name": {
    "type": "string",
    "required": false
    },
    "type": {
    "type": "string",
    "required": false
    },
    "variant": {
    "type": "string",
    "required": false
    },
    "enabled": {
    "type": "boolean",
    "required": false
    },
    "deleted": {
    "type": "boolean",
    "required": false
    },
    "href": {
    "type": "string",
    "required": false
    },
    "owner": {
    "type": "string",
    "required": false
    }
  }
}

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/messageTemplates/{messageTemplateId}/comments get post

A collection of comment.

get

Returns a list of Comments.

post

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.

HTTP status code 500

Server error.

/messageTemplates/{messageTemplateId}/comments/{commentId} get

Performs operations on a single Comment.

get

Returns a Comment.

/messageTemplates/{messageTemplateId}/copy post

post

Copies an existing Message Template.

URI Parameters

messageTemplateId: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": true
    },
    "description": {
      "type": "string",
      "required": false
    }
  }
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/messageTemplates/{messageTemplateId}/followers get

A collection of follower.

get

Returns a list of users that are following this object.

/messageTemplates/{messageTemplateId}/attachments get post

A collection of attachment.

get

Returns a list of attachments.

post

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.

HTTP status code 500

Server error.

/messageTemplates/{messageTemplateId}/attachments/{attachmentId} get put delete

get

Returns the details for a specific attachment.

put

Updates the comment for an existing attachment.

delete

Deletes an existing attachment.

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.

HTTP status code 500

Server error.

/messageTemplates/{messageTemplateId}/history get

A collection of history.

get

Returns a list of events.

/messageTemplates/{messageTemplateId}/references get

A collection of reference object links.

get

Returns a list of references.

/messageTemplates/{messageTemplateId}/body get put

Set or get the event configuration.

get

Returns the HTML body of the Message Template.

put

Updates the HTML body of the Message Template.

Objects

This resource is used for retrieving Objects.

/objects get

get

Object Types

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

/objectTypes get

get

Returns a list of existing Object Types.

/objectTypes/{ObjectTypeId} get

get

Returns the details of a specific Object Type.

/objectTypes/user get

get

Returns the details of a specific Object Type.

/objectTypes/asset get

get

Returns the details of a specific Object Type.

/objectTypes/object get

get

Returns the details of a specific Object Type.

Players

Show existing Players

/players get

get

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:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['createdTo']: (date)
Created to date. Supported date formats are:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['lastModifiedFrom']: (date)
Last modified from date. Supported date formats are:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['lastModifiedTo']: (date)
Last modified to date. Supported date formats are:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['enabled']: (one of true, false, all)
Enabled flag
MatrixParam['deleted']: (one of true, false, all)
Deleted flag
MatrixParam['approved']: (one of true, false, all)
Approved flag
MatrixParam['accountId']: (number)
You can list multiple Account Ids separated by a colon, e.g. aId=1; aId=2;
MatrixParam['workspaceId']: (number)
You can list multiple Workspace Ids separated by a colon, e.g. wsId=1; wsId=2;
MatrixParam['metadataDefinitionId']: (number)
Metadata Definition Id
MatrixParam['includeNoVariant']: (boolean)
Includes Objects that do not have a Variant.
MatrixParam['includeData']: (boolean)
MatrixParam['parentId’]: (number)
Returns a list of parent Ids. Please note that this matrix parameter can only be used if the parent is a user defined object.
MatrixParam['includeVariables']: (boolean)
Whether or not to include the Variables of Workflows or Jobs in the response.
MatrixParam['ancestorId']: (number)
MatrixParam['level']: (number)
MatrixParam['objectType']: (string)
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
MatrixParam['sort']: (string)
MatrixParam['sortBy']: (string)
callback: (string)
Specifies the call back function for JSONP response.
MatrixParam['assedId']: (integer - minimum: 0)
MatrixParam['assetTitle']: (string)
MatrixParam['definitionId']: (integer - minimum: 0)
MatrixParam['externalId']: (string)
Search for an object via its endpoint (e.g. assets, workflows) and specify the external ID key and value, e.g. For example /api/assets;externalId=key:value

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/players/{playerId} get

get

Returns details of a specific Player

/players/{playerId}/comments get post

A collection of comment.

get

Returns a list of comments.

post

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.

HTTP status code 500

Server error.

/players/{playerId}/comments/{commentId} get

Performs operations on a single comment.

get

Returns a comment.

/players/{playerId}/copy post

post

Copies an existing Player.

URI Parameters

playerId: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": true
    },
    "description": {
      "type": "string",
      "required": false
    }
  }
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/players/{playerId}/followers get

A collection of follower.

get

Returns a list of users that are following this object.

/players/{playerId}/attachments get post

A collection of attachment.

get

Returns a list of attachments.

post

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.

HTTP status code 500

Server error.

/players/{playerId}/attachments/{attachmentId} get put delete

get

Returns the details for a specific attachment.

put

Updates the comment for an existing attachment.

delete

Deletes an existing attachment.

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.

HTTP status code 500

Server error.

/players/{playerId}/history get

A collection of history.

get

Returns a list of events.

/players/{playerId}/references get

A collection of reference object links.

get

Returns a list of references.

/players/{playerId}/externalIds get post

get

Returns a list of external IDs associated with an Account.

post

Creates new external ID.

Returns a list of external IDs associated with an Account.

URI Parameters

playerId: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

HTTP status code 200

Request has been processed successfully.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    },
    "href": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value",
    "href"
  ]
}

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Creates new external ID.

URI Parameters

playerId: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/players/{playerId}/externalIds/{key} get put delete

get

Returns the details for a specific external ID.

put

Updates the Account/System Property.

delete

Deletes a specific external ID.

Updates the Account/System Property.

URI Parameters

playerId: required (string)
key: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Player Definitions

This resource is used for viewing and managing Player Definitions.

/playerDefinitions get

get

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

/playerDefinitions/{playerDefinitionId} get delete

Perform operations on a specific Player Definitions.

get

Returns Player Definition object details.

delete

Deletes a Player Definition.

/playerDefinitions/{playerDefinitionId}/actions get post

get

Returns a list of actions that can be performed.

post

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

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.

HTTP status code 500

Server error.

/playerDefinitions/{playerDefinitionId}/comments get post

A collection of comment.

get

Returns a list of Comments.

post

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.

HTTP status code 500

Server error.

/playerDefinitions/{playerDefinitionId}/comments/{commentId} get

Performs operations on a single Comment.

get

Returns a Comment.

/playerDefinitions/{playerDefinitionId}/copy post

post

Copies an existing Player Definition.

URI Parameters

playerDefinitionId: required (integer)
Player Defintion ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": true
    },
    "description": {
      "type": "string",
      "required": false
    }
  }
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/playerDefinitions/{playerDefinitionId}/followers get

A collection of follower.

get

Returns a list of users that are following this object.

/playerDefinitions/{playerDefinitionId}/attachments get post

A collection of attachment.

get

Returns a list of attachments.

post

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.

HTTP status code 500

Server error.

/playerDefinitions/{playerDefinitionId}/attachments/{attachmentId} get put delete

get

Returns the details for a specific attachment.

put

Updates the comment for an existing attachment.

delete

Deletes an existing attachment.

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.

HTTP status code 500

Server error.

/playerDefinitions/{playerDefinitionId}/history get

A collection of history.

get

Returns a list of events.

/playerDefinitions/{playerDefinitionId}/references get

A collection of reference object links.

get

Returns a list of references.

/playerDefinitions/{playerDefinitionId}/configuration get put

Set or get the player's configuration.

get

Returns the player's configuration including an href to the configuration.

put

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

/playerDefinitions/{playerDefinitionId}/externalIds get post

get

Returns a list of external IDs associated with an Account.

post

Creates new external ID.

Returns a list of external IDs associated with an Account.

URI Parameters

playerDefinitionId: required (integer)
Player Defintion ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

HTTP status code 200

Request has been processed successfully.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    },
    "href": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value",
    "href"
  ]
}

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Creates new external ID.

URI Parameters

playerDefinitionId: required (integer)
Player Defintion ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/playerDefinitions/{playerDefinitionId}/externalIds/{key} get put delete

get

Returns the details for a specific external ID.

put

Updates the Account/System Property

delete

Deletes a specific external ID.

Updates the Account/System Property

URI Parameters

playerDefinitionId: required (integer)
Player Defintion ID
key: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/playerDefinitions/{playerDefinitionId}/configuration/files get

get

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

Plugins

This resource is used for viewing existing Plugins

/plugins get

get

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

Profiles

Perform operations on Profiles

/profiles get post

get

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

post

Create a new profile.

/profiles/{profileId} get put delete

Perform operations on a specific Profile

get

Returns the details of the Profile

put

Update the profile.

delete

Deletes the Profile

/profiles/{profileId}/actions get post

get

Returns a list of actions that can be performed.

post

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

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.

HTTP status code 500

Server error.

/profiles/{profileId}/comments get post

A collection of comment.

get

Returns a list of Comments.

post

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.

HTTP status code 500

Server error.

/profiles/{profileId}/comments/{commentId} get

Performs operations on a single Comment.

get

Returns a Comment.

/profiles/{profileId}/copy post

post

Copies an existing Profile.

URI Parameters

profileId: required (integer)
Profile ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": true
    },
    "description": {
      "type": "string",
      "required": false
    }
  }
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/profiles/{profileId}/followers get

A collection of follower.

get

Returns a list of users that are following this object.

/profiles/{profileId}/attachments get post

A collection of attachment.

get

Returns a list of attachments.

post

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.

HTTP status code 500

Server error.

/profiles/{profileId}/attachments/{attachmentId} get put delete

get

Returns the details for a specific attachment.

put

Updates the comment for an existing attachment.

delete

Deletes an existing attachment.

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.

HTTP status code 500

Server error.

/profiles/{profileId}/history get

A collection of history.

get

Returns a list of events.

/profiles/{profileId}/references get

A collection of reference object links.

get

Returns a list of references.

/profiles/{profileId}/configuration get put

get

Returns the metadata instance of the profile including an href link to the metadata definition.

put

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

/profiles/{profileId}/externalIds get post

get

Returns a list of external IDs associated with an Account.

post

Creates new external ID.

Returns a list of external IDs associated with an Account.

URI Parameters

profileId: required (integer)
Profile ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

HTTP status code 200

Request has been processed successfully.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    },
    "href": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value",
    "href"
  ]
}

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Creates new external ID.

URI Parameters

profileId: required (integer)
Profile ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/profiles/{profileId}/externalIds/{key} get put delete

get

Returns the details for a specific external ID.

put

Updates the Account/System Property

delete

Deletes a specific external ID.

Updates the Account/System Property

URI Parameters

profileId: required (integer)
Profile ID
key: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Quotas

This resource is used for viewing and managing Quotas

/quotas get post

get

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

post

Creates a new Quota.

Request

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": true
    },
        "description": {
          "type": "string",
          "required": false
    },
        "pluginClass": {
          "type": "string",
          "required": true
    },
        "assignment": {
          "type": "integer",
          "required": true
    },
        "resources": {
          "type": "integer",
          "required": true
    },
        "timeout": {
          "type": "string",
          "required": true
    }
  }
}

/quotas/{quotaId} get put delete

Perform operations on a specific Quota.

get

Returns Quota object details.

put

Updates an existing a new Quota.

delete

Deletes a Quota

Updates an existing a new Quota.

URI Parameters

quotaId: required (integer)
Quota ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": true
    },
        "description": {
          "type": "string",
          "required": false
    },
        "assignment": {
          "type": "integer",
          "required": true
    },
        "resources": {
          "type": "integer",
          "required": true
    },
        "timeout": {
          "type": "string",
          "required": true
    }
  }
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/quotas/{quotaId}/actions get post

get

Returns a list of actions that can be performed.

post

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

URI Parameters

quotaId: required (integer)
Quota ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "action": {
      "type": "string",
      "required": true

    }
  }
}

HTTP status code 200

Request has been processed successfully.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "id": {
    "type": "integer",
    "required": false
    },
    "name": {
    "type": "string",
    "required": false
    },
    "type": {
    "type": "string",
    "required": false
    },
    "variant": {
    "type": "string",
    "required": false
    },
    "enabled": {
    "type": "boolean",
    "required": false
    },
    "deleted": {
    "type": "boolean",
    "required": false
    },
    "href": {
    "type": "string",
    "required": false
    },
    "owner": {
    "type": "string",
    "required": false
    }
  }
}

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/quotas/{quotaId}/comments get post

A collection of comment.

get

Returns a list of Comments.

post

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.

HTTP status code 500

Server error.

/quotas/{quotaId}/comments/{commentId} get

Performs operations on a single Comment.

get

Returns a Comment.

/quotas/{quotaId}/copy post

post

Copies an existing Quota.

URI Parameters

quotaId: required (integer)
Quota ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": true
    },
    "description": {
      "type": "string",
      "required": false
    }
  }
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/quotas/{quotaId}/followers get

A collection of follower.

get

Returns a list of users that are following this object.

/quotas/{quotaId}/attachments get post

A collection of attachment.

get

Returns a list of attachments.

post

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.

HTTP status code 500

Server error.

/quotas/{quotaId}/attachments/{attachmentId} get put delete

get

Returns the details for a specific attachment.

put

Updates the comment for an existing attachment.

delete

Deletes an existing attachment.

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.

HTTP status code 500

Server error.

/quotas/{quotaId}/history get

A collection of history.

get

Returns a list of events.

/quotas/{quotaId}/references get

A collection of reference object links.

get

Returns a list of references.

/quotas/{quotaId}/configuration get put

Set or get the quota's configuration.

get

Returns the quota's configuration including an href to the configuration.

put

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

/quotas/{quotaId}/externalIds get post

get

Returns a list of external IDs associated with an Account.

post

Creates new external ID.

Returns a list of external IDs associated with an Account.

URI Parameters

quotaId: required (integer)
Quota ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

HTTP status code 200

Request has been processed successfully.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    },
    "href": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value",
    "href"
  ]
}

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Creates new external ID.

URI Parameters

quotaId: required (integer)
Quota ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/quotas/{quotaId}/externalIds/{key} get put delete

get

Returns the details for a specific external ID.

put

Updates the Account/System Property

delete

Deletes a specific external ID.

Updates the Account/System Property

URI Parameters

quotaId: required (integer)
Quota ID
key: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Report Definitions

This resource is used for viewing Report Definitions

/reportDefinitions get

get

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

/reportDefinitions/{reportDefinitionId} get delete

get

Returns details of a specific Report Definition

delete

Deletes a Report Definition

/reportDefinitions/{reportDefinitionId}/actions get post

get

Returns a list of actions that can be performed.

post

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

URI Parameters

reportDefinitionId: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "action": {
      "type": "string",
      "required": true

    }
  }
}

HTTP status code 200

Request has been processed successfully.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "id": {
    "type": "integer",
    "required": false
    },
    "name": {
    "type": "string",
    "required": false
    },
    "type": {
    "type": "string",
    "required": false
    },
    "variant": {
    "type": "string",
    "required": false
    },
    "enabled": {
    "type": "boolean",
    "required": false
    },
    "deleted": {
    "type": "boolean",
    "required": false
    },
    "href": {
    "type": "string",
    "required": false
    },
    "owner": {
    "type": "string",
    "required": false
    }
  }
}

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/reportDefinitions/{reportDefinitionId}/comments get post

A collection of comment.

get

Returns a list of Comments.

post

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.

HTTP status code 500

Server error.

/reportDefinitions/{reportDefinitionId}/comments/{commentId} get

Performs operations on a single Comment.

get

Returns a Comment.

/reportDefinitions/{reportDefinitionId}/copy post

post

Copies an existing Report Definition.

URI Parameters

reportDefinitionId: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": true
    },
    "description": {
      "type": "string",
      "required": false
    }
  }
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/reportDefinitions/{reportDefinitionId}/followers get

A collection of follower.

get

Returns a list of users that are following this object.

/reportDefinitions/{reportDefinitionId}/attachments get post

A collection of attachment.

get

Returns a list of attachments.

post

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.

HTTP status code 500

Server error.

/reportDefinitions/{reportDefinitionId}/attachments/{attachmentId} get put delete

get

Returns the details for a specific attachment.

put

Updates the comment for an existing attachment.

delete

Deletes an existing attachment.

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.

HTTP status code 500

Server error.

/reportDefinitions/{reportDefinitionId}/history get

A collection of history.

get

Returns a list of events.

/reportDefinitions/{reportDefinitionId}/references get

A collection of reference object links.

get

Returns a list of references.

/reportDefinitions/{reportDefinitionId}/externalIds get post

get

Returns a list of external IDs associated with an Account.

post

Creates new external ID.

Returns a list of external IDs associated with an Account.

URI Parameters

reportDefinitionId: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

HTTP status code 200

Request has been processed successfully.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    },
    "href": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value",
    "href"
  ]
}

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Creates new external ID.

URI Parameters

reportDefinitionId: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/reportDefinitions/{reportDefinitionId}/externalIds/{key} get put delete

get

Returns the details for a specific external ID.

put

Updates the Account/System Property

delete

Deletes a specific external ID.

Updates the Account/System Property

URI Parameters

reportDefinitionId: required (string)
key: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Resources

Perform operations on Resources

/resources get

get

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

/resources/{resourceId} get delete

Perform operations on a specific Resource

get

Returns details of the Resource

delete

Deletes the Resource

/resources/{resourceId}/actions get post

get

Returns a list of actions that can be performed.

post

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

URI Parameters

resourceId: required (integer)
Resource ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "action": {
      "type": "string",
      "required": true

    }
  }
}

HTTP status code 200

Request has been processed successfully.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "id": {
    "type": "integer",
    "required": false
    },
    "name": {
    "type": "string",
    "required": false
    },
    "type": {
    "type": "string",
    "required": false
    },
    "variant": {
    "type": "string",
    "required": false
    },
    "enabled": {
    "type": "boolean",
    "required": false
    },
    "deleted": {
    "type": "boolean",
    "required": false
    },
    "href": {
    "type": "string",
    "required": false
    },
    "owner": {
    "type": "string",
    "required": false
    }
  }
}

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/resources/{resourceId}/comments get post

A collection of comment.

get

Returns a list of Comments.

post

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.

HTTP status code 500

Server error.

/resources/{resourceId}/comments/{commentId} get

Performs operations on a single Comment.

get

Returns a Comment.

/resources/{resourceId}/copy post

post

Copies an existing Resource.

URI Parameters

resourceId: required (integer)
Resource ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": true
    },
    "description": {
      "type": "string",
      "required": false
    }
  }
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/resources/{resourceId}/followers get

A collection of follower.

get

Returns a list of users that are following this object.

/resources/{resourceId}/attachments get post

A collection of attachment.

get

Returns a list of attachments.

post

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.

HTTP status code 500

Server error.

/resources/{resourceId}/attachments/{attachmentId} get put delete

get

Returns the details for a specific attachment.

put

Updates the comment for an existing attachment.

delete

Deletes an existing attachment.

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.

HTTP status code 500

Server error.

/resources/{resourceId}/history get

A collection of history.

get

Returns a list of events.

/resources/{resourceId}/callbacks post

Perform a callback on the specified resource.

post

Performs a callback.

/resources/{resourceId}/configuration get put

get

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

put

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

/resources/{resourceId}/items get

A collection of item.

get

Returns a list of resource items based on specified filters.

/resources/{resourceId}/items/{resourceItemId} get

get

Returns details of a resource item

/resources/{resourceId}/storageResources get

A collection of storageResource.

get

Returns the storage resources for a folder resource.

/resources/{resourceId}/externalIds get post

get

Returns a list of external IDs associated with an Account.

post

Creates new external ID.

Returns a list of external IDs associated with an Account.

URI Parameters

resourceId: required (integer)
Resource ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

HTTP status code 200

Request has been processed successfully.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    },
    "href": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value",
    "href"
  ]
}

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Creates new external ID.

URI Parameters

resourceId: required (integer)
Resource ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/resources/{resourceId}/externalIds/{key} get put delete

get

Returns the details for a specific external ID.

put

Updates the Account/System Property

delete

Deletes a specific external ID.

Updates the Account/System Property

URI Parameters

resourceId: required (integer)
Resource ID
key: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Roles

Perform operation on Roles

/roles get post

get

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

post

Creates a Role

Query Parameters

MatrixParam['name']: (string)
MatrixParam['description']: (string)
MatrixParam['enabled']: (boolean)
MatrixParam['deleted']: (boolean - default: false)
MatrixParam['account']: (string)
MatrixParam['exactNameMatch']: (string)
Pass it true if you want to search an Object using the exact name.
callback: (string)
Specifies the call back function for JSONP response.
MatrixParam['accountId']: (integer - minimum: 0)
Search for a role inside of a specific account.

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.

HTTP status code 500

Server error.

/roles/{roleId} get put delete

Perform operations on a specific Role

get

Returns Role object details.

put

Updates the role that the Id belongs to.

delete

Deletes a Role

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.

HTTP status code 500

Server error.

/roles/{roleId}/actions get post

get

Returns a list of actions that can be performed.

post

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

URI Parameters

roleId: required (integer)
Role ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "action": {
      "type": "string",
      "required": true

    }
  }
}

HTTP status code 200

Request has been processed successfully.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "id": {
    "type": "integer",
    "required": false
    },
    "name": {
    "type": "string",
    "required": false
    },
    "type": {
    "type": "string",
    "required": false
    },
    "variant": {
    "type": "string",
    "required": false
    },
    "enabled": {
    "type": "boolean",
    "required": false
    },
    "deleted": {
    "type": "boolean",
    "required": false
    },
    "href": {
    "type": "string",
    "required": false
    },
    "owner": {
    "type": "string",
    "required": false
    }
  }
}

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/roles/{roleId}/comments get post

A collection of comment.

get

Returns a list of Comments.

post

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.

HTTP status code 500

Server error.

/roles/{roleId}/comments/{commentId} get

Performs operations on a single Comment.

get

Returns a Comment.

/roles/{roleId}/copy post

post

Copies an existing Role.

URI Parameters

roleId: required (integer)
Role ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": true
    },
    "description": {
      "type": "string",
      "required": false
    }
  }
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/roles/{roleId}/followers get

A collection of follower.

get

Returns a list of users that are following this object.

/roles/{roleId}/attachments get post

A collection of attachment.

get

Returns a list of attachments.

post

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.

HTTP status code 500

Server error.

/roles/{roleId}/attachments/{attachmentId} get put delete

get

Returns the details for a specific attachment.

put

Updates the comment for an existing attachment.

delete

Deletes an existing attachment.

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.

HTTP status code 500

Server error.

/roles/{roleId}/history get

A collection of history.

get

Returns a list of events.

/roles/{roleId}/references get

A collection of reference object links.

get

Returns a list of references.

/roles/{roleId}/members get

get

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

/roles/{roleId}/externalIds get post

get

Returns a list of external IDs associated with an Account.

post

Creates new external ID.

Returns a list of external IDs associated with an Account.

URI Parameters

roleId: required (integer)
Role ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

HTTP status code 200

Request has been processed successfully.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    },
    "href": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value",
    "href"
  ]
}

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Creates new external ID.

URI Parameters

roleId: required (integer)
Role ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/roles/{roleId}/externalIds/{key} get put delete

get

Returns the details for a specific external ID.

put

Updates the Account/System Property

delete

Deletes a specific external ID.

Updates the Account/System Property

URI Parameters

roleId: required (integer)
Role ID
key: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Tasks

Perform operation on Tasks

/tasks get

get

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:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['createdTo']: (date)
Created to date. Supported date formats are:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['lastModifiedFrom']: (date)
Last modified from date. Supported date formats are:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['lastModifiedTo']: (date)
Last modified to date. Supported date formats are:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['enabled']: (one of true, false, all)
Enabled flag
MatrixParam['deleted']: (one of true, false, all)
Deleted flag
MatrixParam['approved']: (one of true, false, all)
Approved flag
MatrixParam['accountId']: (number)
You can list multiple Account Ids separated by a colon, e.g. aId=1; aId=2;
MatrixParam['workspaceId']: (number)
You can list multiple Workspace Ids separated by a colon, e.g. wsId=1; wsId=2;
MatrixParam['metadataDefinitionId']: (number)
Metadata Definition Id
MatrixParam['includeNoVariant']: (boolean)
Includes Objects that do not have a Variant.
MatrixParam['includeData']: (boolean)
MatrixParam['parentId’]: (number)
Returns a list of parent Ids. Please note that this matrix parameter can only be used if the parent is a user defined object.
MatrixParam['includeVariables']: (boolean)
Whether or not to include the Variables of Workflows or Jobs in the response.
MatrixParam['ancestorId']: (number)
MatrixParam['level']: (number)
MatrixParam['objectType']: (string)
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
MatrixParam['sort']: (string)
MatrixParam['sortBy']: (string)
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:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['StartedTo']: (date)
Supported date formats are:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['CompletedFrom']: (date)
Supported date formats are:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['CompletedTo']: (date)
Supported date formats are:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['externalId']: (string)
Search for an object via its endpoint (e.g. assets, workflows) and specify the external ID key and value, e.g. For example /api/assets;externalId=key:value

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/tasks/{taskId} get

Perform operations on a specific Task

get

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

/tasks/{taskId}/status post

post

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.

HTTP status code 500

Server error.

Task Definitions

This resource is used for viewing Task Definitions

/taskDefintions get post

get

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

post

Creates a new Task Definition.

Request

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "accountId": {
      "type": "string",
      "required": true
    },
    "name": {
      "type": "string",
      "required": true
    },
    "description": {
      "type": "string",
      "required": true
    },
    "wizardId": {
      "type": "string",
      "required": false
    },
    "expressionAssignment": {
      "type": "string",
      "required": false
    },
    "Assignment": {
      "type": "long",
      "required": false
    },
    "visibilityIds": {
      "type": "long",
      "required": true
    }
  }
}

/taskDefintions/{taskDefinitionId} get put delete

get

Returns details of a specific Task Definition

put

Creates a new Task Definition.

delete

Deletes a Task Definition

Creates a new Task Definition.

URI Parameters

taskDefinitionId: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "accountId": {
      "type": "string",
      "required": true
    },
    "name": {
      "type": "string",
      "required": true
    },
    "description": {
      "type": "string",
      "required": true
    },
    "wizardId": {
      "type": "string",
      "required": false
    },
    "expressionAssignment": {
      "type": "string",
      "required": false
    },
    "Assignment": {
      "type": "long",
      "required": false
    },
    "visibilityIds": {
      "type": "long",
      "required": true
    }
  }
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/taskDefintions/{taskDefinitionId}/actions get post

get

Returns a list of actions that can be performed.

post

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

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.

HTTP status code 500

Server error.

/taskDefintions/{taskDefinitionId}/comments get post

A collection of comment.

get

Returns a list of Comments.

post

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.

HTTP status code 500

Server error.

/taskDefintions/{taskDefinitionId}/comments/{commentId} get

Performs operations on a single Comment.

get

Returns a Comment.

/taskDefintions/{taskDefinitionId}/copy post

post

Copies an existing Task Definition.

URI Parameters

taskDefinitionId: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": true
    },
    "description": {
      "type": "string",
      "required": false
    }
  }
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/taskDefintions/{taskDefinitionId}/followers get

A collection of follower.

get

Returns a list of users that are following this object.

/taskDefintions/{taskDefinitionId}/attachments get post

A collection of attachment.

get

Returns a list of attachments.

post

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.

HTTP status code 500

Server error.

/taskDefintions/{taskDefinitionId}/attachments/{attachmentId} get put delete

get

Returns the details for a specific attachment.

put

Updates the comment for an existing attachment.

delete

Deletes an existing attachment.

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.

HTTP status code 500

Server error.

/taskDefintions/{taskDefinitionId}/history get

A collection of history.

get

Returns a list of events.

/taskDefintions/{taskDefinitionId}/externalIds get post

get

Returns a list of external IDs associated with an Account.

post

Creates new external ID.

Returns a list of external IDs associated with an Account.

URI Parameters

taskDefinitionId: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

HTTP status code 200

Request has been processed successfully.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    },
    "href": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value",
    "href"
  ]
}

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Creates new external ID.

URI Parameters

taskDefinitionId: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/taskDefintions/{taskDefinitionId}/externalIds/{key} get put delete

get

Returns the details for a specific external ID.

put

Updates the Account/System Property

delete

Deletes a specific external ID.

Updates the Account/System Property

URI Parameters

taskDefinitionId: required (string)
key: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Timed Actions

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

/timedActions get post

get

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

post

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.

HTTP status code 500

Server error.

/timedActions/{timedActionId} get put delete

Perform operations on a specific Timed Action

get

Returns details of the Timed Action

put

Update the details of a Timed Action

delete

Deletes a Timed Action

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.

HTTP status code 500

Server error.

/timedActions/{timedActionId}/actions get post

get

Returns a list of actions that can be performed.

post

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

URI Parameters

timedActionId: required (integer)
Timed Action ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "action": {
      "type": "string",
      "required": true

    }
  }
}

HTTP status code 200

Request has been processed successfully.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "id": {
    "type": "integer",
    "required": false
    },
    "name": {
    "type": "string",
    "required": false
    },
    "type": {
    "type": "string",
    "required": false
    },
    "variant": {
    "type": "string",
    "required": false
    },
    "enabled": {
    "type": "boolean",
    "required": false
    },
    "deleted": {
    "type": "boolean",
    "required": false
    },
    "href": {
    "type": "string",
    "required": false
    },
    "owner": {
    "type": "string",
    "required": false
    }
  }
}

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/timedActions/{timedActionId}/comments get post

A collection of comment.

get

Returns a list of Comments.

post

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.

HTTP status code 500

Server error.

/timedActions/{timedActionId}/comments/{commentId} get

Performs operations on a single Comment.

get

Returns a Comment.

/timedActions/{timedActionId}/copy post

post

Copies an existing Metadata Definition.

URI Parameters

timedActionId: required (integer)
Timed Action ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": true
    },
    "description": {
      "type": "string",
      "required": false
    }
  }
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/timedActions/{timedActionId}/followers get

A collection of follower.

get

Returns a list of users that are following this object.

/timedActions/{timedActionId}/attachments get post

A collection of attachment.

get

Returns a list of attachments.

post

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.

HTTP status code 500

Server error.

/timedActions/{timedActionId}/attachments/{attachmentId} get put delete

get

Returns the details for a specific attachment.

put

Updates the comment for an existing attachment.

delete

Deletes an existing attachment.

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.

HTTP status code 500

Server error.

/timedActions/{timedActionId}/history get

A collection of history.

get

Returns a list of events.

/timedActions/{timedActionId}/references get

A collection of reference object links.

get

Returns a list of references.

/timedActions/{timedActionId}/configuration get put

Set or get configuration of the timed-action.

get

Returns the timed-action's configuration including an href to the configuration.

put

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

/timedActions/{timedActionId}/externalIds get post

get

Returns a list of external IDs associated with an Account.

post

Creates new external ID.

Returns a list of external IDs associated with an Account.

URI Parameters

timedActionId: required (integer)
Timed Action ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

HTTP status code 200

Request has been processed successfully.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    },
    "href": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value",
    "href"
  ]
}

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Creates new external ID.

URI Parameters

timedActionId: required (integer)
Timed Action ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/timedActions/{timedActionId}/externalIds/{key} get put delete

get

Returns the details for a specific external ID.

put

Updates the Account/System Property

delete

Deletes a specific external ID.

Updates the Account/System Property

URI Parameters

timedActionId: required (integer)
Timed Action ID
key: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Users

This resource is used for managing Users

/users get post

get

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

post

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.

HTTP status code 500

Server error.

/users/{userId} get delete put

Perform operations on a specific User

get

Returns User object details.

delete

Deletes a User

put

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.

HTTP status code 500

Server error.

/users/{userId}/actions get post

get

Returns a list of actions that can be performed.

post

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

URI Parameters

userId: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "action": {
      "type": "string",
      "required": true

    }
  }
}

HTTP status code 200

Request has been processed successfully.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "id": {
    "type": "integer",
    "required": false
    },
    "name": {
    "type": "string",
    "required": false
    },
    "type": {
    "type": "string",
    "required": false
    },
    "variant": {
    "type": "string",
    "required": false
    },
    "enabled": {
    "type": "boolean",
    "required": false
    },
    "deleted": {
    "type": "boolean",
    "required": false
    },
    "href": {
    "type": "string",
    "required": false
    },
    "owner": {
    "type": "string",
    "required": false
    }
  }
}

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/users/{userId}/comments get post

A collection of comment.

get

Returns a list of Comments.

post

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.

HTTP status code 500

Server error.

/users/{userId}/comments/{commentId} get

Performs operations on a single Comment.

get

Returns a Comment.

/users/{userId}/copy post

post

Copies an existing Action.

URI Parameters

userId: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": true
    },
    "description": {
      "type": "string",
      "required": false
    }
  }
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/users/{userId}/followers get

A collection of follower.

get

Returns a list of users that are following this object.

/users/{userId}/attachments get post

A collection of attachment.

get

Returns a list of attachments.

post

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.

HTTP status code 500

Server error.

/users/{userId}/attachments/{attachmentId} get put delete

get

Returns the details for a specific attachment.

put

Updates the comment for an existing attachment.

delete

Deletes an existing attachment.

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.

HTTP status code 500

Server error.

/users/{userId}/history get

A collection of history.

get

Returns a list of events.

/users/{userId}/references get

A collection of reference object links.

get

Returns a list of references.

/users/{userId}/metadata get put

get

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

put

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

/users/{userId}/groups get

A collection of group object links.

get

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

/users/{userId}/workspaces get

A collection of workspace object links.

get

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

/users/{userId}/accessibleWorkspaces get

A collection of accessibleWorkspace object links.

get

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

/users/{userId}/image get put

get

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

put

Updates the user profile picture.

/users/{userId}/image/{imageId} get

Returns an image.

get

/users/{userId}/activity get

A collection of activity.

get

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

/users/{userId}/following get

A collection of following object links.

get

Returns a list of objects that are followed by the specific user. Listing is based on supplied filters.

/users/{userId}/externalIds get post

get

Returns a list of external IDs associated with an Account.

post

Creates new external ID.

Returns a list of external IDs associated with an Account.

URI Parameters

userId: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

HTTP status code 200

Request has been processed successfully.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    },
    "href": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value",
    "href"
  ]
}

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Creates new external ID.

URI Parameters

userId: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/users/{userId}/externalIds/{key} get put delete

get

Returns the details for a specific external ID.

put

Updates the Account/System Property

delete

Deletes a specific external ID.

Updates the Account/System Property

URI Parameters

userId: required (string)
key: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

User Defined Object Types

This resource is used for viewing User Defined Object Types.

/{userDefinedObjectTypePluralName} get post

get

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

post

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

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.

HTTP status code 500

Server error.

/{userDefinedObjectTypePluralName}/{instanceId}/actions post

post

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

Request

URI Parameters

userDefinedObjectTypePluralName: required (string)
instanceId: required (string)

Body

Type: application/vnd.nativ.mio.v1+json

Schema:


{
  "type": "object",
  "required": true,
  "properties": {
    "action": {
      "type": "string",
      "required": true

    }
  }
}

/{userDefinedObjectTypePluralName}/{userDefinedObjectTypePluralNameId} get put

get

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

put

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

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.

HTTP status code 500

Server error.

/{userDefinedObjectTypePluralName}/data get put

get

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

put

Updates the data for a specific user defined object.

/{userDefinedObjectTypePluralName}/comments get post

A collection of comment.

get

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

post

Posts a new comment on a specific user defined object.

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.

HTTP status code 500

Server error.

/{userDefinedObjectTypePluralName}/comments/{commentId} get put delete

get

Returns a list of details for a specific comment.

put

Updates an existing comment on a specific user defined object.

delete

Deletes an existing comment on a specific user defined object.

/{userDefinedObjectTypePluralName}/copy post

post

Copies an existing User Defined Object.

URI Parameters

userDefinedObjectTypePluralName: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": true
    },
    "description": {
      "type": "string",
      "required": false
    }
  }
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/{userDefinedObjectTypePluralName}/followers get

A collection of follower.

get

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

/{userDefinedObjectTypePluralName}/history get

A collection of history.

get

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

/{userDefinedObjectTypePluralName}/attachments get post

A collection of attachment.

get

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

post

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.

HTTP status code 500

Server error.

/{userDefinedObjectTypePluralName}/references get

A collection of reference.

get

Returns of references for a specific user defined object.

/{userDefinedObjectTypePluralName}/externalIds get post

get

Returns a list of external IDs associated with an Account.

post

Creates new external ID.

Returns a list of external IDs associated with an Account.

URI Parameters

userDefinedObjectTypePluralName: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

HTTP status code 200

Request has been processed successfully.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    },
    "href": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value",
    "href"
  ]
}

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Creates new external ID.

URI Parameters

userDefinedObjectTypePluralName: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/{userDefinedObjectTypePluralName}/externalIds/{key} get put delete

get

Returns the details for a specific external ID.

put

Updates the Account/System Property

delete

Deletes a specific external ID.

Updates the Account/System Property

URI Parameters

userDefinedObjectTypePluralName: required (string)
key: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Variants

This is used for viewing a list of Variants.

/variants get post

get

Returns a list of existing Variants.

post

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
}

/variants/{variantId} get put delete

get

Returns the details of a particular Variant.

put

Allows you to edit a specific Variant.

delete

Allows you to delete a specific variant.

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
}

/variants/copy post

post

Copies an existing Variant.

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": true
    },
    "description": {
      "type": "string",
      "required": false
    }
  }
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/variants/externalIds get post

get

Returns a list of external IDs associated with an Account.

post

Creates new external ID.

Returns a list of external IDs associated with an Account.

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

HTTP status code 200

Request has been processed successfully.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    },
    "href": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value",
    "href"
  ]
}

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Creates new external ID.

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/variants/externalIds/{key} get put delete

get

Returns the details for a specific external ID.

put

Updates the Account/System Property

delete

Deletes a specific external ID.

Updates the Account/System Property

URI Parameters

key: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Wizards

This resource is used for viewing Wizards

/wizards get post

get

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

post

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

Request

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
      "type": "object",
      "required": true,
      "properties": {
        "accountId": {
          "type": "string",
          "required": true
        },
        "name": {
          "type": "string",
          "required": true
        },
        "description": {
          "type": "string",
          "required": false
        },
        "pluginClass": {
          "type": "string",
          "required": true
        },
        "visibilityIds": {
          "type": "long",
          "required": true
        },
        "standAloneWizard": {
          "type": "boolean",
          "required": false
        },
        "taskWizard": {
          "type": "boolean",
          "required": false
        },
        "toolbarWizard": {
          "type": "boolean",
          "required": false
        },
        "runRuleExpression": {
          "type": "string",
          "required": false
        }
      }
    }

/wizards/{wizardId} get put delete

get

Returns details of a specific Wizard

put

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

delete

Deletes a Wizard

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

URI Parameters

wizardId: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
      "type": "object",
      "required": true,
      "properties": {
        "accountId": {
          "type": "string",
          "required": true
        },
        "name": {
          "type": "string",
          "required": true
        },
        "description": {
          "type": "string",
          "required": false
        },
        "pluginClass": {
          "type": "string",
          "required": true
        },
        "visibilityIds": {
          "type": "long",
          "required": true
        },
        "standAloneWizard": {
          "type": "boolean",
          "required": false
        },
        "taskWizard": {
          "type": "boolean",
          "required": false
        },
        "toolbarWizard": {
          "type": "boolean",
          "required": false
        },
        "runRuleExpression": {
          "type": "string",
          "required": false
        }
      }
    }

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/wizards/{wizardId}/actions get post

get

Returns a list of actions that can be performed.

post

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

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.

HTTP status code 500

Server error.

/wizards/{wizardId}/comments get post

A collection of comment.

get

Returns a list of Comments.

post

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.

HTTP status code 500

Server error.

/wizards/{wizardId}/comments/{commentId} get

Performs operations on a single Comment.

get

Returns a Comment.

/wizards/{wizardId}/copy post

post

Copies an existing Wizard.

URI Parameters

wizardId: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": true
    },
    "description": {
      "type": "string",
      "required": false
    }
  }
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/wizards/{wizardId}/followers get

A collection of follower.

get

Returns a list of users that are following this object.

/wizards/{wizardId}/attachments get post

A collection of attachment.

get

Returns a list of attachments.

post

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.

HTTP status code 500

Server error.

/wizards/{wizardId}/attachments/{attachmentId} get put delete

get

Returns the details for a specific attachment.

put

Updates the comment for an existing attachment.

delete

Deletes an existing attachment.

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.

HTTP status code 500

Server error.

/wizards/{wizardId}/history get

A collection of history.

get

Returns a list of events.

/wizards/{wizardId}/references get

A collection of reference object links.

get

Returns a list of references.

/wizards/{wizardId}/instances get

get

Returns all active Wizard instances

/wizards/{wizardId}/externalIds get post

get

Returns a list of external IDs associated with an Account.

post

Creates new external ID.

Returns a list of external IDs associated with an Account.

URI Parameters

wizardId: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

HTTP status code 200

Request has been processed successfully.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    },
    "href": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value",
    "href"
  ]
}

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Creates new external ID.

URI Parameters

wizardId: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/wizards/{wizardId}/externalIds/{key} get put delete

get

Returns the details for a specific external ID.

put

Updates the Account/System Property

delete

Deletes a specific external ID.

Updates the Account/System Property

URI Parameters

wizardId: required (string)
key: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Workflows

This resource is used for viewing Workflows

/workflows get post

get

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

post

Creates a new workflow.

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:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['createdTo']: (date)
Created to date. Supported date formats are:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['lastModifiedFrom']: (date)
Last modified from date. Supported date formats are:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['lastModifiedTo']: (date)
Last modified to date. Supported date formats are:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['enabled']: (one of true, false, all)
Enabled flag
MatrixParam['deleted']: (one of true, false, all)
Deleted flag
MatrixParam['approved']: (one of true, false, all)
Approved flag
MatrixParam['accountId']: (integer - minimum: 0)
MatrixParam['workspaceId']: (number)
You can list multiple Workspace Ids separated by a colon, e.g. wsId=1; wsId=2;
MatrixParam['metadataDefinitionId']: (number)
Metadata Definition Id
MatrixParam['includeNoVariant']: (boolean)
Includes Objects that do not have a Variant.
MatrixParam['includeData']: (boolean)
MatrixParam['parentId’]: (number)
Returns a list of parent Ids. Please note that this matrix parameter can only be used if the parent is a user defined object.
MatrixParam['includeVariables']: (boolean)
Whether or not to include the Variables of Workflows or Jobs in the response.
MatrixParam['ancestorId']: (number)
MatrixParam['level']: (number)
MatrixParam['objectType']: (string)
MatrixParam['offset']: (integer - default: 0 - minimum: 0)
The offset of the first object to retrieve.
MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)
The number of items to be present in the response (default is 100, maximum is 100).
MatrixParam['sort']: (string)
MatrixParam['sortBy']: (string)
callback: (string)
Specifies the call back function for JSONP response.
MatrixParam['definitionId']: (integer - minimum: 0)
MatrixParam['definitionVersion']: (integer - minimum: 0)
MatrixParam['externalId']: (string)
Search for an object via its endpoint (e.g. assets, workflows) and specify the external ID key and value, e.g. For example /api/assets;externalId=key:value
MatrixParam['status']: (one of Running, Ended, Failed, Cancelled, Cancelling, Completed)
You can search for multiple statuses.
MatrixParam['id']: (string)
Filtering by multiple Ids.Example- /api/workflows;id=1234;id=2345;id=3456
MatrixParam['startDateFrom']: (date)
Supported date formats are:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['startDateTo']: (date)
Supported date formats are:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['endDateFrom']: (date)
Supported date formats are:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. now (translated as current date and time)
MatrixParam['endDateTo']: (date)
Supported date formats are:
1. dd MMM yyyy hh:mm:ss Z
2. dd MMM yyyy hh:mm:ss
3. dd MMM yyyy
4. 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.

HTTP status code 500

Server error.

Creates a new workflow.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "definitionId": {
      "type": "integer",
      "required": true
    },
    "assetId": {
      "type": "integer",
      "required": false
    },
    "stringVariables": {
      "type": "object",
      "required": false

    },
    "objectVariables": {
      "type": "object",
      "required": false

    },
    "accountId": {
      "type": "integer",
      "required": false
    },
    "workspaceId": {
      "type": "integer",
      "required": false
    }
  }
}

HTTP status code 201

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "id": {
    "type": "integer",
    "required": false
    },
    "name": {
    "type": "string",
    "required": false
    },
    "type": {
    "type": "string",
    "required": false
    },
    "variant": {
    "type": "string",
    "required": false
    },
    "enabled": {
    "type": "boolean",
    "required": false
    },
    "deleted": {
    "type": "boolean",
    "required": false
    },
    "href": {
    "type": "string",
    "required": false
    },
    "owner": {
    "type": "string",
    "required": false
    }
  }
}

/workflows/groups post

View details of a Workflow group.

post

Creates a Workflow group.

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "maxWorkflows": {
      "type": "integer",
      "required": true

    }
  }
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "id": {
      "type": "long",
      "required": true

    }
  }
}

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/workflows/groups/{groupId} get put

get

Returns the details for a specific Workflow group.

put

Updates the details of a Workflow group.

URI Parameters

groupId: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "maxWorkflows": {
      "type": "integer",
      "required": true

    }
  }
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/workflows/{workflowId} get

View details of a specific Workflow

get

Returns details of the workflow including an href link to the asset and an href link to the workflow definition.

/workflows/{workflowId}/actions get post

get

Returns a list of actions that can be performed.

post

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

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.

HTTP status code 500

Server error.

/workflows/{workflowId}/comments get post

A collection of comment.

get

Returns a list of Comments.

post

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.

HTTP status code 500

Server error.

/workflows/{workflowId}/comments/{commentId} get

Performs operations on a single Comment.

get

Returns a Comment.

/workflows/{workflowId}/copy post

post

Copies an existing Workflow.

URI Parameters

workflowId: required (integer)
Workflow ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": true
    },
    "description": {
      "type": "string",
      "required": false
    }
  }
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/workflows/{workflowId}/followers get

A collection of follower.

get

Returns a list of users that are following this object.

/workflows/{workflowId}/attachments get post

A collection of attachment.

get

Returns a list of attachments.

post

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.

HTTP status code 500

Server error.

/workflows/{workflowId}/attachments/{attachmentId} get put delete

get

Returns the details for a specific attachment.

put

Updates the comment for an existing attachment.

delete

Deletes an existing attachment.

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.

HTTP status code 500

Server error.

/workflows/{workflowId}/history get

A collection of history.

get

Returns a list of events.

/workflows/{workflowId}/references get

A collection of reference object links.

get

Returns a list of references.

/workflows/{workflowId}/jobs get

View the jobs for the workflow instance.

get

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

/workflows/{workflowId}/structure get

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

get

Returns the workflow nodes found by specified id.

/workflows/{workflowId}/signals get post

Perform operations on Workflow signals.

get

Returns a list of signals for the workflow.

post

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.

HTTP status code 500

Server error.

/workflows/{workflowId}/variables get

get

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

/workflows/{workflowId}/externalIds get post

get

Returns a list of external IDs associated with an Account.

post

Creates new external ID.

Returns a list of external IDs associated with an Account.

URI Parameters

workflowId: required (integer)
Workflow ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

HTTP status code 200

Request has been processed successfully.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    },
    "href": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value",
    "href"
  ]
}

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Creates new external ID.

URI Parameters

workflowId: required (integer)
Workflow ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/workflows/{workflowId}/externalIds/{key} get put delete

get

Returns the details for a specific external ID.

put

Updates the Account/System Property

delete

Deletes a specific external ID.

Updates the Account/System Property

URI Parameters

workflowId: required (integer)
Workflow ID
key: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Workflow Definitions

Perform operations on Workflow Definitions

/workflowDefinitions get post

get

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

post

Create a new Workflow Definition

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": true
    },
    "description": {
      "type": "string",
      "required": false
    },
    "visibilityIds": {
      "type": "array",
      "items": {
          "type": "long"
      },
      "minItems": 0,
      "uniqueItems": true,
      "required": true
    }
  }
}

HTTP status code 200

Request has been processed successfully.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "id": {
    "type": "integer",
    "required": false
    },
    "name": {
    "type": "string",
    "required": false
    },
    "type": {
    "type": "string",
    "required": false
    },
    "variant": {
    "type": "string",
    "required": false
    },
    "enabled": {
    "type": "boolean",
    "required": false
    },
    "deleted": {
    "type": "boolean",
    "required": false
    },
    "href": {
    "type": "string",
    "required": false
    },
    "owner": {
    "type": "string",
    "required": false
    }
  }
}

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/workflowDefinitions/{workflowDefinitionId} get put delete

Perform operations on a specific Workflow Definition

get

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

put

Update the details of the Workflow Definition

delete

Deletes the Workflow Definition

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.

HTTP status code 500

Server error.

/workflowDefinitions/{workflowDefinitionId}/actions get post

get

Returns a list of actions that can be performed.

post

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

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.

HTTP status code 500

Server error.

/workflowDefinitions/{workflowDefinitionId}/comments get post

A collection of comment.

get

Returns a list of Comments.

post

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.

HTTP status code 500

Server error.

/workflowDefinitions/{workflowDefinitionId}/comments/{commentId} get

Performs operations on a single Comment.

get

Returns a Comment.

/workflowDefinitions/{workflowDefinitionId}/copy post

post

Copies an existing Workflow Definition.

URI Parameters

workflowDefinitionId: required (integer)
Workflow Definition ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": true
    },
    "description": {
      "type": "string",
      "required": false
    }
  }
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/workflowDefinitions/{workflowDefinitionId}/followers get

A collection of follower.

get

Returns a list of users that are following this object.

/workflowDefinitions/{workflowDefinitionId}/attachments get post

A collection of attachment.

get

Returns a list of attachments.

post

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.

HTTP status code 500

Server error.

/workflowDefinitions/{workflowDefinitionId}/attachments/{attachmentId} get put delete

get

Returns the details for a specific attachment.

put

Updates the comment for an existing attachment.

delete

Deletes an existing attachment.

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.

HTTP status code 500

Server error.

/workflowDefinitions/{workflowDefinitionId}/history get

A collection of history.

get

Returns a list of events.

/workflowDefinitions/{workflowDefinitionId}/image get

get

Get the workflow definition graph image.

/workflowDefinitions/{workflowDefinitionId}/nodes get put

View and create worflow-defintion nodes.

get

Returns the workflow-definition nodes found by specified id.

put

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

/workflowDefinitions/{workflowDefinitionId}/structure get put

get

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

put

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

/workflowDefinitions/{workflowDefinitionId}/externalIds get post

get

Returns a list of external IDs associated with an Account.

post

Creates new external ID.

Returns a list of external IDs associated with an Account.

URI Parameters

workflowDefinitionId: required (integer)
Workflow Definition ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

HTTP status code 200

Request has been processed successfully.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    },
    "href": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value",
    "href"
  ]
}

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Creates new external ID.

URI Parameters

workflowDefinitionId: required (integer)
Workflow Definition ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/workflowDefinitions/{workflowDefinitionId}/externalIds/{key} get put delete

get

Returns the details for a specific external ID.

put

Updates the Account/System Property

delete

Deletes a specific external ID.

Updates the Account/System Property

URI Parameters

workflowDefinitionId: required (integer)
Workflow Definition ID
key: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Workspaces

This resource is used for viewing and managing Workspaces

/workspaces get post

get

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

post

Creates a new Workspace

/workspaces/{workspaceId} get put delete

Perform operations on a specific Workspace

get

Returns Workspace object details.

put

Updates a Workspace.

delete

Deletes a Workspace

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.

HTTP status code 500

Server error.

/workspaces/{workspaceId}/actions get post

get

Returns a list of actions that can be performed.

post

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

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.

HTTP status code 500

Server error.

/workspaces/{workspaceId}/comments get post

A collection of comment.

get

Returns a list of Comments.

post

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.

HTTP status code 500

Server error.

/workspaces/{workspaceId}/comments/{commentId} get

Performs operations on a single Comment.

get

Returns a Comment.

/workspaces/{workspaceId}/copy post

post

Copies an existing Workspace.

URI Parameters

workspaceId: required (integer)
Workspace ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": true
    },
    "description": {
      "type": "string",
      "required": false
    }
  }
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/workspaces/{workspaceId}/followers get

A collection of follower.

get

Returns a list of users that are following this object.

/workspaces/{workspaceId}/attachments get post

A collection of attachment.

get

Returns a list of attachments.

post

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.

HTTP status code 500

Server error.

/workspaces/{workspaceId}/attachments/{attachmentId} get put delete

get

Returns the details for a specific attachment.

put

Updates the comment for an existing attachment.

delete

Deletes an existing attachment.

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.

HTTP status code 500

Server error.

/workspaces/{workspaceId}/history get

A collection of history.

get

Returns a list of events.

/workspaces/{workspaceId}/references get

A collection of reference object links.

get

Returns a list of references.

/workspaces/{workspaceId}/metadata get put

Set or get metadata of the workspace.

get

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

put

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

/workspaces/{workspaceId}/members get

The workspace members

get

Returns the workspace members found by the specified ID.

/workspaces/{workspaceId}/externalIds get post

get

Returns a list of external IDs associated with an Account.

post

Creates new external ID.

Returns a list of external IDs associated with an Account.

URI Parameters

workspaceId: required (integer)
Workspace ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

HTTP status code 200

Request has been processed successfully.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    },
    "href": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value",
    "href"
  ]
}

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Creates new external ID.

URI Parameters

workspaceId: required (integer)
Workspace ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/workspaces/{workspaceId}/externalIds/{key} get put delete

get

Returns the details for a specific external ID.

put

Updates the Account/System Property

delete

Deletes a specific external ID.

Updates the Account/System Property

URI Parameters

workspaceId: required (integer)
Workspace ID
key: required (string)

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.

Body

Type: application/vnd.nativ.mio.v1+json

Schema:

{
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

Request has been processed successfully and a new resource has been created.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Dalet Flex Core

version 5.5.7

Accounts

get /accounts

Query Parameters

HTTP status code 200

HTTP status code 201

HTTP status code 401

HTTP status code 404

HTTP status code 500

post /accounts

Query Parameters

Body

HTTP status code 200

HTTP status code 201

HTTP status code 401

HTTP status code 404

HTTP status code 500

get /accounts/{accountId}

URI Parameters

Query Parameters

HTTP status code 200

HTTP status code 201

HTTP status code 401

HTTP status code 404

HTTP status code 500

delete /accounts/{accountId}

URI Parameters

Query Parameters

HTTP status code 200

HTTP status code 201

HTTP status code 401

HTTP status code 404

HTTP status code 500

put /accounts/{accountId}

URI Parameters

Query Parameters

Body

HTTP status code 200

HTTP status code 201

HTTP status code 401

HTTP status code 404

HTTP status code 500

get /accounts/{accountId}/actions

URI Parameters

Query Parameters

HTTP status code 200

HTTP status code 201

HTTP status code 401

HTTP status code 404

HTTP status code 500

post /accounts/{accountId}/actions

URI Parameters

Query Parameters

Body

HTTP status code 200

Body

HTTP status code 201

HTTP status code 401

HTTP status code 404

HTTP status code 500

put /accounts/{accountId}/actions

URI Parameters

Query Parameters

HTTP status code 200

HTTP status code 201

HTTP status code 401

HTTP status code 404

HTTP status code 500

get /accounts/{accountId}/comments

URI Parameters

Query Parameters

HTTP status code 200

HTTP status code 201

HTTP status code 401

HTTP status code 404

HTTP status code 500

post /accounts/{accountId}/comments

URI Parameters

Query Parameters