Responses

  • Redirect to the SAML IDP.

  • Wrong parameter.

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














































































































Resource to retrieve the casting of a given entity.

GET /data/projects/{project_id}/entities/{entity_id}/casting

Responses

  • Casting of given entity

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













































































Add given files to the comment entry as attachments.

POST /actions/tasks/{task_id}/comments/{comment_id}/add-attachment

Path parameters

Responses

  • Given files added to the comment entry as attachments

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

















































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












































































































































































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"
















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"












































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"




Update a model with data given in the request body.

PUT /data/asset-instances/{instance_id}

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

Responses

PUT /data/asset-instances/{instance_id}
curl \
 --request PUT '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/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"












































Update a model with data given in the request body.

PUT /data/schedule-items/{instance_id}

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

Responses

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




















































































Retrieve all entries for given model.

GET /data/entity-links/

Filters can be specified in the query string.

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
























































Responses

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












Create a model with data given in the request body.

POST /data/studios

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

Responses

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

Update a model with data given in the request body.

PUT /data/studios/{instance_id}

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

Responses

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























































































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









































Export as csv.

GET /export/csv/task-types.csv

Responses

GET /export/csv/task-types.csv
curl \
 --request GET 'http://api.example.com/export/csv/task-types.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/notes
curl \
 --request POST 'http://api.example.com/import/shotgun/notes' \
 --header "Authorization: $API_KEY"












































Import remove instance.

POST /import/shotgun/remove/projectconnection

Responses

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

Import remove instance.

POST /import/shotgun/remove/step

Responses

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














































Get day off object for given person and date.

GET /data/persons/{person_id}/day-offs/{date}

Responses

  • Day off object for given person and date

  • Wrong date format

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








Get aggregated time spents for given person and day.

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

Path parameters

Responses

  • Aggregated time spents for given person and day

  • Wrong date format

GET /data/persons/{person_id}/time-spents/day/{year}/{month}/{day}
curl \
 --request GET 'http://api.example.com/data/persons/{person_id}/time-spents/day/{year}/{month}/{day}' \
 --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

  • Thumbnail downloaded

  • Access not allowed

  • Object instance not found

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
















Create a thumbnail for given object instance.

POST /pictures/thumbnails/projects/{instance_id}.png

Path parameters

Responses

  • Thumbnail created

  • Cannot found related object.

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

Download the thumbnail linked to given object instance.

GET /pictures/thumbnails/preview-background-files/{instance_id}.png

Responses

  • Thumbnail downloaded

  • Access not allowed

  • Object instance not found

GET /pictures/thumbnails/preview-background-files/{instance_id}.png
curl \
 --request GET 'http://api.example.com/pictures/thumbnails/preview-background-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"

































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








Add a task type linked to a production.

POST /data/projects/{project_id}/settings/task-types

Path parameters

Responses

  • Asset type added to production

POST /data/projects/{project_id}/settings/task-types
curl \
 --request POST 'http://api.example.com/data/projects/{project_id}/settings/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"




























































Delete a budget for given production

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

Responses

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


























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
































Responses

  • Data versions of given shot

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








































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




























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
















































Responses

  • All episodes related to given project

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





























Return task amount, task done amount, total estimation, total duration

GET /data/tasks/open-tasks/stats

by status by task type by project for open projects. It aggregates the
result at the project level.

Responses

  • A dict organized by project that contains the results for each task type and status pairs.

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




























































































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

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

Responses

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

  • Wrong date format

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
































Create a new task for given concept and task type.

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

Path parameters

Responses

  • New task for given concept and task type created

POST /actions/projects/{project_id}/task-types/{task_type_id}/concepts/create-tasks
curl \
 --request POST 'http://api.example.com/actions/projects/{project_id}/task-types/{task_type_id}/concepts/create-tasks' \
 --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

  • Open projects for which the user has at least one task assigned

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
































Responses

  • Finished tasks currently assigned to current user

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




















Responses

  • Filter groups for the current user and only for open projects created.

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
























































Create a subscription entry for given task and current user.

POST /actions/user/tasks/{task_id}/subscribe

When a user subscribes, he gets notified everytime a comment is posted on the task.

Path parameters

Responses

  • Subscription entry created

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




































































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