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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 a 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": "boolean",
        "required": false
        },
        "href": {
        "type": "string",
        "required": false
        },
        "owner": {
        "type": "string",
        "required": false
        }
      }
    }
  }
}

HTTP status code 201

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

HTTP status code 400

Invalid input.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Updates the properties for the Account.

URI Parameters

accountId: required (integer)
Account ID

Query Parameters

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

Body

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

Schema:

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

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

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

HTTP status code 400

Invalid input.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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": "boolean",
        "required": false
        },
        "href": {
        "type": "string",
        "required": false
        },
        "owner": {
        "type": "string",
        "required": false
        }
      }
    }
  }
}

HTTP status code 201

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

HTTP status code 400

Invalid input.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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
    },
    "timeout": {
      "type": "integer",
      "required": false
    },
    "visibilityIds": {
      "type": "array",
      "items": {
          "type": "string"
      },
      "minItems": 0,
      "uniqueItems": true,
      "required": true
    },
    "undoAction": {
      "type": "integer",
      "required": false
    },
    "redoAction": {
      "type": "integer",
      "required": false
    }
  }
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

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

Body

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

Schema:

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

HTTP status code 400

Invalid input.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/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
    },
    "timeout": {
      "type": "integer",
      "required": false
    },
    "visibilityIds": {
      "type": "array",
      "items": {
          "type": "string"
      },
      "minItems": 0,
      "uniqueItems": true,
      "required": false
    },
    "undoAction": {
      "type": "integer",
      "required": false
    },
    "redoAction": {
      "type": "integer",
      "required": false
    }
  }
}

HTTP status code 200

Returns the updated action.

Body

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

HTTP status code 201

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

HTTP status code 400

Invalid input.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 a 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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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.

Action Types

This resource lists all the action types that are associated with a specific asset.

/actionTypes get

get

Returns a list of all the action types that are associated with a specific asset.

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.
MatrixParam['assetIds']: (boolean)
This parameter enables you to view the action types that are associated with one or more specific assets. For example api/actionTypes;assetIds=;assetIds=
MatrixParam['context']: (string)
This query parameter enables you to retrieve a list of objects with references. For example if you wanted to retrieve a list of task definitions with references, you would do the following /api/actions?context=reference.

HTTP status code 200

Request has been processed successfully.

Body

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

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "id": {
      "type": "string",
      "required": true
    },
    "mimeType": {
      "name": "string",
      "required": true
    },
    "displayName": {
      "type": "string",
      "required": true
    },
    "href": {
      "type": "string",
      "required": true
    },
    "category": {
      "type": "string",
      "required": true
    },
    "supportsWorkflow": {
      "type": "boolean",
      "required": true
    },
    "supportsManualLaunch": {
      "type": "boolean",
      "required": true
    },
    "supportsGroupExecution": {
      "type": "boolean",
      "required": true
    },
    "supportsGroupMemberExecution": {
      "type": "boolean",
      "required": true
    },
    "iconName": {
      "type": "string",
      "required": true
    },
    "runRuleExpression": {
      "type": "string",
      "required": true
    },
    "supportsRedo": {
      "type": "boolean",
      "required": true
    },
    "supportsUndo": {
      "type": "string",
      "required": true
    }
  }
}

HTTP status code 201

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

HTTP status code 400

Invalid input.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Assets

This resource is used for managing Assets

/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']: (boolean)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
callback: (string)
Specifies the call back function for JSONP response.
MatrixParam['includeMetadata']: (boolean)
Include metadata in the response
MatrixParam['assetType']: (one of Group, File)
Type of Assets
MatrixParam['fileType']: (string - default: all types - minLength: 1)
One or more file types of Assets. An Asset Type must be specified before specifying a file type. Asset types are as follows- 'media', 'text', 'subtitle", "image".
MatrixParam['id']: (string)
Filtering by multiple Ids.Example- /api/assets;id=1234;id=2345;id=3456.
MatrixParam['status']: (one of ARCHIVED, DELETED, PUBLISHED, PURGED)
Status of Assets
MatrixParam['creationContext']: (one of ingest, proxy, copy, transcode, new, transform)
The creation context of Assets.
MatrixParam['referenceName']: (string)
MatrixParam['managed']: (string)
Whether the Assets are managed or not
MatrixParam['folderResourceId']: (integer - minimum: 0)
ID of the folder resource
MatrixParam['originalFileName']: (string)
The original filename
MatrixParam['technicalType']: (one of Media, Image)
Different criteria can be applied to Assets depending on which technical type has been chosen.
MatrixParam['format']: (string)
Only applies to Media
MatrixParam['streamCount']: (integer)
Only applies to Media
MatrixParam['audioStreamCount']: (integer)
Only applies to Media
MatrixParam['videoStreamCount']: (string)
Only applies to Media
MatrixParam['internalMetadata']: (string)
Only applies to Media
MatrixParam['bitRate']: (integer)
Only applies to Media
MatrixParam['bitRateUnits']: (string - default: bit/s)
Only applies to Media
MatrixParam['fileSize']: (integer)
Only applies to Media
MatrixParam['fileSizeUnits']: (string - default: B)
Only applies to Media
MatrixParam['duration']: (integer)
Only applies to Media
MatrixParam['durationUnits']: (string - default: µs)
Only applies to Media
MatrixParam['keyframeDescription']: (string)
Search for a specific keyframe description. Only applies to Media.
MatrixParam['videoCodec']: (string)
Only applies to Media
MatrixParam['frameRate']: (string)
Only applies to Media
MatrixParam['pixelAspectRatio']: (string)
Only applies to Media
MatrixParam['frameWidth']: (integer)
Only applies to Media
MatrixParam['frameHeight']: (integer)
Only applies to Media
MatrixParam['interlaceFormat']: (string)
Only applies to Media
MatrixParam['pixelFormat']: (string)
Only applies to Media
MatrixParam['standard']: (string)
Only applies to Media
MatrixParam['videoLanguage']: (string)
Only applies to Media
MatrixParam['videoBitRate']: (integer)
Only applies to Media
MatrixParam['videoBitRateUnits']: (string - default: bit/s)
Only applies to Media
MatrixParam['audioCodec']: (string)
Only applies to Media
MatrixParam['sampleRate']: (string)
Only applies to Media
MatrixParam['channels']: (integer)
Only applies to Media
MatrixParam['bitsPerSample']: (integer)
Only applies to Media
MatrixParam['audioLanguage']: (string)
Only applies to Media
MatrixParam['audioBitRate']: (integer)
Only applies to Media
MatrixParam['audioBitRateUnits']: (string - default: bit/s)
Only applies to Media
MatrixParam['imageFormat']: (string)
Only applies to Image
MatrixParam['width']: (integer)
Only applies to Image
MatrixParam['height']: (integer)
Only applies to Image
MatrixParam['widthResolution']: (string)
Only applies to Image
MatrixParam['heightResolution']: (string)
Only applies to Image
MatrixParam['colorMode']: (string)
Only applies to Image
MatrixParam['bitsPerPixel']: (integer)
Only applies to Image
MatrixParam['exactNameMatch']: (string)
Pass it true if you want to search asset with exact name
MatrixParam['externalId']: (string)
Search for an object via its endpoint (e.g. assets, workflows) and specify the external ID key and value, e.g. For example /api/assets;externalId=key:value
MatrixParam['signedURL']: (string)
Returns a link to an asset stored in s3. This link enables you to download a file stored in s3 without needing to log in.
MatrixParam['skipCount']: (boolean)
This parameter skips the count query execution when fetching a record.
MatrixParam['publishedFrom']: (boolean)
This parameter enables users to search assets published from a certain date.
MatrixParam['publishedTo']: (boolean)
This parameter enables users to search assets published up to a certain date.

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

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

HTTP status code 400

Invalid input.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Create new placeholder asset.

Query Parameters

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

Body

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

Schema:

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

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

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

Body

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

Schema:

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

HTTP status code 400

Invalid input.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/assets/{assetId} get put

Perform operations on a specific Asset

get

Returns the Asset object details (account, workspace, owner, title etc.), asset file information and technical information (media or image contexts). While it is not possible to retrieve the full storage location of the Asset via API calls, you can use this endpoint to retrieve the Asset file's originalFileName and its currentLocation (for example, the asset location file path on Azure in the response - /ooflexdev.blob.core.windows.net/.../e9f3859c-1821-44a7-a3b5-2c4086f6410c.jpg). You can also list multiple assets by entering a list of Asset ids separated by a semicolon e.g /api/assets;id=1234;id=2345;id=3456

put

Updates asset details (only editable properties). This endpoint also comes with an option set of schema which enables users to update the details of an existing asset.

URI Parameters

assetId: required (integer)
Asset ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.
MatrixParam['includeMetadata']: (boolean)
Include metadata in the response

HTTP status code 200

Request has been processed successfully.

Body

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

Example:

{
    "id": 134633,
    "uuid": "7e911477-0bad-4620-9f86-29573091dd34",
    "name": "HSS-working.jpg",
    "displayName": "HSS-working.jpg",
    "size": 143453,
    "objectType": {
        "id": 3,
        "name": "image-asset",
        "href": "http://masteraccount.local.nativ.tv:30044/api/objectTypes/3",
        "displayName": "Image Asset",
        "pluralName": "Image Assets",
        "userDefined": false,
        "attachmentsSupported": true,
        "commentsSupported": true,
        "objectDataSupported": false,
        "contentMetadataSupported": true,
        "metadataSupported": true
    },
    "externalIds": [],
    "isGroup": false,
    "href": "http://masteraccount.local.nativ.tv:30044/api/assets/134633",
    "owner": {
        "id": 5,
        "name": "masteruser",
        "displayName": "masteruser masteruser",
        "href": "http://masteraccount.local.nativ.tv:30044/api/users/5",
        "email": "rdoshi1@asite.com",
        "accountId": 4
    },
    "assetOrigin": "Ingest",
    "approved": false,
    "fileInformation": {
        "originalFileName": "HSS-working.jpg",
        "currentLocation": "azbs://ooflexdev.blob.core.windows.net/flex-azure-demo/ashok/one/e9f3859c-1821-44a7-a3b5-2c4086f6410c.jpg",
        "currentFileName": "e9f3859c-1821-44a7-a3b5-2c4086f6410c.jpg",
        "mimeType": "image/jpeg",
        "ingestPath": "file://c:/dev/temp/master/workflow/59f0d160-7e00-4835-acf9-d5f1e7b1346c.jpg",
        "resource": {
            "id": 129502,
            "uuid": "b2ae7cf6-c588-420e-9dcf-26c1933ac5eb",
            "name": "azure folder itv",
            "displayName": "azure folder itv",
            "objectType": {
                "id": 15,
                "name": "resource",
                "href": "http://masteraccount.local.nativ.tv:30044/api/objectTypes/15",
                "displayName": "Resource",
                "pluralName": "Resources",
                "userDefined": false,
                "attachmentsSupported": false,
                "commentsSupported": false,
                "objectDataSupported": false,
                "contentMetadataSupported": false,
                "metadataSupported": false
            },
            "href": "http://masteraccount.local.nativ.tv:30044/api/resources/129502",
            "enabled": true,
            "owner": "itvadmin",
            "accountId": 119182,
            "created": "01 May 2018 15:25:02 +0530",
            "lastModified": "30 May 2018 12:34:44 +0530"
        }
    },
    "assetContext": {
        "type": "ImageContext",
        "fileSize": 0,
        "imageFormat": "JPEG",
        "width": 897,
        "height": 504,
        "widthResolution": -1,
        "heightResolution": -1,
        "bitsPerPixel": 24,
        "compressionScheme": "JPEG",
        "compressionLevel": "Unknown",
        "colorMode": "RGB"
    },
    "exists": true,
    "deleted": false,
    "purged": false,
    "archived": false,
    "created": "11 Jul 2018 16:13:52 +0530",
    "published": false,
    "live": false,
    "locked": false,
    "lastModified": "11 Jul 2018 16:13:52 +0530",
    "account": {
        "id": 4,
        "name": "Master Account",
        "displayName": "Master Account",
        "objectType": {
            "id": 24,
            "name": "master-account",
            "href": "http://masteraccount.local.nativ.tv:30044/api/objectTypes/24",
            "displayName": "Master Account",
            "pluralName": "Master Accounts",
            "userDefined": false,
            "attachmentsSupported": false,
            "commentsSupported": false,
            "objectDataSupported": false,
            "contentMetadataSupported": false,
            "metadataSupported": false
        },
        "enabled": true,
        "owner": "masteruser masteruser",
        "ownerId": 5,
        "accountId": 4,
        "created": "10 Jun 2015 10:26:05 +0530",
        "lastModified": "12 Dec 2017 17:14:58 +0530",
        "workspace": {
            "id": 3,
            "name": "Master Account",
            "displayName": "Master Account",
            "accountId": 4,
            "href": "http://masteraccount.local.nativ.tv:30044/api/workspaces/3"
        }
    },
    "workspace": {
        "id": 3,
        "name": "Master Account",
        "displayName": "Master Account",
        "objectType": {
            "id": 30,
            "name": "account-workspace",
            "href": "http://masteraccount.local.nativ.tv:30044/api/objectTypes/30",
            "displayName": "Account Workspace",
            "pluralName": "Account Workspaces",
            "userDefined": false,
            "attachmentsSupported": false,
            "commentsSupported": false,
            "objectDataSupported": false,
            "contentMetadataSupported": false,
            "metadataSupported": false
        },
        "enabled": true,
        "owner": "masteruser masteruser",
        "ownerId": 5,
        "accountId": 4,
        "created": "10 Jun 2015 10:26:05 +0530",
        "lastModified": "03 Oct 2017 11:44:30 +0530"
    }
}

HTTP status code 201

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

HTTP status code 400

Invalid input.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Updates asset details (only editable properties). This endpoint also comes with an option set of schema which enables users to update the details of an existing asset.

URI Parameters

assetId: required (integer)
Asset ID

Query Parameters

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

Body

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

Schema:

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

HTTP status code 200

Returns an updated Asset.

Body

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

HTTP status code 201

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

HTTP status code 400

Invalid input.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/assets/{assetId}/accounts 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.

/assets/{assetId}/annotations get post

get

Returns a list of existing annotations made against a timeline.

post

Enables a user to post a single annotation on a timeline. When specifying an originatorContext you can enter MioAssetReview, QCReport, or leave the field empty.

Returns a list of existing annotations made against a timeline.

URI Parameters

assetId: required (integer)
Asset ID

Query Parameters

callback: (string)
Specifies the call back function for JSONP response.
MatrixParam['type']: (string)
Filter all annotations and return just the annotations of the specified type - comment, image, or metadata. For example - ~/assets/{assetId}/annotations;type=comment - filter all annotations and return just the annotations of type MioTimelineComment; ~/assets/{assetId}/annotations;type=image - filter all annotations and return just the annotations of type MioImageAnnotation; ~/assets/{assetId}/annotations;type=metadata - filter all annotations and return just the annotations of type MetadataAnnotation.
MatrixParam['ownerIds']: (string)
Filter all annotations and return just the annotations that have the requested owner ids. For example - ~/assets/${assetId}/annotations;ownerIds=27790,27791,27793

HTTP status code 200

Request has been processed successfully.

Body

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

Example:

{
  "_comment": "This is a metadata annotation type search call for a media asset.",
  "_comment": "API call: ~/assets/<media-asset-id>/annotations;type=metadata. Method Type: GET.",
  "totalCount": 1,
  "limit": 100,
  "offset": 0,
  "annotations": [
    {
      "type": "MetadataAnnotation",
      "id": 142309,
      "creationDate": "28 Aug 2018 06:26:16 +0000",
      "owner": {
        "id": 10249,
        "uuid": "b0ffb54f-9a7b-498a-a493-c12b4f610f6f",
        "name": "achalshah",
        "displayName": "Achal B Shah",
        "href": "https://accountb.qa1.ooflex.net/api/users/10249",
        "email": "achalshah@asite.com",
        "accountId": 10329
      },
      "assetId": 168569,
      "originatorContext": "Timeline",
      "originatorCorrelationId": 4040,
      "subjectContext": "MioAsset",
      "subjectCorrelationId": 168569,
      "href": "https://accountb.qa1.ooflex.net/api/assets/168569/annotations/142309",
      "timestampIn": 3492540,
      "timestampOut": 5567605,
      "metadata": {
        "id": 24084085,
        "instance": {
          "new-text-2": "test1",
          "new-complex-3": {}
        },
        "definitionId": 374486,
        "metadataDefinition": {
          "id": 62548,
          "uuid": "20d2ccc8-961a-4b25-aeba-4d8594cba92a",
          "name": "Basic",
          "displayName": "Basic",
          "objectType": {
            "id": 12,
            "name": "metadata-definition",
            "href": "https://accountb.qa1.ooflex.net/api/objectTypes/12",
            "displayName": "Metadata Definition",
            "pluralName": "Metadata Definitions",
            "userDefined": false,
            "attachmentsSupported": true,
            "commentsSupported": true,
            "objectDataSupported": false,
            "contentMetadataSupported": false,
            "metadataSupported": false
          },
          "href": "https://accountb.qa1.ooflex.net/api/metadataDefinitions/62548",
          "enabled": true,
          "owner": "Achal B Shah",
          "ownerId": 10249,
          "accountId": 10329,
          "created": "15 Mar 2018 08:13:06 +0000",
          "lastModified": "26 Jul 2018 10:10:51 +0000"
        }
      },
      "canDelete": false
    }
  ]
}
{
    "_comment": "This is an image annotation type search call for a media asset.",
    "_comment": "API call: ~/assets/<media-asset-id>/annotations;type=image. Method Type: GET.",
  "totalCount": 2,
  "limit": 100,
  "offset": 0,
  "annotations": [
    {
      "type": "ImageAnnotation",
      "id": 142208,
      "creationDate": "28 Aug 2018 06:09:25 +0000",
      "owner": {
        "id": 10249,
        "uuid": "b0ffb54f-9a7b-498a-a493-c12b4f610f6f",
        "name": "achalshah",
        "displayName": "Achal B Shah",
        "href": "https://accountb.qa1.ooflex.net/api/users/10249",
        "email": "achalshah@asite.com",
        "accountId": 10329
      },
      "assetId": 168570,
      "originatorContext": null,
      "originatorCorrelationId": null,
      "subjectContext": "MioAsset",
      "subjectCorrelationId": 168570,
      "href": "https://accountb.qa1.ooflex.net/api/assets/168570/annotations/142208",
      "timestampIn": null,
      "timestampOut": null,
      "canDelete": false,
      "comment": "Image Annotation comment",
      "annotations": [
        {
          "type": "rectangle",
          "color": null,
          "x": 22.120831298828126,
          "y": 25.697216796875,
          "width": 23,
          "height": 25.6
        },
        {
          "type": "rectangle",
          "color": null,
          "x": 57.920831298828126,
          "y": 25.497216796875,
          "width": 24.8,
          "height": 20.8
        }
      ]
    },
    {
      "type": "ImageAnnotation",
      "id": 142814,
      "creationDate": "30 Aug 2018 12:40:45 +0000",
      "owner": {
        "id": 10249,
        "uuid": "b0ffb54f-9a7b-498a-a493-c12b4f610f6f",
        "name": "achalshah",
        "displayName": "Achal B Shah",
        "href": "https://accountb.qa1.ooflex.net/api/users/10249",
        "email": "achalshah@asite.com",
        "accountId": 10329
      },
      "assetId": 168570,
      "originatorContext": null,
      "originatorCorrelationId": null,
      "subjectContext": "MioAsset",
      "subjectCorrelationId": 168570,
      "href": "https://accountb.qa1.ooflex.net/api/assets/168570/annotations/142814",
      "timestampIn": null,
      "timestampOut": null,
      "canDelete": false,
      "comment": "test2\n",
      "annotations": [
        {
          "type": "rectangle",
          "color": null,
          "x": 57.800689697265625,
          "y": 57.599999999999994,
          "width": 39.2,
          "height": 34
        },
        {
          "type": "rectangle",
          "color": null,
          "x": 42.46041564941406,
          "y": 13.148611068725586,
          "width": 53.5,
          "height": 10.4
        },
        {
          "type": "rectangle",
          "color": null,
          "x": 13.160415649414062,
          "y": 18.848611068725585,
          "width": 27.6,
          "height": 15.4
        },
        {
          "type": "rectangle",
          "color": null,
          "x": 7.560415649414062,
          "y": 60.24861106872559,
          "width": 14.2,
          "height": 22.400000000000002
        },
        {
          "type": "rectangle",
          "color": null,
          "x": 62.00068969726562,
          "y": 26.8,
          "width": 19,
          "height": 19.2
        },
        {
          "type": "rectangle",
          "color": null,
          "x": 26.000689697265628,
          "y": 39,
          "width": 18.6,
          "height": 17.8
        }
      ]
    }
  ]
}
{
  "_comment": "This is a comment annotation type search call for a media asset.",
  "_comment": "API call: ~/assets/<media-asset-id>/annotations;type=comment. Method Type: GET.",
  "totalCount": 4,
  "limit": 100,
  "offset": 0,
  "annotations": [
    {
      "type": "TimelineComment",
      "id": 142414,
      "creationDate": "28 Aug 2018 10:15:26 +0000",
      "owner": {
        "id": 10249,
        "uuid": "b0ffb54f-9a7b-498a-a493-c12b4f610f6f",
        "name": "achalshah",
        "displayName": "Achal B Shah",
        "href": "https://accountb.qa1.ooflex.net/api/users/10249",
        "email": "achalshah@asite.com",
        "accountId": 10329
      },
      "assetId": 168569,
      "originatorContext": null,
      "originatorCorrelationId": null,
      "subjectContext": "MioAsset",
      "subjectCorrelationId": 168569,
      "href": "https://accountb.qa1.ooflex.net/api/assets/168569/annotations/142414",
      "timestampIn": 0,
      "timestampOut": 0,
      "comment": "MAM1",
      "canDelete": false
    },
    {
      "type": "TimelineComment",
      "id": 142213,
      "creationDate": "28 Aug 2018 06:39:51 +0000",
      "owner": {
        "id": 159784,
        "uuid": "0523e697-aecc-4c6b-a476-ca867532e048",
        "name": "jignadabhi",
        "displayName": "Jigna Dabhi",
        "href": "https://accountb.qa1.ooflex.net/api/users/159784",
        "email": "jdabhi@asite.com",
        "accountId": 10329
      },
      "assetId": 168569,
      "originatorContext": null,
      "originatorCorrelationId": null,
      "subjectContext": "MioAsset",
      "subjectCorrelationId": 168569,
      "href": "https://accountb.qa1.ooflex.net/api/assets/168569/annotations/142213",
      "timestampIn": 0,
      "timestampOut": 0,
      "comment": "JD",
      "canDelete": true
    },
    {
      "type": "TimelineComment",
      "id": 142210,
      "creationDate": "28 Aug 2018 06:25:33 +0000",
      "owner": {
        "id": 10249,
        "uuid": "b0ffb54f-9a7b-498a-a493-c12b4f610f6f",
        "name": "achalshah",
        "displayName": "Achal B Shah",
        "href": "https://accountb.qa1.ooflex.net/api/users/10249",
        "email": "achalshah@asite.com",
        "accountId": 10329
      },
      "assetId": 168569,
      "originatorContext": null,
      "originatorCorrelationId": null,
      "subjectContext": "MioAsset",
      "subjectCorrelationId": 168569,
      "href": "https://accountb.qa1.ooflex.net/api/assets/168569/annotations/142210",
      "timestampIn": 304,
      "timestampOut": 304,
      "comment": "ashish1",
      "canDelete": false
    },
    {
      "type": "TimelineComment",
      "id": 142211,
      "creationDate": "28 Aug 2018 06:25:52 +0000",
      "owner": {
        "id": 10249,
        "uuid": "b0ffb54f-9a7b-498a-a493-c12b4f610f6f",
        "name": "achalshah",
        "displayName": "Achal B Shah",
        "href": "https://accountb.qa1.ooflex.net/api/users/10249",
        "email": "achalshah@asite.com",
        "accountId": 10329
      },
      "assetId": 168569,
      "originatorContext": null,
      "originatorCorrelationId": null,
      "subjectContext": "MioAsset",
      "subjectCorrelationId": 168569,
      "href": "https://accountb.qa1.ooflex.net/api/assets/168569/annotations/142211",
      "timestampIn": 3492540,
      "timestampOut": 5567605,
      "comment": "ashish2",
      "canDelete": false
    }
  ]
}
{
  "_comment": "This is an annotation search call for media assets with the requested owner ids.",
  "_comment": "API call: ~/assets/<media-asset-id>/annotations;ownerIds=10204,10205. Method Type: GET.",
  "totalCount": 2,
  "limit": 100,
  "offset": 0,
  "annotations": [
    {
      "type": "MetadataAnnotation",
      "id": 103230,
      "creationDate": "06 Sep 2018 16:17:28 +0530",
      "owner": {
        "id": 10204,
        "uuid": "7391cc04-1066-4a22-ae9a-a0c1bdd133d9",
        "name": "hbzoomin",
        "displayName": "Hardik bhow",
        "href": "http://zoomin.local.nativ.tv:30044/api/users/10204",
        "email": "ashish@gmail.com",
        "accountId": 10202
      },
      "assetId": 14750,
      "originatorContext": "Timeline",
      "originatorCorrelationId": 207,
      "subjectContext": "MioAsset",
      "subjectCorrelationId": 14750,
      "href": "http://zoomin.local.nativ.tv:30044/api/assets/14750/annotations/103230",
      "timestampIn": 223456,
      "timestampOut": 134567,
      "metadata": {
        "id": 103732,
        "instance": {
          "name1": "rrrr",
          "name2": "jj",
          "complex1": {
            "complex2": {
              "number4": 13
            }
          }
        },
        "definitionId": 105744,
        "metadataDefinition": {
          "id": 14748,
          "uuid": "101d1bf3-c0ca-46ee-8cf0-ee1b0ea1d9e8",
          "name": "Test1",
          "displayName": "Test1",
          "objectType": {
            "id": 12,
            "name": "metadata-definition",
            "href": "http://zoomin.local.nativ.tv:30044/api/objectTypes/12",
            "displayName": "Metadata Definition",
            "pluralName": "Metadata Definitions",
            "userDefined": false,
            "attachmentsSupported": true,
            "commentsSupported": true,
            "objectDataSupported": false,
            "contentMetadataSupported": false,
            "metadataSupported": false
          },
          "href": "http://zoomin.local.nativ.tv:30044/api/metadataDefinitions/14748",
          "enabled": true,
          "owner": "Hardik bhow",
          "ownerId": 10204,
          "accountId": 10202,
          "created": "04 Sep 2018 12:39:32 +0530",
          "lastModified": "04 Sep 2018 12:58:32 +0530"
        }
      },
      "canDelete": false
    },
    {
      "type": "MetadataAnnotation",
      "id": 103231,
      "creationDate": "06 Sep 2018 16:43:55 +0530",
      "owner": {
        "id": 10205,
        "uuid": "7391cc04-1066-4a22-ae9a-a0c1bdd133d9",
        "name": "hbzoomin",
        "displayName": "Hardik bhow",
        "href": "http://zoomin.local.nativ.tv:30044/api/users/10204",
        "email": "ashish@gmail.com",
        "accountId": 10202
      },
      "assetId": 14750,
      "originatorContext": "Timeline",
      "originatorCorrelationId": 207,
      "subjectContext": "MioAsset",
      "subjectCorrelationId": 14750,
      "href": "http://zoomin.local.nativ.tv:30044/api/assets/14750/annotations/103231",
      "timestampIn": 223456,
      "timestampOut": 134567,
      "metadata": {
        "id": 103739,
        "instance": {
          "name1": "Dalet",
          "complex1": {
            "complex2": {
              "number4": 12
            }
          }
        },
        "definitionId": 105744,
        "metadataDefinition": {
          "id": 14748,
          "uuid": "101d1bf3-c0ca-46ee-8cf0-ee1b0ea1d9e8",
          "name": "Test1",
          "displayName": "Test1",
          "objectType": {
            "id": 12,
            "name": "metadata-definition",
            "href": "http://zoomin.local.nativ.tv:30044/api/objectTypes/12",
            "displayName": "Metadata Definition",
            "pluralName": "Metadata Definitions",
            "userDefined": false,
            "attachmentsSupported": true,
            "commentsSupported": true,
            "objectDataSupported": false,
            "contentMetadataSupported": false,
            "metadataSupported": false
          },
          "href": "http://zoomin.local.nativ.tv:30044/api/metadataDefinitions/14748",
          "enabled": true,
          "owner": "Hardik bhow",
          "ownerId": 10204,
          "accountId": 10202,
          "created": "04 Sep 2018 12:39:32 +0530",
          "lastModified": "04 Sep 2018 12:58:32 +0530"
        }
      },
      "canDelete": false
    }
  ]
}

HTTP status code 201

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

HTTP status code 400

Invalid input.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Enables a user to post a single annotation on a timeline. When specifying an originatorContext you can enter MioAssetReview, QCReport, or leave the field empty.

URI Parameters

assetId: required (integer)
Asset ID

Query Parameters

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

Body

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

Schema:

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

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

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

HTTP status code 400

Invalid input.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

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

Performs operations on a specific Annotation.

put

Updates an existing comment (annotation).

delete

Deletes an existing annotation.

Updates an existing comment (annotation).

URI Parameters

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

Query Parameters

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

Body

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

Schema:

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

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

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

HTTP status code 400

Invalid input.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/assets/{assetId}/annotations/bulk post

post

Enables a user to post one or more annotations on a timeline in MAM. When you post multiple annotations simultaneously, all annotations must be placed within a single array. Please also take note, that when you specify an originatorContext you can enter MioAssetReview, QCReport, or leave the field empty.

URI Parameters

assetId: required (integer)
Asset ID

Query Parameters

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

Body

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

Schema:

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

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

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

HTTP status code 400

Invalid input.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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}/reviews get

get

Returns a list of reviews.

/assets/{assetId}/reviews/{reviewId} get delete

get

Returns the details for a specific review session.

delete

Deletes a specific review session.

/assets/{assetId}/reviews/{reviewId}/actions get post

get

Returns the list of actions available to a user in a specific review session. FlexREVIEW now enables exclusive reviews - when such a session is taken by a user, it cannot be assigned to another user unless it is released. If the review session specified in the request is exclusive AND a user has taken the review session, the response will include an exclusiveReviewer section. This section will NOT be included in the API response if the review session is released (ended or not taken). The possible actions returned in the response, depending on the type of the review session and the current user's permissions, are DOWNLOADED, WATCHED, APPROVE, TAKE, and RELEASE.

post

Enables a user to take action on a review session they are assigned to. The possible actions are DOWNLOADED, WATCHED, and APPROVE. In addition, FlexREVIEW now enables exclusive reviews (when an exclusive review session is taken by a user, it cannot be assigned to another user unless it is released). A review session can only be defined as exclusive or not during its creation. If the review session is exclusive and the current user has sufficient user permissions, two more possible actions are also TAKE (if the specified review session is exclusive and is not taken, this action enables the current user to take the review session exclusively) and RELEASE (if the specified review session is taken by the current user, this action unassigns the current user from the exclusive review session and releases that session as available for taking by another user or by the same one again). Please note that all action values must be capitalized in the POST request. For example, a request for endpoint /api/assets/10105/reviews/102313/actions with { "action":"TAKE" } in the request body will assign the exclusive review session with id 102313 to the current user. The TAKE and RELEASE actions are only available if the specified review session was created as exclusive AND your user permissions are sufficient (Permissions > Access > Roles > Permissions from the UI). You can force the release of a review session both via the UI and also via the API - if you have the correct permissions for that, there is no need for the review session to have been taken in order to be released. IMPORTANT - if a user is disabled in the system, all exclusive review sessions taken by that user will be released. If the specified review session is exclusive and is taken by the current user, when the current user finishes the review the review will get released. If an exclusive review session is approved, this will automatically release the session if it has been blocked.

URI Parameters

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

Query Parameters

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

HTTP status code 200

Request has been processed successfully.

Body

Type: application/json

Example:

[
    {
        "action": "WATCHED"
    },
    {
        "action": "DOWNLOADED"
    },
    {
        "action": "RELEASE"
    }
]

HTTP status code 201

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

HTTP status code 400

Invalid input.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

URI Parameters

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

Query Parameters

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

Body

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

Schema:

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

HTTP status code 200

Request has been processed successfully.

Body

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

Schema:

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

HTTP status code 201

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

HTTP status code 400

Invalid input.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/assets/{assetId}/reviews/{reviewId}/comments get

get

Retrieves a list of comments made during a specific review session.

/assets/{assetId}/reviews/{reviewId}/statuses get

get

Retrieves a list of reviewers and the status for each reviewer in a specific review session.

/assets/{assetId}/reviews/{reviewId}/statuses/{reviewer} get put

get

Retrieves the status information for a specific reviewer in review session.

put

Enables a user to change the status information for a specific reviewer in review session.

URI Parameters

assetId: required (integer)
Asset ID
reviewId: required (string)
reviewer: required (string)

Query Parameters

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

Body

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

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "reviewer": {
      "type": "integer",
      "required": true
    },
    "finished": {
      "type": "boolean",
      "required": false
    },
    "customStatuses": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "customStatusId": {
            "type": "integer",
            "required": true
          },
          "instance": {
            "type": "object",
            "required": false
          }
        }
      },
      "required": false
    }
  }
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

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

HTTP status code 400

Invalid input.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/assets/{assetId}/reviews/{reviewId}/annotations post

post

/assets/{assetId}/reviews/{reviewId}/annotations/{annotationId} put

put

Enables a user to post a comment against a specific range of frames within an asset, in a review session.

URI Parameters

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

Query Parameters

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

Body

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

Schema:

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

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

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

HTTP status code 400

Invalid input.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/assets/{assetId}/metadata get put

get

Returns the metadata associated with the asset, including a href link to the metadata definition. If you search using a specific metadata field and value, you must specify the metadata definition first. For example - /api/assets;metadataDefinitionId=123441;metadata=processing-profile-uri-id:II316007618_profile_no_drm_id;limit=1

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)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
callback: (string)
Specifies the call back function for JSONP response.
MatrixParam['definitionId']: (integer - minimum: 0)
The workflow definition ID
MatrixParam['definitionVersion']: (integer - minimum: 0)
The workflow defintion version. Specifying definition version requires that the workflow definition ID is also specified.
MatrixParam['status']: (one of Running, Ended, Failed, Cancelled, Cancelling, Completed)
The workflow status
MatrixParam['skipCount']: (boolean)
This parameter skips the count query execution when fetching a record.
MatrixParam['startDateFrom']: (date)
Supported date formats are:
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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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)
This parameter enables users to sort assets by duration, file size, format, source time stamp in, and source timestamp out. For example- /api/assets;sortBy=Duration
callback: (string)
Specifies the call back function for JSONP response.
MatrixParam['definitionId']: (integer - minimum: 0)
The player definition ID
MatrixParam['assetTitle']: (string)
The asset title
MatrixParam['skipCount']: (boolean)
This parameter skips the count query execution when fetching a record.

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

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

HTTP status code 400

Invalid input.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/assets/{assetId}/actions get post

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

get

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

post

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

URI Parameters

assetId: required (integer)
Asset ID

Body

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

Schema:

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

HTTP status code 200

Body

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

Schema:

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

/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)
The Asset Membership ID.

Query Parameters

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

Body

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

Schema:

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

HTTP status code 200

Returns the updated membership.

Body

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

HTTP status code 201

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

HTTP status code 400

Invalid input.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/assets/{assetId}/members get post delete

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

This endpoint enables you to add an existing asset to an asset group in MAM by specifying the asset ID. This endpoint also enables you to specify the index for the asset you are adding. You can use the index field to specify the order in which a new member will appear in a group. You can specify the order of an asset by entering a number in the index field. For example - you might have 10 members already in the group, but you may want your new member to be listed in 1st place. So in order for your new member to appear in 1st place, you would enter 1 in the index field.

delete

Deletes an existing membership.

URI Parameters

assetId: required (integer)
Asset ID

Body

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

Schema:

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

HTTP status code 201

Body

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

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "id": {
      "type": "integer",
      "required": true
    },
    "membershipName": {
      "type": "string",
      "required": true
    },
    "href": {
      "type": "string",
      "required": true
    },
     "asset": {
      "type": "array",
      "required": true
    },
     "id": {
      "type": "integer",
      "required": true
    },
     "name": {
      "type": "string",
      "required": true
    },
     "displayName": {
      "type": "string",
      "required": true
    },
     "type": {
      "type": "string",
      "required": true
    },
     "href": {
      "type": "string",
      "required": true
    },
     "assetOrigin": {
      "type": "string",
      "required": true
    },
     "accountId": {
      "type": "integer",
      "required": true
     },
     "workspaceId": {
      "type": "integer",
      "required": true
     },
     "workspace": {
      "type": "array",
      "required": true
     },
     "id": {
      "type": "integer",
      "required": true
    },
     "name": {
      "type": "string",
      "required": true
    },
     "displayName": {
      "type": "string",
      "required": true
    },
     "accountId": {
      "type": "integer",
      "required": true
    },
     "href": {
      "type": "string",
      "required": true
    },
     "index": {
      "type": "integer",
      "required": true
    }
  }
}

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

put

This endpoint updates the order of an existing member within an asset group in MAM. For example - you might have 10 members in a group and you might want to change the order of one of the existing members. You can use the index field to change the order of a specific member by entering a number. If you wanted a member of the group to be listed in 5th place, you would enter 5 in the index field.

URI Parameters

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

Query Parameters

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

Body

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

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "index": {
      "type": "integer",
      "required": true
    }
  }
}

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

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

Body

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

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "id": {
      "type": "integer",
      "required": true
    },
    "href": {
      "type": "string",
      "required": true
    },
     "asset": {
      "type": "array",
      "required": true
    },
     "id": {
      "type": "integer",
      "required": true
    },
     "name": {
      "type": "string",
      "required": true
    },
     "displayName": {
      "type": "string",
      "required": true
    },
     "type": {
      "type": "string",
      "required": true
    },
     "href": {
      "type": "string",
      "required": true
    },
     "assetOrigin": {
      "type": "string",
      "required": true
    },
     "accountId": {
      "type": "integer",
      "required": true
     },
     "workspaceId": {
      "type": "integer",
      "required": true
     },
     "workspace": {
      "type": "array",
      "required": true
     },
     "id": {
      "type": "integer",
      "required": true
    },
     "name": {
      "type": "string",
      "required": true
    },
     "displayName": {
      "type": "string",
      "required": true
    },
     "accountId": {
      "type": "integer",
      "required": true
    },
     "href": {
      "type": "string",
      "required": true
    },
     "index": {
      "type": "integer",
      "required": true
    }
  }
}

HTTP status code 400

Invalid input.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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

/assets/{assetId}/subtitles get

get

Returns all of the subtitle assets that are linked to a specific media asset.

/assets/{assetId}/hierarchy get

get

Returns a list of object hierarchies for the specified media asset. You can use two optional matrix parameters in the request for this endpoint - context and level. For example context=upward is used to request the upward hierarchy for the asset, and level specifies the number of levels (parents) in the object hierarchy (up to 6). The response should have the following fields - id, name, displayName, objectType, and a list of parent group assets. Example - /api/assets/31315/hierarchy;context=upward;level=2

URI Parameters

assetId: required (integer)
Asset ID

Query Parameters

MatrixParam['context']: (string)
The defaut setting context=upward is used to get the list of hierarchical parents for the specified asset id.
MatrixParam['level']: (integer)
Set the value of the level parameter to an integer between 1 and 6 to get the parent hierarchy up to the respective level. For example, /api/assets/31315/hierarchy;context=upward;level=4 will return 4 levels up of parent group assets for an asset with id 31315. This parameter is optional - if it is not included in the request, or if its specified value is higher than 6, the default value of 6 hierarchy levels up will be applied in the response.

HTTP status code 200

Body

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

Example:

{
    "id": 31315,
    "name": "child-media-asset",
    "displayName": "child-media-asset",
    "objectType": {
        "id": 1,
        "name": "media-asset",
        "href": "http://masteraccount.local.nativ.tv:30044/api/objectTypes/1",
        "displayName": "Media Asset",
        "pluralName": "Media Assets",
        "userDefined": false,
        "attachmentsSupported": true,
        "commentsSupported": true,
        "objectDataSupported": false,
        "contentMetadataSupported": true,
        "metadataSupported": true
    },
    "parentAssetGroups": [
        {
            "id": 31314,
            "name": "GC2",
            "displayName": "GC2",
            "objectType": {
                "id": 2,
                "name": "group-asset",
                "href": "http://masteraccount.local.nativ.tv:30044/api/objectTypes/2",
                "displayName": "Group Asset",
                "pluralName": "Group Assets",
                "userDefined": false,
                "attachmentsSupported": true,
                "commentsSupported": true,
                "objectDataSupported": false,
                "contentMetadataSupported": true,
                "metadataSupported": true
            },
            "parentAssetGroups": [
                {
                    "id": 31312,
                    "name": "G1",
                    "displayName": "G1",
                    "objectType": {
                        "id": 2,
                        "name": "group-asset",
                        "href": "http://masteraccount.local.nativ.tv:30044/api/objectTypes/2",
                        "displayName": "Group Asset",
                        "pluralName": "Group Assets",
                        "userDefined": false,
                        "attachmentsSupported": true,
                        "commentsSupported": true,
                        "objectDataSupported": false,
                        "contentMetadataSupported": true,
                        "metadataSupported": true
                    },
                    "href": "http://masteraccount.local.nativ.tv:30044/api/assets/31312"
                }
            ],
            "href": "http://masteraccount.local.nativ.tv:30044/api/assets/31314"
        },
        {
            "id": 31313,
            "name": "GC1",
            "displayName": "GC1",
            "objectType": {
                "id": 2,
                "name": "group-asset",
                "href": "http://masteraccount.local.nativ.tv:30044/api/objectTypes/2",
                "displayName": "Group Asset",
                "pluralName": "Group Assets",
                "userDefined": false,
                "attachmentsSupported": true,
                "commentsSupported": true,
                "objectDataSupported": false,
                "contentMetadataSupported": true,
                "metadataSupported": true
            },
            "parentAssetGroups": [
                {
                    "id": 31312,
                    "name": "G1",
                    "displayName": "G1",
                    "objectType": {
                        "id": 2,
                        "name": "group-asset",
                        "href": "http://masteraccount.local.nativ.tv:30044/api/objectTypes/2",
                        "displayName": "Group Asset",
                        "pluralName": "Group Assets",
                        "userDefined": false,
                        "attachmentsSupported": true,
                        "commentsSupported": true,
                        "objectDataSupported": false,
                        "contentMetadataSupported": true,
                        "metadataSupported": true
                    },
                    "href": "http://masteraccount.local.nativ.tv:30044/api/assets/31312"
                },
                {
                    "id": 33431,
                    "name": "G0",
                    "displayName": "G0",
                    "objectType": {
                        "id": 2,
                        "name": "group-asset",
                        "href": "http://masteraccount.local.nativ.tv:30044/api/objectTypes/2",
                        "displayName": "Group Asset",
                        "pluralName": "Group Assets",
                        "userDefined": false,
                        "attachmentsSupported": true,
                        "commentsSupported": true,
                        "objectDataSupported": false,
                        "contentMetadataSupported": true,
                        "metadataSupported": true
                    },
                    "href": "http://masteraccount.local.nativ.tv:30044/api/assets/33431"
                }
            ],
            "href": "http://masteraccount.local.nativ.tv:30044/api/assets/31313"
        }
    ],
    "href": "http://masteraccount.local.nativ.tv:30044/api/assets/31315"
}

Collections

This resource is used for viewing Collections.

/collections get post

get

Returns a list of Collections.

post

Creates a new Collection. Please note that you can now use the new fql property to save an FQL as a dynamic query. This is a new 'type' of collection that you can define by using an FQL query defined instead of a specific asset. The fql property is an optional string type that can contain up to 2000 characters. You can then use the GET method with type=dynamic matrix parameter to retrieve dynamic collections - for example, /api/collections;type=dynamic (see the GET method description for more information).

Query Parameters

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

Body

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

Schema:

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

HTTP status code 200

Request has been processed successfully.

HTTP status code 201

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

Body

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

Schema:

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

HTTP status code 400

Invalid input.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

/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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Evaluation

This resource is used for evaluating URLs for panel supported user defined objects.

/evaluation post

post

This endpoint is used to evaluate URLs for panel supported user defined objects.

Body

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

Schema:

{
  "type": "object",
  "required": true,
  "properties": {
    "url": {
      "type": "string",
      "required": true
    },
    "objectId": {
      "type": "string",
      "required": true
    },
    "context": {
      "type": "integer",
      "required": true
    }
  }
}

HTTP status code 200

Body

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

Schema:

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

Events

This resource is used for viewing Events

/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).

/events/{files} get

Enables a user to retrieve a file that is stored in the filestore. This is related to the "File" field type in the Metadata Designer. Files can be associated with the "File" field type, such as an image (thumbnail) or a JSON file.

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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 a 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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials presented when making a request are invalid.

HTTP status code 404

The requested resource has not been found.

HTTP status code 500

Server error.

Files

Performs operations on non-asset files that are stored in the filestore.

/files get

get

Retrieves a non-asset file that is stored in the filestore. This includes attachments such as JSON files and images. You must use a GET request to obtain the file path name for the file Example- /api/versions/406690/data, then you can use the file path name to download the file. Example - api/files/3f9de7f0-f9a7-4141-a58f-6eda0518a15f.png.

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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 400

Invalid input.

HTTP status code 401

The credentials 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 7.1.2

Accounts

get /accounts

Query Parameters

HTTP status code 200

HTTP status code 201

HTTP status code 400

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 400

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 400

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 400

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 400

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 400

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 400

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 400

HTTP status code 401

HTTP status code 404

HTTP status code 500

get /accounts/{accountId}/comments

URI Parameters

Query Parameters