Responses

  • TOTP enabled

  • Invalid password Wrong or expired token Inactive user

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

Responses

  • TOTP enabled

  • Invalid password Wrong or expired token Inactive user

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

























































Retrieve all entities that are not shot or sequence.

GET /data/assets

Adds project name and asset type name.

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












DELETE /data/assets/{asset_id}
curl \
 --request DELETE 'http://api.example.com/data/assets/{asset_id}' \
 --header "Authorization: $API_KEY"




























Retrieve all scene asset instances linked to asset.

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

Responses

  • All scene asset instances linked to asset

GET /data/assets/{asset_id}/scene-asset-instances
curl \
 --request GET 'http://api.example.com/data/assets/{asset_id}/scene-asset-instances' \
 --header "Authorization: $API_KEY"




























POST /actions/assets/share
curl \
 --request POST 'http://api.example.com/actions/assets/share' \
 --header "Authorization: $API_KEY"





















Resource to allow the modification of assets linked to an entity.

PUT /data/projects/{project_id}/entities/{entity_id}/casting

Responses

  • Modification of assets linked to an entity

PUT /data/projects/{project_id}/entities/{entity_id}/casting
curl \
 --request PUT 'http://api.example.com/data/projects/{project_id}/entities/{entity_id}/casting' \
 --header "Authorization: $API_KEY"

































































Delete given comment reply.

DELETE /data/tasks/{task_id}/comments/{comment_id}/reply/{reply_id}

Responses

  • Given comment reply deleted

DELETE /data/tasks/{task_id}/comments/{comment_id}/reply/{reply_id}
curl \
 --request DELETE 'http://api.example.com/data/tasks/{task_id}/comments/{comment_id}/reply/{reply_id}' \
 --header "Authorization: $API_KEY"




























Creates new comments for given task. Each comments requires a task_id,

POST /actions/tasks/batch-comment

text, a task_status and a person as arguments.

Responses

  • New comments created

POST /actions/tasks/batch-comment
curl \
 --request POST 'http://api.example.com/actions/tasks/batch-comment' \
 --header "Authorization: $API_KEY"

















































































































Retrieve all entries for given model.

GET /data/task-status

Filters can be specified in the query string.

Responses

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
















































































































































Responses

  • Model deleted

  • Statement or integrity error

  • Instance non-existant

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




Create a model with data given in the request body.

POST /data/preview-files

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

Responses

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




Update a model with data given in the request body.

PUT /data/preview-files/{instance_id}

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

Responses

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
































































































































































Create a model with data given in the request body.

POST /data/playlists/

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

Responses

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

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

Responses

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
















Create a model with data given in the request body.

POST /data/notifications/

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

Responses

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
















Create a model with data given in the request body.

POST /data/search-filters/

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

Responses

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




























































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




































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




















































































Responses

  • Model deleted

  • Statement or integrity error

  • Instance non-existant

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












































































Create a model with data given in the request body.

POST /data/plugins

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

Responses

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

Retrieve all edit entries.

GET /data/edits

Filters can be specified in the query string.

Responses

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







































































































Export as csv.

GET /export/csv/time-spents.csv

Responses

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

































































Responses

  • All types of output generated for given entity

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









































Responses

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








Import shotgun resource.

POST /import/shotgun/sequences

Responses

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

Responses

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




























































































































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

POST /import/otio/projects/{project_id}

be every adapter supported by OpenTimelineIO, for example: EDL, OTIO...
).

Path parameters

Responses

  • .

  • The .otio file is not properly formatted.

POST /import/otio/projects/{project_id}
curl \
 --request POST 'http://api.example.com/import/otio/projects/{project_id}' \
 --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}

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

Path parameters

Responses

  • .

  • 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/{project_id}/episodes/{episode_id}' \
 --header "Authorization: $API_KEY"





































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


















































































































Add a user to given department.

POST /actions/persons/{person_id}/departments/add

Path parameters

Responses

  • User added to given department

POST /actions/persons/{person_id}/departments/add
curl \
 --request POST 'http://api.example.com/actions/persons/{person_id}/departments/add' \
 --header "Authorization: $API_KEY"


























































































Download a thumbnail.

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

Responses

  • Thumbnail downloaded

  • Instance not allowed

  • Picture file not found

GET /pictures/thumbnails-square/preview-files/{instance_id}.png
curl \
 --request GET 'http://api.example.com/pictures/thumbnails-square/preview-files/{instance_id}.png' \
 --header "Authorization: $API_KEY"




















Download the thumbnail linked to given object instance.

GET /pictures/thumbnails/organisations/{instance_id}

Responses

  • Thumbnail downloaded

  • Access not allowed

  • Object instance not found

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




Download the thumbnail linked to given object instance.

GET /pictures/thumbnails/organisations/{instance_id}.png

Responses

  • Thumbnail downloaded

  • Access not allowed

  • Object instance not found

GET /pictures/thumbnails/organisations/{instance_id}.png
curl \
 --request GET 'http://api.example.com/pictures/thumbnails/organisations/{instance_id}.png' \
 --header "Authorization: $API_KEY"




























Download the thumbnail linked to given object instance.

GET /pictures/thumbnails/projects/{instance_id}.png

Responses

  • Thumbnail downloaded

  • Access not allowed

  • Object instance not found

GET /pictures/thumbnails/projects/{instance_id}.png
curl \
 --request GET 'http://api.example.com/pictures/thumbnails/projects/{instance_id}.png' \
 --header "Authorization: $API_KEY"





























































































Remove a status automation from a production.

DELETE /data/projects/{project_id}/settings/status-automations/{status_automation_id}

Responses

DELETE /data/projects/{project_id}/settings/status-automations/{status_automation_id}
curl \
 --request DELETE 'http://api.example.com/data/projects/{project_id}/settings/status-automations/{status_automation_id}' \
 --header "Authorization: $API_KEY"
























































































Update a budget entry for given production and budget

PUT /data/projects/{project_id}/budgets/{budget_id}/entries/{entry_id}

Responses

  • Budget entry updated

PUT /data/projects/{project_id}/budgets/{budget_id}/entries/{entry_id}
curl \
 --request PUT 'http://api.example.com/data/projects/{project_id}/budgets/{budget_id}/entries/{entry_id}' \
 --header "Authorization: $API_KEY"














































Retrieve all previews related to a given shot.

GET /data/shots/{shot_id}/preview-files

It sends them as a dict. Keys are related task type ids and values are arrays of preview for this task type.

Responses

  • All previews related to given episode

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




Retrieve all scene entries.

GET /data/scenes/all

Filters can be specified in the query string.

Responses

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








DELETE /data/scenes/{scene_id}
curl \
 --request DELETE 'http://api.example.com/data/scenes/{scene_id}' \
 --header "Authorization: $API_KEY"
































































































Retrieve all shots related to a given project.

GET /data/projects/{project_id}/shots

Responses

  • All shots related to given project

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