Resource to allow a user to change his password when he forgets it.

POST /auth/reset-password

It uses a classic scheme: a token is sent by email to the user. Then he can change his password.

Responses

  • Reset token sent

  • Email not listed in database

POST /auth/reset-password
curl \
 --request POST 'http://api.example.com/auth/reset-password' \
 --header "Authorization: $API_KEY"












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

Responses

  • OTP by email sent

  • Invalid password Wrong or expired token Inactive user

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
























Responses

  • FIDO device registered.

  • Invalid password Wrong or expired token Inactive user

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









































Responses

  • All assets linked to given asset

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


































































































































Delete given comment reply.

DELETE /data/tasks/{task_id}/comments/{comment_id}/reply/{reply_id}

Responses

  • Given comment reply deleted

DELETE /data/tasks/{task_id}/comments/{comment_id}/reply/{reply_id}
curl \
 --request DELETE 'http://api.example.com/data/tasks/{task_id}/comments/{comment_id}/reply/{reply_id}' \
 --header "Authorization: $API_KEY"

































































































































Create a model with data given in the request body.

POST /data/task-types

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

Responses

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
































Retrieve all entries for given model.

GET /data/tasks

Filters can be specified in the query string.

Responses

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
























































































Retrieve all entries for given model.

GET /data/output-files

Filters can be specified in the query string.

Responses

GET /data/output-files
curl \
 --request GET '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"




































































































































































































































































GET /data/search-filters/{instance_id}
curl \
 --request GET '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/search-filters/{instance_id}
curl \
 --request DELETE 'http://api.example.com/data/search-filters/{instance_id}' \
 --header "Authorization: $API_KEY"
























Create a model with data given in the request body.

POST /data/schedule-items/

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

Responses

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




























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




































Responses

  • Model deleted

  • Statement or integrity error

  • Instance non-existant

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








































































Create a model with data given in the request body.

POST /data/preview-background-files

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

Responses

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









































































































Responses

  • Data versions of given edit

GET /data/edits/{edit_id}/versions
curl \
 --request GET 'http://api.example.com/data/edits/{edit_id}/versions' \
 --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 next revision for given asset instance, output type, task type and name.

POST /data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-files/next-revision

Path parameters

Responses

  • Next revision for given asset instance, output type, task type and name

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
































Responses

  • All types of output generated for given entity

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





































































































Delete error.

DELETE /import/shotgun/errors/{error_id}

Responses

  • Error deleted

  • Error non-existant or Statement error

DELETE /import/shotgun/errors/{error_id}
curl \
 --request DELETE 'http://api.example.com/import/shotgun/errors/{error_id}' \
 --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 /data/projects/news
curl \
 --request GET 'http://api.example.com/data/projects/news' \
 --header "Authorization: $API_KEY"













Create desktop login logs.

POST /data/persons/{person_id}/desktop-login-logs

Add a new log entry for desktop logins.

Path parameters

Responses

  • Desktop login log entry created.

POST /data/persons/{person_id}/desktop-login-logs
curl \
 --request POST 'http://api.example.com/data/persons/{person_id}/desktop-login-logs' \
 --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"

















































































































Retrieve all build jobs related to given project.

GET /data/projects/{project_id}/build-jobs

It's mainly used for synchronisation purpose.

Responses

  • All build jobs related to given project

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


































































































































































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
















































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"




















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"








































Create an episode for given project.

POST /data/projects/{project_id}/episodes

Path parameters

Responses

  • Episode created for given project

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
















Set frames for given shots.

POST /actions/projects/{project_id}/task-types/{task_type_id}/set-shot-nb-frames

Responses

  • Frames set for given shots

POST /actions/projects/{project_id}/task-types/{task_type_id}/set-shot-nb-frames
curl \
 --request POST 'http://api.example.com/actions/projects/{project_id}/task-types/{task_type_id}/set-shot-nb-frames' \
 --header "Authorization: $API_KEY"









Responses

  • Comments linked to given task

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
















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
































For schedule usages, for each active person, it returns the first start

GET /data/persons/task-dates

date of all tasks of assigned to this person and the last end date.

Responses

  • For each person, the first start date of all tasks of assigned to this person and the last end date.

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





























































































































































Responses

  • Filters for current user and only for open projects

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

















































































































































Retrieve all concept entries.

GET /data/concepts

Filters can be specified in the query string.

Responses

  • All concept entries

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