Retrieve all entries for given model.

Allow a user to register himself to the service.

POST /auth/register

Responses

201

Registration successful
400

Invalid password or email

POST /auth/register

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

Resource to allow a user to disable OTP by email.

DELETE /auth/email-otp

Jwt authorization

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"

Retrieve all tasks related to given asset.

GET /data/assets/{asset_id}/tasks

Jwt authorization

Path parameters

asset_id Required

Responses

200

All tasks related to given asset

GET /data/assets/{asset_id}/tasks

curl \
 --request GET 'http://api.example.com/data/assets/a24a6ea4-ce75-4665-a070-57453082c25/tasks' \
 --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 asset types for given project.

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

Jwt authorization

Path parameters

project_id Required

Responses

200

All asset types for given project

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

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

Retrieve all shared assets used in project episode.

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

Jwt authorization

Path parameters

project_id Required
episode_id Required

Responses

200

All shared assets used in project episode

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

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

Retrieve all asset instances linked to scene.

GET /data/scenes/{scene_id}/asset-instances

Jwt authorization

Path parameters

scene_id Required

Responses

200

All asset instances linked to given scene

GET /data/scenes/{scene_id}/asset-instances

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

Return all attachment files related to given project.

GET /data/projects/{project_id}/attachment-files

Jwt authorization

Path parameters

project_id Required

Responses

200

All attachment files related to given project

GET /data/projects/{project_id}/attachment-files

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

Retrieve all concepts, adds project name and asset type name and all related tasks.

GET /data/concepts/with-tasks

Jwt authorization

Query parameters

project_id

Responses

200

All concepts

GET /data/concepts/with-tasks

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

Retrieve given concept.

GET /data/concepts/{concept_id}

Jwt authorization

Path parameters

concept_id Required

Responses

200

Given concept

GET /data/concepts/{concept_id}

curl \
 --request GET 'http://api.example.com/data/concepts/a24a6ea4-ce75-4665-a070-57453082c25' \
 --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"

GET /data/projects

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

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

Update a model with data given in the request body.

PUT /data/projects/{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/projects/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/projects/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/project-status/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/project-status/{instance_id}

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

Retrieve all entries for given model.

GET /data/entity-types

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/entity-types

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

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

GET /data/entity-types/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/entity-types/{instance_id}

curl \
 --request GET 'http://api.example.com/data/entity-types/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/entities/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/entities/{instance_id}

curl \
 --request GET 'http://api.example.com/data/entities/a24a6ea4-ce75-4665-a070-57453082c25' \
 --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"

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

GET /data/task-status/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/task-status/{instance_id}

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

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

DELETE /data/departments/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/departments/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/departments/a24a6ea4-ce75-4665-a070-57453082c25' \
 --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"

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

DELETE /data/organisations/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/organisations/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/organisations/a24a6ea4-ce75-4665-a070-57453082c25' \
 --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 all entries for given model.

GET /data/softwares

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

curl \
 --request GET 'http://api.example.com/data/softwares' \
 --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/preview-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-files/{instance_id}

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

Retrieve all entries for given model.

GET /data/comments

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

curl \
 --request GET 'http://api.example.com/data/comments' \
 --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"

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

DELETE /data/day-offs/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/day-offs/{instance_id}

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

Retrieve all entries for given model.

GET /data/custom-actions/

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/custom-actions/

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

Retrieve all entries for given model.

GET /data/status-automations/

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/status-automations/

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

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

GET /data/asset-instances/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/asset-instances/{instance_id}

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

Create a model with data given in the request body.

POST /data/playlists/

Jwt authorization

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

Responses

200

Model created
400

Error

POST /data/playlists/

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

Create a model with data given in the request body.

POST /data/notifications/

Jwt authorization

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

Responses

200

Model created
400

Error

POST /data/notifications/

curl \
 --request POST 'http://api.example.com/data/notifications/' \
 --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"

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

DELETE /data/notifications/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/notifications/{instance_id}

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

Update a model with data given in the request body.

PUT /data/schedule-items/{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/schedule-items/{instance_id}

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

Retrieve all entries for given model.

GET /data/milestones/

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

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

Create a model with data given in the request body.

POST /data/milestones/

Jwt authorization

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

Responses

200

Model created
400

Error

POST /data/milestones/

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

Retrieve all entries for given model.

GET /data/entity-links/

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/entity-links/

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

Create a model with data given in the request body.

POST /data/chats/

Jwt authorization

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

Responses

200

Model created
400

Error

POST /data/chats/

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

Create a model with data given in the request body.

POST /data/chat-messages/

Jwt authorization

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

Responses

200

Model created
400

Error

POST /data/chat-messages/

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

Update a model with data given in the request body.

PUT /data/chat-messages/{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/chat-messages/{instance_id}

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

Update a model with data given in the request body.

PUT /data/preview-background-files/{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/preview-background-files/{instance_id}

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

Create a model with data given in the request body.

POST /data/studios

Jwt authorization

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

Responses

200

Model created
400

Error

POST /data/studios

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

Create a model with data given in the request body.

POST /data/production-schedule-versions

Jwt authorization

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

Responses

200

Model created
400

Error

POST /data/production-schedule-versions

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

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

DELETE /data/production-schedule-version-task-links/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/production-schedule-version-task-links/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/production-schedule-version-task-links/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Get all software items for a given department.

GET /data/departments/{department_id}/software-licenses/{software_id}

Jwt authorization

Path parameters

department_id Required

Responses

200

Software items for given department
404

Department ID matches no department

GET /data/departments/{department_id}/software-licenses/{software_id}

curl \
 --request GET 'http://api.example.com/data/departments/a24a6ea4-ce75-4665-a070-57453082c25/software-licenses/{software_id}' \
 --header "Authorization: $API_KEY"

Retrieve data versions of given edit.

GET /data/edits/{edit_id}/versions

Jwt authorization

Path parameters

edit_id Required

Responses

200

Data versions of given edit

GET /data/edits/{edit_id}/versions

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

Retrieve all tasks related to a given episode.

GET /data/episodes/{episode_id}/edit-tasks

Jwt authorization

Path parameters

episode_id Required

Responses

200

All tasks related to given episode

GET /data/episodes/{episode_id}/edit-tasks

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

Create an edit for given project.

POST /data/projects/{project_id}/edits

Jwt authorization

Path parameters

project_id Required

Responses

201

Edit created for given project

POST /data/projects/{project_id}/edits

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

Resource to retrieve the entities linked on a given entity.

GET /data/entities/{entity_id}/entities-linked/with-tasks

Jwt authorization

Path parameters

entity_id Required

Responses

200

Entities linked on given entity

GET /data/entities/{entity_id}/entities-linked/with-tasks

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

Export a given playlist as csv.

GET /export/csv/playlists/{playlist_id}

Jwt authorization

Path parameters

playlist_id Required

Responses

200

Playlist exported as csv

GET /export/csv/playlists/{playlist_id}

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

Create new output file linked to a given entity.

POST /data/entities/{entity_id}/output-files/new

Jwt authorization

Output files are linked to entities. Each time a CG artist is satisfied by what he did on a working file, he can create an output file that will be linked to a target entity (an asset, a shot, a sequence, ...). It keeps track of the working file at the origin of the output file. An output type is required for better categorization (textures, caches, ...). A task type can be set too to give the department related to the output file. Revision is automatically set.

Path parameters

entity_id Required

Responses

200

New output file created
400

Given output file already exists Given person not found Given output type not found

POST /data/entities/{entity_id}/output-files/new

curl \
 --request POST 'http://api.example.com/data/entities/a24a6ea4-ce75-4665-a070-57453082c25/output-files/new' \
 --header "Authorization: $API_KEY"

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

GET /data/entities/{entity_id}/output-files/last-revisions

Jwt authorization

Path parameters

entity_id Required

Responses

200

Last revisions of output files for given entity grouped by output type and file name

GET /data/entities/{entity_id}/output-files/last-revisions

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

Get all output files for given entity and given output type.

GET /data/entities/{entity_id}/output-types/{output_type_id}/output-files

Jwt authorization

Path parameters

entity_id Required
output_type_id Required

Responses

200

All output files for given entity and given output type

GET /data/entities/{entity_id}/output-types/{output_type_id}/output-files

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

Get all output files for given asset instance and given output type.

GET /data/asset-instances/{asset_instance_id}/output-files

Jwt authorization

Path parameters

asset_instance_id Required

Query parameters

temporal_entity_id Required
output_type_id Required
task_type_id Required
file_status_id Required
representation Required

Responses

200

All output files for given asset instance and given temporal entity (shot, sequence, etc.)

GET /data/asset-instances/{asset_instance_id}/output-files

curl \
 --request GET 'http://api.example.com/data/asset-instances/a24a6ea4-ce75-4665-a070-57453082c25/output-files?temporal_entity_id=cache&output_type_id=a24a6ea4-ce75-4665-a070-57453082c25&task_type_id=a24a6ea4-ce75-4665-a070-57453082c25&file_status_id=a24a6ea4-ce75-4665-a070-57453082c25&representation=cache' \
 --header "Authorization: $API_KEY"

Import shotgun resource.

POST /import/shotgun/scenes

Jwt authorization

Responses

200

Resource imported

POST /import/shotgun/scenes

curl \
 --request POST 'http://api.example.com/import/shotgun/scenes' \
 --header "Authorization: $API_KEY"

Import shotgun resource.

POST /import/shotgun/steps

Jwt authorization

Responses

200

Resource imported

POST /import/shotgun/steps

curl \
 --request POST 'http://api.example.com/import/shotgun/steps' \
 --header "Authorization: $API_KEY"

Import shotgun resource.

POST /import/shotgun/tasks

Jwt authorization

Responses

200

Resource imported

POST /import/shotgun/tasks

curl \
 --request POST 'http://api.example.com/import/shotgun/tasks' \
 --header "Authorization: $API_KEY"

Import remove instance.

POST /import/shotgun/remove/scene

Jwt authorization

Responses

204

Instance removed

POST /import/shotgun/remove/scene

curl \
 --request POST 'http://api.example.com/import/shotgun/remove/scene' \
 --header "Authorization: $API_KEY"

Import project edits.

POST /import/csv/projects/{project_id}/edits

Jwt authorization

Path parameters

project_id Required

Responses

201

Edits imported
400

Format error

POST /import/csv/projects/{project_id}/edits

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

Import the estimations of task-types for given episode of given project.

POST /import/csv/projects/{project_id}/episodes/{episode_id}/task-types/{task_type_id}/estimations

Jwt authorization

Path parameters

project_id Required
task_type_id Required
episode_id Required

Responses

201

Estimations imported
400

Format error

POST /import/csv/projects/{project_id}/episodes/{episode_id}/task-types/{task_type_id}/estimations

curl \
 --request POST 'http://api.example.com/import/csv/projects/a24a6ea4-ce75-4665-a070-57453082c25/episodes/a24a6ea4-ce75-4665-a070-57453082c25/task-types/a24a6ea4-ce75-4665-a070-57453082c25/estimations' \
 --header "Authorization: $API_KEY"

Import an OTIO file to enter frame_in / frame_out / nb_frames (it can

POST /import/otio/projects/{project_id}/episodes/{episode_id}

Jwt authorization

be every adapter supported by OpenTimelineIO, for example: edl, otio...
).

Path parameters

project_id Required
episode_id Required

Responses

201

.
400

The .otio file is not properly formatted.

POST /import/otio/projects/{project_id}/episodes/{episode_id}

curl \
 --request POST 'http://api.example.com/import/otio/projects/a24a6ea4-ce75-4665-a070-57453082c25/episodes/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Import Kitsu resource.

POST /import/kitsu/tasks

Jwt authorization

Responses

200

Resource imported

POST /import/kitsu/tasks

curl \
 --request POST 'http://api.example.com/import/kitsu/tasks' \
 --header "Authorization: $API_KEY"

Get API name and version.

GET /

Jwt authorization

Responses

200

API name and version

GET /

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

Retrieve date and CPU, memory and jobs stats.

GET /status/resources

Jwt authorization

Responses

200

Date and CPU, memory and jobs stats

GET /status/resources

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

Create desktop login logs.

POST /data/persons/{person_id}/desktop-login-logs

Jwt authorization

Add a new log entry for desktop logins.

POST /data/persons/{person_id}/desktop-login-logs

curl \
 --request POST 'http://api.example.com/data/persons/a24a6ea4-ce75-4665-a070-57453082c25/desktop-login-logs' \
 --header "Authorization: $API_KEY"

Get time spents for given person and date.

GET /data/persons/{person_id}/time-spents/{date}

Jwt authorization

Path parameters

person_id Required
date Required

Responses

200

Time spents for given person and date
404

Wrong date format

GET /data/persons/{person_id}/time-spents/{date}

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

Return all day off recorded for given year and person.

GET /data/persons/{person_id}/day-offs/year/{year}

Jwt authorization

Path parameters

person_id Required
year Required

Responses

200

All day off recorded for given year and person

GET /data/persons/{person_id}/day-offs/year/{year}

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

Retrieve build job related to given playlist.

GET /data/playlists/{playlist_id}/jobs/{build_job_id}

Jwt authorization

Path parameters

playlist_id Required
build_job_id Required

Responses

200

Build job related to given playlist

GET /data/playlists/{playlist_id}/jobs/{build_job_id}

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

Retrieve all build jobs related to given project.

GET /data/projects/{project_id}/build-jobs

Jwt authorization

It's mainly used for synchronisation purpose.

Path parameters

project_id Required

Responses

200

All build jobs related to given project

GET /data/projects/{project_id}/build-jobs

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

Download a thumbnail.

GET /pictures/thumbnails/preview-files/{instance_id}.png

Jwt authorization

Path parameters

instance_id Required

Responses

200

Thumbnail downloaded
403

Instance not allowed
404

Picture file not found

GET /pictures/thumbnails/preview-files/{instance_id}.png

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

Download a generic file preview as attachment.

GET /pictures/originals/preview-files/{instance_id}/download

Jwt authorization

Path parameters

instance_id Required

Responses

200

Generic file preview downloaded as attachment
403

Instance not allowed
404

Standard file not found

GET /pictures/originals/preview-files/{instance_id}/download

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

Download the thumbnail linked to given object instance.

GET /pictures/thumbnails/projects/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Thumbnail downloaded
403

Access not allowed
404

Object instance not found

GET /pictures/thumbnails/projects/{instance_id}

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

Create a thumbnail for given object instance.

POST /pictures/thumbnails/projects/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Thumbnail created
404

Cannot found related object.

POST /pictures/thumbnails/projects/{instance_id}

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

Main resource to add a preview background file.

POST /pictures/preview-background-files/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Preview background file added

POST /pictures/preview-background-files/{instance_id}

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

Remove an asset type from a production.

DELETE /data/projects/{project_id}/settings/asset-types/{asset_type_id}

Jwt authorization

Path parameters

project_id Required
asset_type_id Required

Responses

204

Empty response

DELETE /data/projects/{project_id}/settings/asset-types/{asset_type_id}

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

Get a metadata descriptor.

GET /data/projects/{project_id}/metadata-descriptors/{descriptor_id}

Jwt authorization

Descriptors serve to describe extra fields listed in the data attribute of entities.

Path parameters

project_id Required
descriptor_id Required

Responses

200

Metadata descriptor

GET /data/projects/{project_id}/metadata-descriptors/{descriptor_id}

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

Delete a metadata descriptor.

DELETE /data/projects/{project_id}/metadata-descriptors/{descriptor_id}

Jwt authorization

Descriptors serve to describe extra fields listed in the data attribute of entities.

Path parameters

project_id Required
descriptor_id Required

Responses

204

Empty response

DELETE /data/projects/{project_id}/metadata-descriptors/{descriptor_id}

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

Retrieve episodes schedule items for given task type

GET /data/projects/{project_id}/schedule-items/{task_type_id}/episodes

Jwt authorization

Path parameters

project_id Required
task_type_id Required

Responses

200

All episodes schedule items for given task type

GET /data/projects/{project_id}/schedule-items/{task_type_id}/episodes

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

Retrieve time spents for given production

GET /data/projects/{project_id}/time-spents

Jwt authorization

Path parameters

project_id Required

Responses

200

All time spents of given production

GET /data/projects/{project_id}/time-spents

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

Get task links for given production schedule version.

GET /data/production-schedule-versions/{production_schedule_version_id}/task-links

Jwt authorization

Path parameters

production_schedule_version_id Required

Query parameters

task_type_id

Responses

200

Task links for given production schedule version.
400

Wrong ID format

GET /data/production-schedule-versions/{production_schedule_version_id}/task-links

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

Delete given shot.

DELETE /data/shots/{shot_id}

Jwt authorization

Path parameters

shot_id Required

Responses

204

Given shot deleted

DELETE /data/shots/{shot_id}

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

Retrieve all shot entries for a given sequence.

GET /data/sequences/{sequence_id}/shots

Jwt authorization

Filters can be specified in the query string.

Path parameters

sequence_id Required

Query parameters

project_id

Responses

200

All shot entries for given sequence

GET /data/sequences/{sequence_id}/shots

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

Get time spent on a given task and date.

GET /actions/tasks/{task_id}/time-spents/{date}

Jwt authorization

Path parameters

task_id Required
date Required

Responses

200

Time spent on given task and date
404

Wrong date format

GET /actions/tasks/{task_id}/time-spents/{date}

curl \
 --request GET 'http://api.example.com/actions/tasks/a24a6ea4-ce75-4665-a070-57453082c25/time-spents/2022-07-12' \
 --header "Authorization: $API_KEY"

Add given timeframe to time spent by a person on a task for a given day.

POST /actions/tasks/{task_id}/time-spents/{date}/persons/{person_id}/add

Jwt authorization

Path parameters

task_id Required
date Required
person_id Required

Responses

201

Given timeframe added to time spent by given person on given task for given day
404

Wrong date format

POST /actions/tasks/{task_id}/time-spents/{date}/persons/{person_id}/add

curl \
 --request POST 'http://api.example.com/actions/tasks/a24a6ea4-ce75-4665-a070-57453082c25/time-spents/2022-07-12/persons/a24a6ea4-ce75-4665-a070-57453082c25/add' \
 --header "Authorization: $API_KEY"

Add a preview to given comment.

POST /actions/tasks/{task_id}/comments/{comment_id}/preview-files/{preview_file_id}

Jwt authorization

Path parameters

task_id Required
comment_id Required
preview_file_id Required

Responses

201

Preview added to given comment

POST /actions/tasks/{task_id}/comments/{comment_id}/preview-files/{preview_file_id}

curl \
 --request POST 'http://api.example.com/actions/tasks/a24a6ea4-ce75-4665-a070-57453082c25/comments/a24a6ea4-ce75-4665-a070-57453082c25/preview-files/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete preview from given comment.

DELETE /actions/tasks/{task_id}/comments/{comment_id}/preview-files/{preview_file_id}

Jwt authorization

Path parameters

task_id Required
comment_id Required
preview_file_id Required

Responses

204

Preview deleted from given comment

DELETE /actions/tasks/{task_id}/comments/{comment_id}/preview-files/{preview_file_id}

curl \
 --request DELETE 'http://api.example.com/actions/tasks/a24a6ea4-ce75-4665-a070-57453082c25/comments/a24a6ea4-ce75-4665-a070-57453082c25/preview-files/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Set `has_avatar` flag to False for current user and remove its avatar

DELETE /actions/persons/{person_id}/clear-avatar

Jwt authorization

file.

Responses

204

Avatar file deleted

DELETE /actions/persons/{person_id}/clear-avatar

curl \
 --request DELETE 'http://api.example.com/actions/persons/{person_id}/clear-avatar' \
 --header "Authorization: $API_KEY"

Return assets of which type is given asset type and are listed in given

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

Jwt authorization

project if user has access to this project.

Path parameters

project_id Required
asset_type_id Required

Responses

200

Assets of which type is given asset type and are listed in given project

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

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

Update given filter if it's owned by current user.

PUT /data/user/filters/{filter_id}

Jwt authorization

Path parameters

filter_id Required

Responses

200

Given filter with updated data.

PUT /data/user/filters/{filter_id}

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

Retrieve given filter group for the current user.

GET /data/user/filter-groups/{filter_group_id}

Jwt authorization

Responses

200

Filter groups for the current user and only for open projects

GET /data/user/filter-groups/{filter_group_id}

curl \
 --request GET 'http://api.example.com/data/user/filter-groups/{filter_group_id}' \
 --header "Authorization: $API_KEY"

Update given filter group if it's owned by the current user.

PUT /data/user/filter-groups/{filter_group_id}

Jwt authorization

Path parameters

filter_id Required

Responses

200

Given filter group with updated data

PUT /data/user/filter-groups/{filter_group_id}

curl \
 --request PUT 'http://api.example.com/data/user/filter-groups/{filter_group_id}' \
 --header "Authorization: $API_KEY"

Get day off object for current user and given date.

GET /data/user/day-offs/{date}

Jwt authorization

Path parameters

date Required

Responses

200

Day off object for current user and given date
404

Wrong date format

GET /data/user/day-offs/{date}

curl \
 --request GET 'http://api.example.com/data/user/day-offs/2022-07-12' \
 --header "Authorization: $API_KEY"

Remove the subscription entry matching given task and current user.

DELETE /actions/user/tasks/{task_id}/unsubscribe

Jwt authorization

The user will no longer receive notifications for this task.

Path parameters

task_id Required

Responses

204

Subscription entry removed

DELETE /actions/user/tasks/{task_id}/unsubscribe

curl \
 --request DELETE 'http://api.example.com/actions/user/tasks/a24a6ea4-ce75-4665-a070-57453082c25/unsubscribe' \
 --header "Authorization: $API_KEY"

Return true if current user has subscribed to given sequence and

GET /data/user/entities/{sequence_id}/task-types/{task_type_id}/subscribed

Jwt authorization

task type.

Path parameters

sequence_id Required
task_type_id Required

Responses

200

True if current user has subscribed to given sequence and task type, False otherwise

GET /data/user/entities/{sequence_id}/task-types/{task_type_id}/subscribed

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

Authentication

Allow a user to register himself to the service.

Responses

Resource to allow a user to disable OTP by email.

Responses

Retrieve all tasks related to given asset.

Path parameters

Responses

Create new asset with given parameters.

Path parameters

Body Required

Responses

Retrieve all asset types for given project.

Path parameters

Responses

Retrieve all shared assets used in project episode.

Path parameters

Responses

Retrieve all asset instances linked to scene.

Path parameters

Responses

Chat

Return all attachment files related to given project.

Path parameters

Responses

Retrieve all concepts, adds project name and asset type name and all related tasks.

Query parameters

Responses

Retrieve given concept.

Path parameters

Responses

Retrieve all tasks related to a given concept.

Path parameters

Responses

Retrieve all entries for given model.

Responses

Update a model with data given in the request body.

Path parameters

Responses

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

Path parameters

Responses

Retrieve all entries for given model.

Responses

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

Path parameters

Responses

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

Path parameters

Responses

Create a model with data given in the request body.

Responses

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

Path parameters

Responses

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

Path parameters

Responses

Create a model with data given in the request body.

Responses

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

Path parameters

Responses

Update a model with data given in the request body.

Path parameters

Responses

Retrieve all entries for given model.

Responses

Create a model with data given in the request body.

Responses

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

Path parameters

Responses

Retrieve all entries for given model.

Responses

Update a model with data given in the request body.

Path parameters

Responses

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

Path parameters