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





















































































































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

Resource to retrieve the casting of shots from given sequence.

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

Responses

  • Casting of shots from given sequence

GET /data/projects/{project_id}/sequences/{sequence_id}/casting
curl \
 --request GET 'http://api.example.com/data/projects/{project_id}/sequences/{sequence_id}/casting' \
 --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"













































Create a new comment for given task.

POST /actions/tasks/{task_id}/comment

It requires a text, a task_status and a person as arguments. This way, comments keep history of status changes. When the comment is created, it updates the task status with given task status.

Path parameters

Responses

  • New comment created

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













































Responses

  • Model deleted

  • Statement or integrity error

  • Instance non-existant

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








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












































































Update a model with data given in the request body.

PUT /data/task-status/{instance_id}

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

Responses

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
















Retrieve all entries for given model.

GET /data/departments

Filters can be specified in the query string.

Responses

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
























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












































































Responses

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




































Responses

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
























































































Create a model with data given in the request body.

POST /data/custom-actions/

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

Responses

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








































































































































































Responses

  • Model deleted

  • Statement or integrity error

  • Instance non-existant

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




































































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

  • 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/{asset_instance_id}/output-files' \
 --header "Authorization: $API_KEY"













































Responses

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












































Import remove instance.

POST /import/shotgun/remove/person

Responses

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

Import remove instance.

POST /import/shotgun/remove/shot

Responses

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
























































































Responses

POST /import/kitsu/projects
curl \
 --request POST 'http://api.example.com/import/kitsu/projects' \
 --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 ended shots used for quota calculation of this week.

GET /data/persons/{person_id}/quota-shots/week/{year}/{week}

Responses

  • Ended shots used for quota calculation of this week

  • Wrong date format

GET /data/persons/{person_id}/quota-shots/week/{year}/{week}
curl \
 --request GET 'http://api.example.com/data/persons/{person_id}/quota-shots/week/{year}/{week}' \
 --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"
















Create a thumbnail for given object instance.

POST /pictures/thumbnails/persons/{instance_id}

Path parameters

Responses

  • Thumbnail created

  • Cannot found related object.

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












Create a thumbnail for given object instance.

POST /pictures/thumbnails/projects/{instance_id}

Path parameters

Responses

  • Thumbnail created

  • Cannot found related object.

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












































Responses

  • People listed in a production team

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




































Remove a task status from a production.

DELETE /data/projects/{project_id}/settings/task-status/{task_status_id}

Responses

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

Get a status automation linked to a production.

GET /data/projects/{project_id}/settings/status-automations

Responses

  • Status automation linked to production

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












Return preview background files linked to a production

GET /data/projects/{project_id}/settings/preview-background-files

Responses

  • Preview background files linked to production

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












































Retrieve sequences schedule items for given task type

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

Responses

  • All sequences schedule items for given task type

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

Retrieve time spents for given production

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

Responses

  • All time spents of given production

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






























































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








































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




Responses

  • All shots that come from given scene

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




























Retrieve all sequence entries for a given episode.

GET /data/episodes/{episode_id}/sequences

Filters can be specified in the query string.

Responses

  • All sequence entries for given episode

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

Responses

  • All tasks related to given episode

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












































Retrieve all tasks related to a given sequence.

GET /data/sequences/{sequence_id}/shot-tasks

Responses

  • All task types related to given sequence

GET /data/sequences/{sequence_id}/shot-tasks
curl \
 --request GET 'http://api.example.com/data/sequences/{sequence_id}/shot-tasks' \
 --header "Authorization: $API_KEY"