Get last revisions of output files for given entity grouped by output type and file name.

Resource to allow a user to disable OTP by email.

DELETE /auth/email-otp

Responses

200

OTP by email disabled.
400

Invalid password. Wrong or expired token. Inactive user. Wrong 2FA.

DELETE /auth/email-otp

curl \
 --request DELETE 'http://api.example.com/auth/email-otp' \
 --header "Authorization: $API_KEY"

Resource to allow a user to login with SAML SSO.

POST /auth/saml/sso

Jwt authorization

Responses

302

Login successful, redirect to the home page.
400

Wrong parameter

POST /auth/saml/sso

curl \
 --request POST 'http://api.example.com/auth/saml/sso' \
 --header "Authorization: $API_KEY"

Resource to allow a user to login with SAML SSO.

GET /auth/saml/login

Jwt authorization

Responses

302

Redirect to the SAML IDP.
400

Wrong parameter.

GET /auth/saml/login

curl \
 --request GET 'http://api.example.com/auth/saml/login' \
 --header "Authorization: $API_KEY"

Retrieve all entities that are not shot, sequence, episode, or edit.

GET /data/assets

Jwt authorization

Adds project name and asset type name.

Responses

200

All assets

GET /data/assets

curl \
 --request GET 'http://api.example.com/data/assets' \
 --header "Authorization: $API_KEY"

Retrieve the casting of a given asset.

GET /data/assets/{asset_id}/casting

Jwt authorization

Path parameters

asset_id Required

Responses

200

Casting of given asset

GET /data/assets/{asset_id}/casting

curl \
 --request GET 'http://api.example.com/data/assets/a24a6ea4-ce75-4665-a070-57453082c25/casting' \
 --header "Authorization: $API_KEY"

Retrieve all asset instances instantiated inside given asset.

GET /data/assets/{asset_id}/asset-asset-instances

Jwt authorization

Path parameters

asset_id Required

Responses

200

All asset instances instantiated inside given asset

GET /data/assets/{asset_id}/asset-asset-instances

curl \
 --request GET 'http://api.example.com/data/assets/a24a6ea4-ce75-4665-a070-57453082c25/asset-asset-instances' \
 --header "Authorization: $API_KEY"

Retrieve all assets for given project and asset type.

GET /data/projects/{project_id}/asset-types/{asset_type_id}/assets

Jwt authorization

Path parameters

project_id Required
asset_type_id Required

Responses

200

All assets for given project and asset type

GET /data/projects/{project_id}/asset-types/{asset_type_id}/assets

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/asset-types/a24a6ea4-ce75-4665-a070-57453082c25/assets' \
 --header "Authorization: $API_KEY"

Create new asset with given parameters.

POST /data/projects/{project_id}/asset-types/{asset_type_id}/assets/new

Jwt authorization

Path parameters

project_id Required
asset_type_id Required

application/json

Body Required

name string Required
description string Required
data string Required
is_shared boolean Required
source_id string(uuid) Required

Responses

201

New asset resource created

POST /data/projects/{project_id}/asset-types/{asset_type_id}/assets/new

curl \
 --request POST 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/asset-types/a24a6ea4-ce75-4665-a070-57453082c25/assets/new' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"name":"Character Name","description":"Main character","data":"{}","is_shared":false,"source_id":"a24a6ea4-ce75-4665-a070-57453082c25"}'

Request examples

{
  "name": "Character Name",
  "description": "Main character",
  "data": "{}",
  "is_shared": false,
  "source_id": "a24a6ea4-ce75-4665-a070-57453082c25"
}

Retrieve all shared assets used in project.

GET /data/projects/{project_id}/assets/shared-used

Jwt authorization

Path parameters

project_id Required

Responses

200

All shared assets used in project

GET /data/projects/{project_id}/assets/shared-used

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/assets/shared-used' \
 --header "Authorization: $API_KEY"

Retrieve all tasks related to a given concept.

GET /data/concepts/{concept_id}/tasks

Jwt authorization

Path parameters

concept_id Required

Responses

200

All tasks related to given concept

GET /data/concepts/{concept_id}/tasks

curl \
 --request GET 'http://api.example.com/data/concepts/a24a6ea4-ce75-4665-a070-57453082c25/tasks' \
 --header "Authorization: $API_KEY"

Create a model with data given in the request body.

POST /data/project-status

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

POST /data/project-status

curl \
 --request POST 'http://api.example.com/data/project-status' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/project-status/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/project-status/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/project-status/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/task-status

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

GET /data/task-status

curl \
 --request GET 'http://api.example.com/data/task-status' \
 --header "Authorization: $API_KEY"

Create a model with data given in the request body.

POST /data/task-status

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

POST /data/task-status

curl \
 --request POST 'http://api.example.com/data/task-status' \
 --header "Authorization: $API_KEY"

Create a model with data given in the request body.

POST /data/organisations

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

POST /data/organisations

curl \
 --request POST 'http://api.example.com/data/organisations' \
 --header "Authorization: $API_KEY"

Retrieve a model corresponding at given ID and return it as a JSON object.

GET /data/organisations/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/organisations/{instance_id}

curl \
 --request GET 'http://api.example.com/data/organisations/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/file-status/

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

GET /data/file-status/

curl \
 --request GET 'http://api.example.com/data/file-status/' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/file-status/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/file-status/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/file-status/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve a software corresponding at given ID and return it as a

GET /data/softwares/{instance_id}

Jwt authorization

JSON object.

Path parameters

software_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/softwares/{instance_id}

curl \
 --request GET 'http://api.example.com/data/softwares/{instance_id}' \
 --header "Authorization: $API_KEY"

Create a model with data given in the request body.

POST /data/output-files

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

POST /data/output-files

curl \
 --request POST 'http://api.example.com/data/output-files' \
 --header "Authorization: $API_KEY"

Retrieve a model corresponding at given ID and return it as a JSON

GET /data/output-files/{instance_id}

Jwt authorization

object.

Path parameters

output_file_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/output-files/{instance_id}

curl \
 --request GET 'http://api.example.com/data/output-files/{instance_id}' \
 --header "Authorization: $API_KEY"

Create a model with data given in the request body.

POST /data/preview-files

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

POST /data/preview-files

curl \
 --request POST 'http://api.example.com/data/preview-files' \
 --header "Authorization: $API_KEY"

Retrieve a model corresponding at given ID and return it as a JSON object.

GET /data/comments/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/comments/{instance_id}

curl \
 --request GET 'http://api.example.com/data/comments/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/time-spents/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/time-spents/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/time-spents/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve a model corresponding at given ID and return it as a JSON object.

GET /data/day-offs/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/day-offs/{instance_id}

curl \
 --request GET 'http://api.example.com/data/day-offs/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/events/

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

GET /data/events/

curl \
 --request GET 'http://api.example.com/data/events/' \
 --header "Authorization: $API_KEY"

Retrieve a model corresponding at given ID and return it as a JSON object.

GET /data/events/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/events/{instance_id}

curl \
 --request GET 'http://api.example.com/data/events/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/notifications/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/notifications/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/notifications/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve a model corresponding at given ID and return it as a JSON object.

GET /data/search-filters/{instance_id}

Jwt authorization

GET /data/search-filters/{instance_id}

curl \
 --request GET 'http://api.example.com/data/search-filters/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Create a model with data given in the request body.

POST /data/schedule-items/

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

POST /data/schedule-items/

curl \
 --request POST 'http://api.example.com/data/schedule-items/' \
 --header "Authorization: $API_KEY"

Create a model with data given in the request body.

POST /data/preview-background-files

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

POST /data/preview-background-files

curl \
 --request POST 'http://api.example.com/data/preview-background-files' \
 --header "Authorization: $API_KEY"

Retrieve a model corresponding at given ID and return it as a JSON object.

GET /data/preview-background-files/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/preview-background-files/{instance_id}

curl \
 --request GET 'http://api.example.com/data/preview-background-files/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve a model corresponding at given ID and return it as a JSON object.

GET /data/studios/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/studios/{instance_id}

curl \
 --request GET 'http://api.example.com/data/studios/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/plugins/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/plugins/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/plugins/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all edits related to a given project.

GET /data/projects/{project_id}/edits

Jwt authorization

Path parameters

project_id Required

Responses

200

All edits related to given project

GET /data/projects/{project_id}/edits

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/edits' \
 --header "Authorization: $API_KEY"

Retrieve last events.

GET /data/events/last

Jwt authorization

Query parameters

after
before
only_files
limit
project_id

Responses

200

All login logs

GET /data/events/last

curl \
 --request GET 'http://api.example.com/data/events/last' \
 --header "Authorization: $API_KEY"

Retrieve all login logs.

GET /data/events/login-logs/last

Jwt authorization

GET /data/events/login-logs/last

curl \
 --request GET 'http://api.example.com/data/events/login-logs/last' \
 --header "Authorization: $API_KEY"

Export shots linked to a given project as csv.

GET /export/csv/projects/{project_id}/shots.csv

Jwt authorization

Path parameters

project_id Required

Responses

200

Shots exported as csv

GET /export/csv/projects/{project_id}/shots.csv

curl \
 --request GET 'http://api.example.com/export/csv/projects/a24a6ea4-ce75-4665-a070-57453082c25/shots.csv' \
 --header "Authorization: $API_KEY"

Generate a working file path from file tree template.

POST /data/tasks/{task_id}/working-file-path

Jwt authorization

Generate file path based on several parameters: task, software, mode, revision and separator. Revision can be computed automatically as next revision if not given.

Path parameters

task_id Required

Responses

200

Working file path generated
400

Malformed file tree

POST /data/tasks/{task_id}/working-file-path

curl \
 --request POST 'http://api.example.com/data/tasks/a24a6ea4-ce75-4665-a070-57453082c25/working-file-path' \
 --header "Authorization: $API_KEY"