Ooyala Flex Core

Query Parameters

• MatrixParam['name']: (string)
• MatrixParam['description']: (string)
• MatrixParam['enabled']: (boolean)
• MatrixParam['deleted']: (boolean - default: false)
• MatrixParam['account']: (string)
• MatrixParam['exactNameMatch']: (string)

  Pass it true if you want to search an Object using the exact name.

• callback: (string)

  Specifies the call back function for JSONP response.

• MatrixParam['offset']: (integer - default: 0 - minimum: 0)

  The offset of the first object to retrieve.

• MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)

  The number of items to be present in the response (default is 100, maximum is 100).

• MatrixParam['sort']: (string)
• MatrixParam['sortBy']: (string)

  This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration

• MatrixParam['externalId']: (string)

  Search for an object via its endpoint (e.g. assets, workflows) and specify the external ID key and value, e.g. For example /api/assets;externalId=key:value

Query Parameters

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

URI Parameters

• accountId: required (integer)

  Account ID

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

URI Parameters

• accountId: required (integer)

  Account ID

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

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

URI Parameters

• accountId: required (integer)

  Account ID

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

• MatrixParam['context']: (string)

  This query parameter enables you to retrieve a list of objects with references. For example if you wanted to retrieve a list of actions with references, you would do the following /api/actions?context=reference.

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

URI Parameters

• accountId: required (integer)

  Account ID

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

URI Parameters

• accountId: required (integer)

  Account ID

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

• MatrixParam['offset']: (integer - default: 0 - minimum: 0)

  The offset of the first object to retrieve.

• MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)

  The number of items to be present in the response (default is 100, maximum is 100).

• MatrixParam['sort']: (string)
• MatrixParam['sortBy']: (string)

  This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration

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

URI Parameters

• accountId: required (integer)

  Account ID

• commentId: required (integer)

  Comment ID

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

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

URI Parameters

• accountId: required (integer)

  Account ID

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

• MatrixParam['offset']: (integer - default: 0 - minimum: 0)

  The offset of the first object to retrieve.

• MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)

  The number of items to be present in the response (default is 100, maximum is 100).

• MatrixParam['sort']: (string)
• MatrixParam['sortBy']: (string)

  This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration

URI Parameters

• accountId: required (integer)

  Account ID

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

• MatrixParam['offset']: (integer - default: 0 - minimum: 0)

  The offset of the first object to retrieve.

• MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)

  The number of items to be present in the response (default is 100, maximum is 100).

• MatrixParam['sort']: (string)
• MatrixParam['sortBy']: (string)

  This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration

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

URI Parameters

• accountId: required (integer)

  Account ID

• attachmentId: required (string)

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

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

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

URI Parameters

• accountId: required (integer)

  Account ID

Query Parameters

• MatrixParam['objectId']: (integer - minimum: 0)
• MatrixParam['objectType']: (string)

  One or more objectTypes can be provided. This parameter can't be used when an objectId is already provided.

• MatrixParam['accountId']: (string)

  One or more accountId can be provided.

• MatrixParam['severity']: (one of Info, Error, Warn)

  One or more severities can be provided.

• MatrixParam['eventType']: (string)

  One or more eventTypes can be provided.

• MatrixParam['ownerId']: (integer - minimum: 0)
• MatrixParam['from']: (date)

  Last modified to date. Supported date formats are:

  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['to']: (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['attribute']: (string)

  One or more attributes can be provided.

• MatrixParam['value']: (string)

  One or more values can be provided.

• callback: (string)

  Specifies the call back function for JSONP response.

• MatrixParam['offset']: (integer - default: 0 - minimum: 0)

  The offset of the first object to retrieve.

• MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)

  The number of items to be present in the response (default is 100, maximum is 100).

• MatrixParam['sort']: (string)
• MatrixParam['sortBy']: (string)

  This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration

URI Parameters

• accountId: required (integer)

  Account ID

Headers

• Accept: (string)

  Method will return JSON by default, but will return XML if set to application/xml.

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

URI Parameters

• accountId: required (integer)

  Account ID

Headers

• Accept: (string)

  Method will return JSON by default, but will return XML if set to application/xml.

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

Body

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

URI Parameters

• accountId: required (integer)

  Account ID

Query Parameters

• MatrixParam['name']: (string)
• MatrixParam['description']: (string)
• MatrixParam['enabled']: (boolean)
• MatrixParam['deleted']: (boolean - default: false)
• MatrixParam['account']: (string)
• MatrixParam['exactNameMatch']: (string)

  Pass it true if you want to search an Object using the exact name.

• MatrixParam['firstName']: (string)
• MatrixParam['lastName']: (string)
• MatrixParam['company']: (string)
• MatrixParam['roleId']: (integer - minimum: 0)
• MatrixParam['email']: (string)
• MatrixParam['accoundId']: (integer - minimum: 0)
• MatrixParam['variant']: (string)
• callback: (string)

  Specifies the call back function for JSONP response.

• MatrixParam['offset']: (integer - default: 0 - minimum: 0)

  The offset of the first object to retrieve.

• MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)

  The number of items to be present in the response (default is 100, maximum is 100).

• MatrixParam['sort']: (string)
• MatrixParam['sortBy']: (string)

  This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration

URI Parameters

• accountId: required (integer)

  Account ID

Query Parameters

• MatrixParam['name']: (string)
• MatrixParam['description']: (string)
• MatrixParam['enabled']: (boolean)
• MatrixParam['deleted']: (boolean - default: false)
• MatrixParam['account']: (string)
• MatrixParam['exactNameMatch']: (string)

  Pass it true if you want to search an Object using the exact name.

• callback: (string)

  Specifies the call back function for JSONP response.

• MatrixParam['offset']: (integer - default: 0 - minimum: 0)

  The offset of the first object to retrieve.

• MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)

  The number of items to be present in the response (default is 100, maximum is 100).

• MatrixParam['sort']: (string)
• MatrixParam['sortBy']: (string)

  This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration

• MatrixParam['userId']: (integer - minimum: 0)
• MatrixParam['variant']: (string)
• MatrixParam['skipCount']: (boolean)

  This parameter skips the count query execution when fetching a record.

URI Parameters

• accountId: required (integer)

  Account ID

Query Parameters

• MatrixParam['name']: (string)
• MatrixParam['description']: (string)
• MatrixParam['enabled']: (boolean)
• MatrixParam['deleted']: (boolean - default: false)
• MatrixParam['account']: (string)
• MatrixParam['exactNameMatch']: (string)

  Pass it true if you want to search an Object using the exact name.

• callback: (string)

  Specifies the call back function for JSONP response.

• MatrixParam['offset']: (integer - default: 0 - minimum: 0)

  The offset of the first object to retrieve.

• MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)

  The number of items to be present in the response (default is 100, maximum is 100).

• MatrixParam['sort']: (string)
• MatrixParam['sortBy']: (string)

  This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration

• MatrixParam['variant']: (string)
• MatrixParam['accountId']: (integer - minimum: 0)
• MatrixParam['parenAccountId']: (integer - minimum: 0)

  If no parentAccountId is provided, the accountId will used instead (if it is provided).

• MatrixParam['skipCount']: (boolean)

  This parameter skips the count query execution when fetching a record.

URI Parameters

• accountId: required (integer)

  Account ID

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

• MatrixParam['offset']: (integer - default: 0 - minimum: 0)

  The offset of the first object to retrieve.

• MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)

  The number of items to be present in the response (default is 100, maximum is 100).

• MatrixParam['sort']: (string)
• MatrixParam['sortBy']: (string)

  This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration

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

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

URI Parameters

• accountId: required (integer)

  Account ID

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

URI Parameters

• accountId: required (integer)

  Account ID

Query Parameters

• MatrixParam['name']: (string)
• MatrixParam['description']: (string)
• MatrixParam['enabled']: (boolean)
• MatrixParam['deleted']: (boolean - default: false)
• MatrixParam['account']: (string)
• MatrixParam['exactNameMatch']: (string)

  Pass it true if you want to search an Object using the exact name.

• callback: (string)

  Specifies the call back function for JSONP response.

• MatrixParam['offset']: (integer - default: 0 - minimum: 0)

  The offset of the first object to retrieve.

• MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)

  The number of items to be present in the response (default is 100, maximum is 100).

• MatrixParam['sort']: (string)
• MatrixParam['sortBy']: (string)

  This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration

URI Parameters

• accountId: required (integer)

  Account ID

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

URI Parameters

• accountId: required (integer)

  Account ID

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

URI Parameters

• accountId: required (integer)

  Account ID

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

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

URI Parameters

• accountId: required (integer)

  Account ID

• key: required (string)

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

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

URI Parameters

• accountId: required (integer)

  Account ID

• key: required (string)

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

Query Parameters

• MatrixParam['offset']: (integer - default: 0 - minimum: 0)

  The offset of the first object to retrieve.

• MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)

  The number of items to be present in the response (default is 100, maximum is 100).

• MatrixParam['sort']: (string)
• MatrixParam['sortBy']: (string)

  This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration

• callback: (string)

  Specifies the call back function for JSONP response.

• MatrixParam['externalId']: (string)

  Search for an object via its endpoint (e.g. assets, workflows) and specify the external ID key and value, e.g. For example /api/assets;externalId=key:value

• MatrixParam['skipCount']: (boolean)

  This parameter skips the count query execution when fetching a record.

Query Parameters

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

URI Parameters

• accountPropertyId: required (integer)

  Account Property ID

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

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

URI Parameters

• accountPropertyId: required (integer)

  Account Property ID

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

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

URI Parameters

• accountPropertyId: required (integer)

  Account Property ID

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

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

URI Parameters

• accountPropertyId: required (integer)

  Account Property ID

• key: required (string)

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

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

URI Parameters

• accountPropertyId: required (integer)

  Account Property ID

• key: required (string)

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

• MatrixParam['externalId']: (string)

  Search for an object via its endpoint (e.g. assets, workflows) and specify the external ID key and value, e.g. For example /api/assets;externalId=key:value

• MatrixParam['skipCount']: (boolean)

  This parameter skips the count query execution when fetching a record.

Query Parameters

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

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

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

URI Parameters

• key: required (string)

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

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

URI Parameters

• key: required (string)

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

Query Parameters

• MatrixParam['name']: (string)
• MatrixParam['description']: (string)
• MatrixParam['enabled']: (boolean)
• MatrixParam['deleted']: (boolean - default: false)
• MatrixParam['account']: (string)
• MatrixParam['exactNameMatch']: (string)

  Pass it true if you want to search an Object using the exact name.

• MatrixParam['offset']: (integer - default: 0 - minimum: 0)

  The offset of the first object to retrieve.

• MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)

  The number of items to be present in the response (default is 100, maximum is 100).

• MatrixParam['sort']: (string)
• MatrixParam['sortBy']: (string)

  This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration

• callback: (string)

  Specifies the call back function for JSONP response.

• MatrixParam['type']: (string)

  The action type

• MatrixParam['externalId']: (string)

  Search for an object via its endpoint (e.g. assets, workflows) and specify the external ID key and value, e.g. For example /api/assets;externalId=key:value

• MatrixParam['skipCount']: (boolean)

  This parameter skips the count query execution when fetching a record.

• MatrixParam['context']: (boolean)

  This parameter returns a list of actions associated with a specific asset type. Example- api/actions?context=type

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

Body

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

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": true
    },
    "description": {
      "type": "string",
      "required": false
    },
    "type": {
      "type": "string",
      "required": true
    },
    "pluginClass": {
      "type": "string",
      "required": true
    },
    "runRuleExpression": {
      "type": "string",
      "required": false
    },
    "timeout": {
      "type": "integer",
      "required": false
    },
    "visibilityIds": {
      "type": "array",
      "items": {
          "type": "string"
      },
      "minItems": 0,
      "uniqueItems": true,
      "required": true
    },
    "undoAction": {
      "type": "integer",
      "required": false
    },
    "redoAction": {
      "type": "integer",
      "required": false
    }
  }
}

URI Parameters

• actionId: required (integer)

  Action ID

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

URI Parameters

• actionId: required (integer)

  Action ID

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

Body

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

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": false
    },
    "description": {
      "type": "string",
      "required": false
    },
    "runRuleExpression": {
      "type": "string",
      "required": false
    },
    "timeout": {
      "type": "integer",
      "required": false
    },
    "visibilityIds": {
      "type": "array",
      "items": {
          "type": "string"
      },
      "minItems": 0,
      "uniqueItems": true,
      "required": false
    },
    "undoAction": {
      "type": "integer",
      "required": false
    },
    "redoAction": {
      "type": "integer",
      "required": false
    }
  }
}

URI Parameters

• actionId: required (integer)

  Action ID

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

URI Parameters

• actionId: required (integer)

  Action ID

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

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

URI Parameters

• actionId: required (integer)

  Action ID

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

• MatrixParam['offset']: (integer - default: 0 - minimum: 0)

  The offset of the first object to retrieve.

• MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)

  The number of items to be present in the response (default is 100, maximum is 100).

• MatrixParam['sort']: (string)
• MatrixParam['sortBy']: (string)

  This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration

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

URI Parameters

• actionId: required (integer)

  Action ID

• commentId: required (integer)

  Comment ID

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

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

URI Parameters

• actionId: required (integer)

  Action ID

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

• MatrixParam['offset']: (integer - default: 0 - minimum: 0)

  The offset of the first object to retrieve.

• MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)

  The number of items to be present in the response (default is 100, maximum is 100).

• MatrixParam['sort']: (string)
• MatrixParam['sortBy']: (string)

  This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration

URI Parameters

• actionId: required (integer)

  Action ID

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

• MatrixParam['offset']: (integer - default: 0 - minimum: 0)

  The offset of the first object to retrieve.

• MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)

  The number of items to be present in the response (default is 100, maximum is 100).

• MatrixParam['sort']: (string)
• MatrixParam['sortBy']: (string)

  This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration

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

URI Parameters

• actionId: required (integer)

  Action ID

• attachmentId: required (string)

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

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

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

URI Parameters

• actionId: required (integer)

  Action ID

Query Parameters

• MatrixParam['objectId']: (integer - minimum: 0)
• MatrixParam['objectType']: (string)

  One or more objectTypes can be provided. This parameter can't be used when an objectId is already provided.

• MatrixParam['accountId']: (string)

  One or more accountId can be provided.

• MatrixParam['severity']: (one of Info, Error, Warn)

  One or more severities can be provided.

• MatrixParam['eventType']: (string)

  One or more eventTypes can be provided.

• MatrixParam['ownerId']: (integer - minimum: 0)
• MatrixParam['from']: (date)

  Last modified to date. Supported date formats are:

  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['to']: (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['attribute']: (string)

  One or more attributes can be provided.

• MatrixParam['value']: (string)

  One or more values can be provided.

• callback: (string)

  Specifies the call back function for JSONP response.

• MatrixParam['offset']: (integer - default: 0 - minimum: 0)

  The offset of the first object to retrieve.

• MatrixParam['limit']: (integer - default: 100 - minimum: 1 - maximum: 100)

  The number of items to be present in the response (default is 100, maximum is 100).

• MatrixParam['sort']: (string)
• MatrixParam['sortBy']: (string)

  This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration

URI Parameters

• actionId: required (integer)

  Action ID

Headers

• Accept: (string)

  Method will return JSON by default, but will return XML if set to application/xml.

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

URI Parameters

• actionId: required (integer)

  Action ID

Headers

• Accept: (string)

  Method will return JSON by default, but will return XML if set to application/xml.

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

Body

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

URI Parameters

• actionId: required (integer)

  Action ID

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

URI Parameters

• actionId: required (integer)

  Action ID

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

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

URI Parameters

• actionId: required (integer)

  Action ID

• key: required (string)

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

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

URI Parameters

• actionId: required (integer)

  Action ID

• key: required (string)

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

URI Parameters

• actionId: required (integer)

  Action ID

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

URI Parameters

• actionId: required (integer)

  Action ID

• variableId: required (string)

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

URI Parameters

• actionId: required (integer)

  Action ID

• variableId: required (string)

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

• MatrixParam['assetIds']: (boolean)

  This parameter enables you to view the action types that are associated with one or more specific assets. For example api/actionTypes;assetIds=;assetIds=

• MatrixParam['context']: (string)

  This query parameter enables you to retrieve a list of objects with references. For example if you wanted to retrieve a list of task definitions with references, you would do the following /api/actions?context=reference.

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']: (boolean)

  This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration

• callback: (string)

  Specifies the call back function for JSONP response.

• MatrixParam['includeMetadata']: (boolean)

  Include metadata in the response

• MatrixParam['assetType']: (one of Group, File)

  Type of Assets

• MatrixParam['fileType']: (string - default: all types - minLength: 1)

  One or more file types of Assets. An Asset Type must be specified before specifying a file type. Asset types are as follows- 'media', 'text', 'subtitle", "image".

• MatrixParam['id']: (string)

  Filtering by multiple Ids.Example- /api/assets;id=1234;id=2345;id=3456.

• MatrixParam['status']: (one of ARCHIVED, DELETED, PUBLISHED, PURGED)

  Status of Assets

• MatrixParam['creationContext']: (one of ingest, proxy, copy, transcode, new, transform)

  The creation context of Assets.

• MatrixParam['referenceName']: (string)
• MatrixParam['managed']: (string)

  Whether the Assets are managed or not

• MatrixParam['folderResourceId']: (integer - minimum: 0)

  ID of the folder resource

• MatrixParam['originalFileName']: (string)

  The original filename

• MatrixParam['technicalType']: (one of Media, Image)

  Different criteria can be applied to Assets depending on which technical type has been chosen.

• MatrixParam['format']: (string)

  Only applies to Media

• MatrixParam['streamCount']: (integer)

  Only applies to Media

• MatrixParam['audioStreamCount']: (integer)

  Only applies to Media

• MatrixParam['videoStreamCount']: (string)

  Only applies to Media

• MatrixParam['internalMetadata']: (string)

  Only applies to Media

• MatrixParam['bitRate']: (integer)

  Only applies to Media

• MatrixParam['bitRateUnits']: (string - default: bit/s)

  Only applies to Media

• MatrixParam['fileSize']: (integer)

  Only applies to Media

• MatrixParam['fileSizeUnits']: (string - default: B)

  Only applies to Media

• MatrixParam['duration']: (integer)

  Only applies to Media

• MatrixParam['durationUnits']: (string - default: µs)

  Only applies to Media

• MatrixParam['keyframeDescription']: (string)

  Search for a specific keyframe description. Only applies to Media.

• MatrixParam['videoCodec']: (string)

  Only applies to Media

• MatrixParam['frameRate']: (string)

  Only applies to Media

• MatrixParam['pixelAspectRatio']: (string)

  Only applies to Media

• MatrixParam['frameWidth']: (integer)

  Only applies to Media

• MatrixParam['frameHeight']: (integer)

  Only applies to Media

• MatrixParam['interlaceFormat']: (string)

  Only applies to Media

• MatrixParam['pixelFormat']: (string)

  Only applies to Media

• MatrixParam['standard']: (string)

  Only applies to Media

• MatrixParam['videoLanguage']: (string)

  Only applies to Media

• MatrixParam['videoBitRate']: (integer)

  Only applies to Media

• MatrixParam['videoBitRateUnits']: (string - default: bit/s)

  Only applies to Media

• MatrixParam['audioCodec']: (string)

  Only applies to Media

• MatrixParam['sampleRate']: (string)

  Only applies to Media

• MatrixParam['channels']: (integer)

  Only applies to Media

• MatrixParam['bitsPerSample']: (integer)

  Only applies to Media

• MatrixParam['audioLanguage']: (string)

  Only applies to Media

• MatrixParam['audioBitRate']: (integer)

  Only applies to Media

• MatrixParam['audioBitRateUnits']: (string - default: bit/s)

  Only applies to Media

• MatrixParam['imageFormat']: (string)

  Only applies to Image

• MatrixParam['width']: (integer)

  Only applies to Image

• MatrixParam['height']: (integer)

  Only applies to Image

• MatrixParam['widthResolution']: (string)

  Only applies to Image

• MatrixParam['heightResolution']: (string)

  Only applies to Image

• MatrixParam['colorMode']: (string)

  Only applies to Image

• MatrixParam['bitsPerPixel']: (integer)

  Only applies to Image

• MatrixParam['exactNameMatch']: (string)

  Pass it true if you want to search asset with exact name

• MatrixParam['externalId']: (string)

  Search for an object via its endpoint (e.g. assets, workflows) and specify the external ID key and value, e.g. For example /api/assets;externalId=key:value

• MatrixParam['signedURL']: (string)

  Returns a link to an asset stored in s3. This link enables you to download a file stored in s3 without needing to log in.

• MatrixParam['skipCount']: (boolean)

  This parameter skips the count query execution when fetching a record.

• MatrixParam['publishedFrom']: (boolean)

  This parameter enables users to search assets published from a certain date.

• MatrixParam['publishedTo']: (boolean)

  This parameter enables users to search assets published up to a certain date.

Query Parameters

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

URI Parameters

• assetId: required (integer)

  Asset ID

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

• MatrixParam['includeMetadata']: (boolean)

  Include metadata in the response

• MatrixParam['skipCount']: (boolean)

  This parameter skips the count query execution when fetching a record.

URI Parameters

• assetId: required (integer)

  Asset ID

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

Body

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

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": false
    },
    "description": {
      "type": "string",
      "required": false
    },
    "referenceName": {
      "type": "string",
      "required": false
    },
    "assetOrigin": {
      "type": "string",
      "required": false
    },
    "variant": {
      "type": "string",
      "required": false
    },
    "metadataDefinitionId": {
      "type": "integer",
      "required": false
    },
    "referenceName": {
      "type": "string",
      "required": false
    },
    "fileDetails": {
      "type": "array",
      "required": false
    },
    "assetContext": {
    "type": "array",
    "required": false
    },
    "type": {
    "type": "string",
    "required": false
    },
    "formatContext": {
    "type": "array",
    "required": false
    },
    "format": {
    "type": "string",
    "required": false
    },
    "duration": {
    "type": "integer",
    "required": false
    },
    "bitRate": {
    "type": "integer",
    "required": false
    },
    "vfsLocation": {
    "type": "array",
    "required": false
    },
    "protocol": {
    "type": "string",
    "required": false
    },
    "path": {
    "type": "string",
    "required": false
    },
    "mimeType": {
    "type": "string",
    "required": false
    }
  }
}

URI Parameters

• assetId: required (integer)

  Asset ID

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.

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

URI Parameters

• assetId: required (integer)

  Asset ID

Query Parameters

• callback: (string)

  Specifies the call back function for JSONP response.