Retrieve all entries for given model.

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

PUT /auth/reset-password

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

Responses

200

Password reset
400

Invalid password Wrong or expired token Inactive user

PUT /auth/reset-password

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

Retrieve all shared assets used in project.

GET /data/projects/{project_id}/assets/shared-used

Jwt authorization

Path parameters

project_id Required

Responses

200

All shared assets used in project

GET /data/projects/{project_id}/assets/shared-used

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/assets/shared-used' \
 --header "Authorization: $API_KEY"

Retrieve all entity links related to given project.

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

Jwt authorization

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.

Path parameters

project_id Required

Query parameters

page
limit
cursor_created_at

Responses

200

All entity links related to given project

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

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/entity-links' \
 --header "Authorization: $API_KEY"

Get chat messages for an entity.

GET /data/entities/{entity_id}/chat/messages

Jwt authorization

Path parameters

entity_id Required

ID of the entity related to the chat

Responses

200

Chat messages

GET /data/entities/{entity_id}/chat/messages

curl \
 --request GET 'http://api.example.com/data/entities/a24a6ea4-ce75-4665-a070-57453082c25/chat/messages' \
 --header "Authorization: $API_KEY"

Add given files to the comment entry as attachments.

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

Jwt authorization

Path parameters

task_id Required
comment_id Required

Responses

201

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/a24a6ea4-ce75-4665-a070-57453082c25/comments/a24a6ea4-ce75-4665-a070-57453082c25/add-attachment' \
 --header "Authorization: $API_KEY"

Retrieve given concept.

GET /data/concepts/{concept_id}

Jwt authorization

Path parameters

concept_id Required

Responses

200

Given concept

GET /data/concepts/{concept_id}

curl \
 --request GET 'http://api.example.com/data/concepts/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve a model corresponding at given ID and return it as a JSON object.

GET /data/persons/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/persons/{instance_id}

curl \
 --request GET 'http://api.example.com/data/persons/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

GET /data/task-types

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

GET /data/task-types

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

Update a model with data given in the request body.

PUT /data/departments/{instance_id}

Jwt authorization

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

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/departments/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/departments/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Create a model with data given in the request body.

POST /data/softwares

Jwt authorization

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

Responses

200

Model created
400

Error

POST /data/softwares

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

Retrieve a model corresponding at given ID and return it as a JSON object.

GET /data/hardware-items/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/hardware-items/{instance_id}

curl \
 --request GET 'http://api.example.com/data/hardware-items/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/hardware-items/{instance_id}

Jwt authorization

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

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/hardware-items/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/hardware-items/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Create a model with data given in the request body.

POST /data/working-files

Jwt authorization

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

Responses

200

Model created
400

Error

POST /data/working-files

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

Create a model with data given in the request body.

POST /data/attachment-files

Jwt authorization

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

Responses

200

Model created
400

Error

POST /data/attachment-files

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

Update a model with data given in the request body.

PUT /data/status-automations/{instance_id}

Jwt authorization

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

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/status-automations/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/status-automations/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Create a model with data given in the request body.

POST /data/search-filters/

Jwt authorization

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

Responses

200

Model created
400

Error

POST /data/search-filters/

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

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/schedule-items/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/schedule-items/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/schedule-items/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/news/

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

GET /data/news/

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

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/news/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/news/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/news/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve a model corresponding at given ID and return it as a JSON object.

GET /data/entity-links/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/entity-links/{instance_id}

curl \
 --request GET 'http://api.example.com/data/entity-links/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Create a model with data given in the request body.

POST /data/chats/

Jwt authorization

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

Responses

200

Model created
400

Error

POST /data/chats/

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

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/chats/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/chats/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/chats/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve a model corresponding at given ID and return it as a JSON object.

GET /data/chat-messages/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/chat-messages/{instance_id}

curl \
 --request GET 'http://api.example.com/data/chat-messages/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/preview-background-files/{instance_id}

Jwt authorization

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

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/preview-background-files/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/preview-background-files/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve a model corresponding at given ID and return it as a JSON object.

GET /data/production-schedule-versions/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/production-schedule-versions/{instance_id}

curl \
 --request GET 'http://api.example.com/data/production-schedule-versions/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete given edit.

DELETE /data/edits/{edit_id}

Jwt authorization

Path parameters

edit_id Required

Responses

204

Given edit deleted

DELETE /data/edits/{edit_id}

curl \
 --request DELETE 'http://api.example.com/data/edits/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all tasks related to a given episode.

GET /data/episodes/{episode_id}/edit-tasks

Jwt authorization

Path parameters

episode_id Required

Responses

200

All tasks related to given episode

GET /data/episodes/{episode_id}/edit-tasks

curl \
 --request GET 'http://api.example.com/data/episodes/a24a6ea4-ce75-4665-a070-57453082c25/edit-tasks' \
 --header "Authorization: $API_KEY"

Export assets linked to a given project as csv.

GET /export/csv/projects/{project_id}/assets.csv

Jwt authorization

Path parameters

project_id Required

Responses

200

Assets exported as csv

GET /export/csv/projects/{project_id}/assets.csv

curl \
 --request GET 'http://api.example.com/export/csv/projects/a24a6ea4-ce75-4665-a070-57453082c25/assets.csv' \
 --header "Authorization: $API_KEY"

Return last working files revision for each file name for given task.

GET /data/tasks/{task_id}/working-files/last-revisions

Jwt authorization

Path parameters

task_id Required

Responses

200

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/a24a6ea4-ce75-4665-a070-57453082c25/working-files/last-revisions' \
 --header "Authorization: $API_KEY"

Update comment on given working file.

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

Jwt authorization

Path parameters

working_file_id Required

Responses

200

Comment updated on given working file

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

curl \
 --request PUT 'http://api.example.com/actions/working-files/a24a6ea4-ce75-4665-a070-57453082c25/comment' \
 --header "Authorization: $API_KEY"

Import remove instance.

POST /import/shotgun/remove/person

Jwt authorization

Responses

204

Instance removed

POST /import/shotgun/remove/person

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

Import remove instance.

POST /import/shotgun/remove/sequence

Jwt authorization

Responses

204

Instance removed

POST /import/shotgun/remove/sequence

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

Import remove instance.

POST /import/shotgun/remove/projectconnection

Jwt authorization

Responses

204

Instance removed

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/note

Jwt authorization

Responses

204

Instance removed

POST /import/shotgun/remove/note

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

Import project casting links via a .csv file.

POST /import/csv/projects/{project_id}/casting

Jwt authorization

Path parameters

project_id Required

Responses

201

The lists of imported casting links.
400

The .csv file is not properly formatted.

POST /import/csv/projects/{project_id}/casting

curl \
 --request POST 'http://api.example.com/import/csv/projects/a24a6ea4-ce75-4665-a070-57453082c25/casting' \
 --header "Authorization: $API_KEY"

Get day off object for given person and date.

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

Jwt authorization

Path parameters

person_id Required
date Required

Responses

200

Day off object for given person and date
404

Wrong date format

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

curl \
 --request GET 'http://api.example.com/data/persons/a24a6ea4-ce75-4665-a070-57453082c25/day-offs/2022-07-12' \
 --header "Authorization: $API_KEY"

Get ended shots used for quota calculation of this week.

GET /data/persons/{person_id}/quota-shots/week/{year}/{week}

Jwt authorization

Path parameters

person_id Required
year Required
week Required

Query parameters

count_mode Required

Responses

200

Ended shots used for quota calculation of this week
404

Wrong date format

GET /data/persons/{person_id}/quota-shots/week/{year}/{week}

curl \
 --request GET 'http://api.example.com/data/persons/a24a6ea4-ce75-4665-a070-57453082c25/quota-shots/week/2022/35?count_mode=weighted' \
 --header "Authorization: $API_KEY"

Retrieve build job related to given playlist.

GET /data/playlists/{playlist_id}/jobs/{build_job_id}

Jwt authorization

Path parameters

playlist_id Required
build_job_id Required

Responses

200

Build job related to given playlist

GET /data/playlists/{playlist_id}/jobs/{build_job_id}

curl \
 --request GET 'http://api.example.com/data/playlists/a24a6ea4-ce75-4665-a070-57453082c25/jobs/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Download the thumbnail representing given attachment file.

GET /pictures/thumbnails/attachment-files/{attachment_file_id}.png

Jwt authorization

Path parameters

attachment_file_id Required

Responses

200

Thumbnail downloaded
403

Instance not allowed
404

Picture file not found

GET /pictures/thumbnails/attachment-files/{attachment_file_id}.png

curl \
 --request GET 'http://api.example.com/pictures/thumbnails/attachment-files/a24a6ea4-ce75-4665-a070-57453082c25.png' \
 --header "Authorization: $API_KEY"

Download a thumbnail.

GET /movies/tiles/preview-files/{instance_id}.png

Jwt authorization

Path parameters

instance_id Required

Responses

200

Thumbnail downloaded
403

Instance not allowed
404

Picture file not found

GET /movies/tiles/preview-files/{instance_id}.png

curl \
 --request GET 'http://api.example.com/movies/tiles/preview-files/a24a6ea4-ce75-4665-a070-57453082c25.png' \
 --header "Authorization: $API_KEY"

Download the thumbnail linked to given object instance.

GET /pictures/thumbnails/organisations/{instance_id}.png

Jwt authorization

Path parameters

instance_id Required

Responses

200

Thumbnail downloaded
403

Access not allowed
404

Object instance not found

GET /pictures/thumbnails/organisations/{instance_id}.png

curl \
 --request GET 'http://api.example.com/pictures/thumbnails/organisations/a24a6ea4-ce75-4665-a070-57453082c25.png' \
 --header "Authorization: $API_KEY"

Return all projects listed in database.

GET /data/projects/all

Jwt authorization

Ensure that user has at least the manager level before that.

Responses

200

All projects listed in database

GET /data/projects/all

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

Add a preview background file linked to a production.

POST /data/projects/{project_id}/settings/preview-background-files

Jwt authorization

Path parameters

project_id Required

Responses

201

Preview background file added to production

POST /data/projects/{project_id}/settings/preview-background-files

curl \
 --request POST 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/settings/preview-background-files' \
 --header "Authorization: $API_KEY"

Create a shot for given project.

POST /data/projects/{project_id}/shots

Jwt authorization

Path parameters

project_id Required

application/json

Body Required

name string Required
description string
sequence_id string(uuid)
nb_frames integer

Responses

201

Shot created for given project

POST /data/projects/{project_id}/shots

curl \
 --request POST 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/shots' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"name":"Name of shot","description":"Description of shot","sequence_id":"a24a6ea4-ce75-4665-a070-57453082c25","nb_frames":24}'

Request examples

{
  "name": "Name of shot",
  "description": "Description of shot",
  "sequence_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "nb_frames": 24
}

Delete tasks matching id list given in parameter.

POST /actions/projects/{project_id}/delete-tasks

Jwt authorization

See it as a way to batch delete tasks.

Path parameters

project_id string Required

Responses

200

Tasks matching id list given in parameter deleted

POST /actions/projects/{project_id}/delete-tasks

curl \
 --request POST 'http://api.example.com/actions/projects/a24a6ea4-ce75-4665-a070-57453082c25/delete-tasks' \
 --header "Authorization: $API_KEY"

Return tasks related to given scene for current user.

GET /data/user/scenes/{scene_id}/tasks

Jwt authorization

Path parameters

scene_id string(uuid) Required

Responses

200 application/json

Tasks related to given scene
404

Scene not found

GET /data/user/scenes/{scene_id}/tasks

curl \
 --request GET 'http://api.example.com/data/user/scenes/a24a6ea4-ce75-4665-a070-57453082c25/tasks' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {}
]

Create a subscription entry for given task and current user. When a user

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

Jwt authorization

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

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

curl \
 --request POST 'http://api.example.com/actions/user/tasks/a24a6ea4-ce75-4665-a070-57453082c25/subscribe' \
 --header "Authorization: $API_KEY"

Response examples (201)

{}