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





























































































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





























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"





















































































Update a model with data given in the request body.

PUT /data/project-status/{instance_id}

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

Responses

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

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"
















































Delete a preview file corresponding at given ID and retuns

DELETE /data/preview-files/{instance_id}

a 204 status code.

Responses

  • Model deleted

  • Statement or integrity error

  • Instance non-existant

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












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

Update a model with data given in the request body.

PUT /data/search-filter-groups/{instance_id}

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

Responses

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




Retrieve all entries for given model.

GET /data/schedule-items/

Filters can be specified in the query string.

Responses

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




















Create a model with data given in the request body.

POST /data/news/

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

Responses

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




















Update a model with data given in the request body.

PUT /data/chats/{instance_id}

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

Responses

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








































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








Responses

  • All task types related to given edit

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

































Responses

  • All preview files linked to given entity

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









































































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













































Import shotgun resource.

POST /import/shotgun/sequences

Responses

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
























Responses

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




















Import remove instance.

POST /import/shotgun/remove/project

Responses

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




































Import remove instance.

POST /import/shotgun/remove/task

Responses

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




































Import an OTIO file to enter frame_in / frame_out / nb_frames (it can

POST /import/otio/projects/{project_id}

be every adapter supported by OpenTimelineIO, for example: EDL, OTIO...
).

Path parameters

Responses

  • .

  • The .otio file is not properly formatted.

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

















































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






















































































Return all day off recorded for given week and person.

GET /data/persons/{person_id}/day-offs/week/{year}/{week}

Responses

  • All day off recorded for given week and person

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









































Download a movie preview.

GET /movies/originals/preview-files/{instance_id}.mp4

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.

Responses

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

Download a movie preview.

GET /movies/originals/preview-files/{instance_id}/download

Responses

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
























































































Create a thumbnail for given object instance.

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

Path parameters

Responses

  • Thumbnail created

  • Cannot found related object.

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

















































Remove an asset type from a production.

DELETE /data/projects/{project_id}/settings/asset-types/{asset_type_id}

Responses

DELETE /data/projects/{project_id}/settings/asset-types/{asset_type_id}
curl \
 --request DELETE 'http://api.example.com/data/projects/{project_id}/settings/asset-types/{asset_type_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 task type linked to a production.

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

Path parameters

Responses

  • Task type added to production

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


































































































































































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"
















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"

Responses

  • All shots related to given episode

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








Responses

  • All task types related to given episode

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
















































Create a shot for given project.

POST /data/projects/{project_id}/shots

Path parameters

Responses

  • Shot created for given project

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




































Retrieve quotas statistics for shots.

GET /data/projects/{project_id}/quotas/persons/{person_id}

Responses

  • Quotas statistics for shots

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












































Retrieve all subcriptions to tasks related to given project.

GET /data/projects/{project_id}/subscriptions

It's mainly used for synchronisation purpose.

Responses

  • All subcriptions to tasks related to given project

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
























Assign given task lists to given person.

PUT /actions/persons/{person_id}/assign

If a given task ID is wrong, it ignores it.

Responses

  • Given tasks lists assigned to given person

PUT /actions/persons/{person_id}/assign
curl \
 --request PUT 'http://api.example.com/actions/persons/{person_id}/assign' \
 --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"
































Create a new task for given edit and task type.

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

Path parameters

Responses

  • New task for given edit and task type created

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





































Responses

  • Tasks related to given shot for current user

GET /data/user/shots/{shot_id}/task-types
curl \
 --request GET 'http://api.example.com/data/user/shots/{shot_id}/task-types' \
 --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 scenes related to given sequence if the current user has access

GET /data/user/sequences/{sequence_id}/scenes

to it.

Responses

  • Scenes related to given sequence

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