Responses

  • FIDO device pre-registered.

  • Invalid password Wrong or expired token Inactive user

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


























































































































































Retrieve all entity links related to given project.

GET /data/projects/{project_id}/entity-links


Results can be paginated using page and limit query parameters. If you
prefer a more accurate pagination, you can use and
cursor_created_at to get the next page.

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






































































































































































Responses

  • Model deleted

  • Statement or integrity error

  • Instance non-existant

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
















































































































































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"








































































































Update a model with data given in the request body.

PUT /data/day-offs/{instance_id}

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

Responses

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




































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"








































Responses

  • Model deleted

  • Statement or integrity error

  • Instance non-existant

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




















































































Create a model with data given in the request body.

POST /data/entity-links/

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

Responses

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
















Create a model with data given in the request body.

POST /data/chats/

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

Responses

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
































Retrieve all entries for given model.

GET /data/preview-background-files

Filters can be specified in the query string.

Responses

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








































Create a model with data given in the request body.

POST /data/salary-scales

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

Responses

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

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

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

Generate a working file path from file tree template.

POST /data/tasks/{task_id}/working-file-path

Generate file path based on several parameters: task, software, mode, revision and separator. Revision can be computed automatically as next revision if not given.

Path parameters

Responses

  • Working file path generated

  • Malformed file tree

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
















Get all output files for given asset instance and given output type.

GET /data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-types/{output_type_id}/output-files

Responses

  • All output files for given asset instance and given output type

GET /data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-types/{output_type_id}/output-files
curl \
 --request GET 'http://api.example.com/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-types/{output_type_id}/output-files' \
 --header "Authorization: $API_KEY"













































































































































































Import remove instance.

POST /import/shotgun/remove/note

Responses

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

















































































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


















































































































































































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"




























































Set given preview as main preview of the related entity.

PUT /actions/preview-files/{preview_file_id}/set-main-preview

This preview will be used to illustrate the entity.

Responses

  • Given preview set as main preview

PUT /actions/preview-files/{preview_file_id}/set-main-preview
curl \
 --request PUT 'http://api.example.com/actions/preview-files/{preview_file_id}/set-main-preview' \
 --header "Authorization: $API_KEY"









































































































































Retrieve budgets for given production

GET /data/projects/{project_id}/budgets

Responses

  • All budgets of given production

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










































































































Responses

  • All task types related to given scene

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




Path parameters

Responses

  • Given scene marked as source of given shot

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












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

Delete given episode.

DELETE /data/episodes/{episode_id}

Responses

  • Given episode deleted

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




































Delete given sequence.

DELETE /data/sequences/{sequence_id}

Responses

  • Given sequence deleted

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




















































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









































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








Retrieve all comments to tasks related to given project.

GET /data/projects/{project_id}/comments

It's mainly used for synchronisation purpose.

Responses

  • All comments to tasks related to given project

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
















































Set time spent by a person on a task for a given day.

POST /actions/tasks/{task_id}/time-spents/{date}/persons/{person_id}

Path parameters

Responses

  • Time spent by given person on given task for given day is set

  • Wrong date format

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
















Delete preview from given comment.

DELETE /actions/tasks/{task_id}/comments/{comment_id}/preview-files/{preview_file_id}

Responses

  • Preview deleted from given comment

DELETE /actions/tasks/{task_id}/comments/{comment_id}/preview-files/{preview_file_id}
curl \
 --request DELETE 'http://api.example.com/actions/tasks/{task_id}/comments/{comment_id}/preview-files/{preview_file_id}' \
 --header "Authorization: $API_KEY"




















Create a new task with given task type for each entity of given

POST /actions/projects/{project_id}/task-types/{task_type_id}/create-tasks/{entity_type}/

entity type.

Path parameters

Responses

  • List of created tasks.

POST /actions/projects/{project_id}/task-types/{task_type_id}/create-tasks/{entity_type}/
curl \
 --request POST 'http://api.example.com/actions/projects/{project_id}/task-types/{task_type_id}/create-tasks/{entity_type}/' \
 --header "Authorization: $API_KEY"









Responses

  • Tasks related to given asset for current user

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
























Responses

  • Tasks related to given sequence for current user

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








Return assets of which type is given asset type and are listed in given

GET /data/user/projects/{project_id}/asset-types/{asset_type_id}/assets

project if user has access to this project.

Responses

  • Assets of which type is given asset type and are listed in given project

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
























































































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










































































Task