Tokens are considered as outdated every two weeks.

GET /auth/refresh-token

This route allows to make their lifetime long before they get outdated.

Responses

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




























Responses

  • new recovery codes.

  • Invalid password Wrong or expired token Inactive user

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








































































Responses

  • Modification of assets linked to given asset

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




Responses

  • All scene asset instances linked to given 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"









































































Resource to retrieve the casting of shots from all sequences of given

GET /data/projects/{project_id}/sequences/all/casting

project.

Responses

  • Casting for all shots from given project.

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












Create an asset instance on given scene.

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

Path parameters

Responses

  • Asset instances created on given scene

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

Responses

  • All camera instances linked to scene

GET /data/scenes/{scene_id}/camera-instances
curl \
 --request GET 'http://api.example.com/data/scenes/{scene_id}/camera-instances' \
 --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"













































































































Retrieve all entries for given model.

GET /data/entities

Filters can be specified in the query string.

Responses

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








































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
































Update a model with data given in the request body.

PUT /data/departments/{instance_id}

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

Responses

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




Retrieve all entries for given model.

GET /data/organisations

Filters can be specified in the query string.

Responses

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
















































































Create a model with data given in the request body.

POST /data/output-types

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

Responses

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












Retrieve all entries for given model.

GET /data/preview-files

Filters can be specified in the query string.

Responses

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












Delete a preview file corresponding at given ID and retuns

DELETE /data/preview-files/{instance_id}

a 204 status code.

Responses

  • Model deleted

  • Statement or integrity error

  • Instance non-existant

DELETE /data/preview-files/{instance_id}
curl \
 --request DELETE '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/time-spents/

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

Responses

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








































































Create a model with data given in the request body.

POST /data/asset-instances/

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

Responses

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












































Responses

  • Model deleted

  • Statement or integrity error

  • Instance non-existant

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












Update a model with data given in the request body.

PUT /data/notifications/{instance_id}

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

Responses

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
















Update a model with data given in the request body.

PUT /data/search-filters/{instance_id}

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

Responses

PUT /data/search-filters/{instance_id}
curl \
 --request PUT 'http://api.example.com/data/search-filters/{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/metadata-descriptors/{instance_id}
curl \
 --request DELETE 'http://api.example.com/data/metadata-descriptors/{instance_id}' \
 --header "Authorization: $API_KEY"








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




Responses

  • Model deleted

  • Statement or integrity error

  • Instance non-existant

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








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




































































Retrieve all entries for given model.

GET /data/studios

Filters can be specified in the query string.

Responses

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












































Responses

  • Model deleted

  • Statement or integrity error

  • Instance non-existant

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





































Retrieve all previews related to a given edit.

GET /data/edits/{edit_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 edit

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





























Responses

  • All time spents linked to given entity

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

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





Export assets linked to a given project as csv.

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

Responses

  • Assets exported as csv

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









































Responses

  • Last working files revision for each file name for given task

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





















































































































Responses

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

Responses

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












































































































Import the estimations of task-types for given project.

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

Path parameters

Responses

POST /import/csv/projects/{project_id}/task-types/{task_type_id}/estimations
curl \
 --request POST 'http://api.example.com/import/csv/projects/{project_id}/task-types/{task_type_id}/estimations' \
 --header "Authorization: $API_KEY"













































Responses

  • Date and CPU, memory and jobs stats

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






































Responses

  • CSV file containing the presence logs based on a daily basis

GET /data/persons/presence-logs/{month_date}
curl \
 --request GET 'http://api.example.com/data/persons/presence-logs/{month_date}' \
 --header "Authorization: $API_KEY"

Get time spents for given person and date.

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

Responses

  • Time spents for given person and date

  • Wrong date format

GET /data/persons/{person_id}/time-spents/{date}
curl \
 --request GET 'http://api.example.com/data/persons/{person_id}/time-spents/{date}' \
 --header "Authorization: $API_KEY"
















































Responses

  • All day off recorded for given month

GET /data/persons/day-offs/{year}/{month}
curl \
 --request GET 'http://api.example.com/data/persons/day-offs/{year}/{month}' \
 --header "Authorization: $API_KEY"





















































































Responses

  • All preview files from open productions with states equals to processing or broken

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

Main resource to add a preview.

POST /pictures/preview-files/{instance_id}

It stores the preview file and generates three picture files matching preview when it's possible: a square thumbnail, a rectangle thumbnail and a midsize file.

Path parameters

Responses

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








Download a lowdef movie preview.

GET /movies/low/preview-files/{instance_id}.mp4

Responses

  • Lowdef movie preview downloaded

  • Instance not allowed

  • File not found

GET /movies/low/preview-files/{instance_id}.mp4
curl \
 --request GET 'http://api.example.com/movies/low/preview-files/{instance_id}.mp4' \
 --header "Authorization: $API_KEY"




























Download a thumbnail.

GET /movies/tiles/preview-files/{instance_id}.png

Responses

  • Thumbnail downloaded

  • Instance not allowed

  • Picture file not found

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

















































































































Remove a task type from a production.

DELETE /data/projects/{project_id}/settings/task-types/{task_type_id}

Responses

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