Responses

  • All asset instances instantiated inside given asset

GET /data/assets/{asset_id}/asset-asset-instances
curl \
 --request GET 'http://api.example.com/data/assets/{asset_id}/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

Responses

  • 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/{project_id}/asset-types/{asset_type_id}/assets' \
 --header "Authorization: $API_KEY"




















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

Resource to retrieve the casting of shots from given episode.

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

Responses

  • Casting for all shots from given episode.

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












Responses

  • All asset instances linked to given scene

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





























































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

POST /actions/tasks/{task_id}/batch-comment

task_status and a person as arguments.

Path parameters

Responses

  • New comments created

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













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








































































































Create a model with data given in the request body.

POST /data/task-status

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

Responses

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
































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












































Responses

  • Model deleted

  • Statement or integrity error

  • Instance non-existant

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
















Responses

  • Model deleted

  • Statement or integrity error

  • Instance non-existant

DELETE /data/softwares/{instance_id}
curl \
 --request DELETE '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

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

Responses

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








Responses

  • Model deleted

  • Statement or integrity error

  • Instance non-existant

DELETE /data/output-files/{instance_id}
curl \
 --request DELETE '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/working-files

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

Responses

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




























































Update a model with data given in the request body.

PUT /data/time-spents/{instance_id}

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

Responses

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
























Retrieve all entries for given model.

GET /data/custom-actions/

Filters can be specified in the query string.

Responses

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




























Update a model with data given in the request body.

PUT /data/status-automations/{instance_id}

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

Responses

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












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"




Update a model with data given in the request body.

PUT /data/events/{instance_id}

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

Responses

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




















































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

















































































































































































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"























































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












Export as csv.

GET /export/csv/tasks.csv

Responses

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













































































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












Download a working file.

GET /data/working-files/{working_file_id}/file

Responses

  • Working file downloaded

GET /data/working-files/{working_file_id}/file
curl \
 --request GET 'http://api.example.com/data/working-files/{working_file_id}/file' \
 --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/steps
curl \
 --request POST 'http://api.example.com/import/shotgun/steps' \
 --header "Authorization: $API_KEY"












Responses

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
































































Import remove instance.

POST /import/shotgun/remove/version

Responses

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
















Import project casting links via a .csv file.

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

Path parameters

Responses

  • The lists of imported casting links.

  • The .csv file is not properly formatted.

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




















































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














































Get aggregated time spents for given person and year.

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

Responses

  • Aggregated time spents for given person and year

  • Wrong date format

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





















































































Retrieve all playlists related to given project.

GET /data/projects/{project_id}/playlists/all

It's mainly used for synchronisation purpose.

Responses

  • All playlists related to given project

GET /data/projects/{project_id}/playlists/all
curl \
 --request GET 'http://api.example.com/data/projects/{project_id}/playlists/all' \
 --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 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/organisations/{instance_id}

Path parameters

Responses

  • Thumbnail created

  • Cannot found related object.

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





















































































Responses

  • Task types linked to the production

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




















































Add a preview background file linked to a production.

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

Path parameters

Responses

  • Preview background file added to production

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

Get all metadata descriptors

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

It serves to describe extra fields listed in the data attribute of entities.

Responses

  • All metadata descriptors

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








Update a metadata descriptor.

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

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

Responses

  • Metadata descriptor updated

PUT /data/projects/{project_id}/metadata-descriptors/{descriptor_id}
curl \
 --request PUT 'http://api.example.com/data/projects/{project_id}/metadata-descriptors/{descriptor_id}' \
 --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"


































































































































































Responses

  • All assets tasks related to given episode

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
















Retrieve all shot entries for a given sequence.

GET /data/sequences/{sequence_id}/shots

Filters can be specified in the query string.

Responses

  • All shot entries for given sequence

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

Responses

  • All scenes related to given sequence

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








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"




































Retrieve number of tasks by status, task_types and episodes for given project.

GET /data/projects/{project_id}/episodes/retake-stats

Responses

  • Number of tasks by status, task types and episodes for given project

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