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"
































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"




































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"

































































Resource to retrieve the casting of assets from given asset type.

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

Responses

  • Casting of assets from given asset type

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

























































Delete attachment linked to a comment matching given ID.

DELETE /data/tasks/{task_id}/comments/{comment_id}/attachments/{attachment_id}

Responses

DELETE /data/tasks/{task_id}/comments/{comment_id}/attachments/{attachment_id}
curl \
 --request DELETE 'http://api.example.com/data/tasks/{task_id}/comments/{comment_id}/attachments/{attachment_id}' \
 --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"




































Responses

  • Model deleted

  • Statement or integrity error

  • Instance non-existant

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












Update a model with data given in the request body.

PUT /data/organisations/{instance_id}

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

Responses

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








Create a model with data given in the request body.

POST /data/file-status/

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

Responses

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




























































































































Update a model with data given in the request body.

PUT /data/attachment-files/{instance_id}

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

Responses

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
















Update a model with data given in the request body.

PUT /data/comments/{instance_id}

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

Responses

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
















Responses

  • Model deleted

  • Statement or integrity error

  • Instance non-existant

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

Retrieve all entries for given model.

GET /data/day-offs/

Filters can be specified in the query string.

Responses

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




Update a model with data given in the request body.

PUT /data/custom-actions/{instance_id}

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

Responses

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

Responses

  • Model deleted

  • Statement or integrity error

  • Instance non-existant

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




Create a model with data given in the request body.

POST /data/status-automations/

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

Responses

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












































Create a model with data given in the request body.

POST /data/search-filter-groups/

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

Responses

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








































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












Create a model with data given in the request body.

POST /data/milestones/

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

Responses

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
























Update a model with data given in the request body.

PUT /data/metadata-descriptors/{instance_id}

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

Responses

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
































































































Export as csv.

GET /export/csv/persons.csv

Responses

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





















































































































Update working file modification date with current date.

PUT /actions/working-files/{working_file_id}/modified

Responses

  • Working file modification date updated

PUT /actions/working-files/{working_file_id}/modified
curl \
 --request PUT 'http://api.example.com/actions/working-files/{working_file_id}/modified' \
 --header "Authorization: $API_KEY"
























Responses

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
















































Import remove instance.

POST /import/shotgun/remove/scene

Responses

POST /import/shotgun/remove/scene
curl \
 --request POST 'http://api.example.com/import/shotgun/remove/scene' \
 --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"









































































Retrieve all playlists related to given project.

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

Responses

  • All playlists related to given project

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
























































































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"

















































































































































Retrieve episodes schedule items for given task type

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

Responses

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




























Retrieve budget entries for given production

GET /data/projects/{project_id}/budgets/{budget_id}/entries

Responses

  • All budget entries of given production and budget

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








Delete a budget entry for given production and budget.

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

Responses

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

Responses

  • List of entities that contain the query

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

Retrieve all tasks related to a given episode.

GET /data/episodes/{episode_id}/tasks

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"