Resource to allow a user to pre-enable TOTP.

PUT /auth/totp
Jwt authorization

Responses

  • 200

    TOTP enabled

  • 400

    Invalid password Wrong or expired token Inactive user

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

Resource to allow a user to login with SAML SSO.

GET /auth/saml/login
Jwt authorization

Responses

  • 302

    Redirect to the SAML IDP.

  • 400

    Wrong parameter.

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

Retrieve all entities that are not shot, sequence, episode, or edit.

GET /data/assets/with-tasks
Jwt authorization

Adds project name and asset type name and all related tasks.
If episode_id is given as parameter, it returns assets not linked
to an episode and assets linked to given episode.

Responses

  • 200

    All assets with tasks

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

Delete given asset.

DELETE /data/assets/{asset_id}
Jwt authorization

Responses

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

Create new asset with given parameters.

POST /data/projects/{project_id}/asset-types/{asset_type_id}/assets/new
Jwt authorization

Path parameters

Responses

  • 201

    New asset resource created

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

Resource to retrieve the casting of a given entity.

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

Responses

  • 200

    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"

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.

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

Retrieve all entries for given model.

GET /data/task-types
Jwt authorization

Filters can be specified in the query string.

Responses

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

Retrieve all entries for given model.

GET /data/departments
Jwt authorization

Filters can be specified in the query string.

Responses

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

Retrieve all entries for given model.

GET /data/file-status/
Jwt authorization

Filters can be specified in the query string.

Responses

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

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

GET /data/preview-files/{instance_id}
Jwt authorization

Responses

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

Retrieve a working file corresponding at given ID and return it as a

GET /data/working-files/{instance_id}
Jwt authorization

JSON object.

Responses

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

Update a model with data given in the request body.

PUT /data/comments/{instance_id}
Jwt authorization

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

Responses

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

Update a model with data given in the request body.

PUT /data/asset-instances/{instance_id}
Jwt authorization

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/playlists/
Jwt authorization

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

Responses

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

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

DELETE /data/events/{instance_id}
Jwt authorization

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

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

Retrieve all entries for given model.

GET /data/news/
Jwt authorization

Filters can be specified in the query string.

Responses

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/metadata-descriptors/{instance_id}
Jwt authorization

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    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"

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

GET /data/subscriptions/{instance_id}
Jwt authorization

Responses

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/entity-links/
Jwt authorization

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"

Retrieve all entries for given model.

GET /data/studios
Jwt authorization

Filters can be specified in the query string.

Responses

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

Retrieve given edit.

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

Export assets linked to a given project as csv.

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

Responses

  • 200

    Assets exported as csv

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

Export casting linked to a given project as csv.

GET /export/csv/projects/{project_id}/casting.csv
Jwt authorization

Responses

  • 200

    Casting exported as csv

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

Export as csv.

GET /export/csv/tasks.csv
Jwt authorization

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
Jwt authorization

Path parameters

Responses

  • 200

    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"

Get all output files for given entity and given output type.

GET /data/entities/{entity_id}/output-types/{output_type_id}/output-files
Jwt authorization

Responses

  • 200

    All output files for given entity and given output type

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

Update working file modification date with current date.

PUT /actions/working-files/{working_file_id}/modified
Jwt authorization

Responses

  • 200

    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"

Import shotgun resource.

POST /import/shotgun/scenes
Jwt authorization

Responses

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

Import shotgun resource.

POST /import/shotgun/tasks
Jwt authorization

Responses

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

Import persons via a .csv file.

POST /import/csv/persons
Jwt authorization

Responses

  • 201

    The lists of imported persons.

  • 400

    The .csv file is not properly formatted.

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

Import project shots via a .csv file.

POST /import/csv/projects/{project_id}/shots
Jwt authorization

Path parameters

Responses

  • 201

    The lists of imported assets.

  • 400

    The .csv file is not properly formatted.

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

Import Kitsu resource.

POST /import/kitsu/entities
Jwt authorization

Responses

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

News

Get ended shots used for quota calculation of this month.

GET /data/persons/{person_id}/quota-shots/month/{year}/{month}
Jwt authorization

Responses

  • 200

    Ended shots used for quota calculation of this month

  • 404

    Wrong date format

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

Allow admin to disable two factor authentication for given user.

DELETE /actions/persons/{person_id}/disable-two-factor-authentication
Jwt authorization

Prior to disable two factor authentication, it requires to be admin. An admin can't disable two factor authentication for other admins.

Responses

  • 200

    Two factor authentication disabled

  • 400

    Inactive user

DELETE /actions/persons/{person_id}/disable-two-factor-authentication 
curl \
 --request DELETE 'http://api.example.com/actions/persons/{person_id}/disable-two-factor-authentication' \
 --header "Authorization: $API_KEY"

Retrieve all playlists related to given project.

GET /data/projects/{project_id}/playlists/all
Jwt authorization

It's mainly used for synchronisation purpose.

Responses

  • 200

    All playlists related to given project

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

Retrieve all playlists related to given project.

GET /data/projects/{project_id}/playlists/{playlist_id}
Jwt authorization

Responses

  • 200

    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"

Retrieve build job related to given playlist.

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

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/{playlist_id}/jobs/{build_job_id}' \
 --header "Authorization: $API_KEY"

Remove given build job related to given playlist.

DELETE /data/playlists/{playlist_id}/jobs/{build_job_id}
Jwt authorization

Responses

  • 204

    Given build job removed

DELETE /data/playlists/{playlist_id}/jobs/{build_job_id} 
curl \
 --request DELETE 'http://api.example.com/data/playlists/{playlist_id}/jobs/{build_job_id}' \
 --header "Authorization: $API_KEY"

Retrieve all preview files from open productions with states equals to processing or broken.

GET /data/playlists/preview-files/running
Jwt authorization

Responses

  • 200

    All preview files from open productions with states equals to processing or broken

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

Create a thumbnail for given object instance.

POST /pictures/thumbnails/organisations/{instance_id}.png
Jwt authorization

Path parameters

Responses

  • 200

    Thumbnail created

  • 404

    Cannot found related object.

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

Return preview background files linked to a production

GET /data/projects/{project_id}/settings/preview-background-files
Jwt authorization

Responses

  • 200

    Preview background files linked to production

GET /data/projects/{project_id}/settings/preview-background-files 
curl \
 --request GET 'http://api.example.com/data/projects/{project_id}/settings/preview-background-files' \
 --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

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/{project_id}/settings/preview-background-files' \
 --header "Authorization: $API_KEY"

Retrieve budgets for given production

GET /data/projects/{project_id}/budgets
Jwt authorization

Responses

  • 200

    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"

Retrieve all assets for a given shot.

GET /data/shots/{shot_id}/assets
Jwt authorization

Responses

  • 200

    All assets for given shot

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

Retrieve all task types related to a given shot.

GET /data/sequences/{sequence_id}/task-types
Jwt authorization

Responses

  • 200

    All task types related to given shot

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

Retrieve number of tasks by status, task_types and episodes for given project.

GET /data/projects/{project_id}/episodes/retake-stats
Jwt authorization

Responses

  • 200

    Number of tasks by status, task types and episodes for given project

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

Tasks

Return tasks related to given sequence for current user.

GET /data/user/sequences/{sequence_id}/tasks
Jwt authorization

Responses

  • 200

    Tasks related to given sequence

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

Return scenes related to given sequence if the current user has access

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

to it.

Responses

  • 200

    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"

Return chats where user is participant.

GET /data/user/chats
Jwt authorization

Responses

  • 200

    Chats where user is participant

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

Set `has_avatar` flag to False for current user and remove its avatar

DELETE /actions/user/clear-avatar
Jwt authorization

file.

Responses

  • 204

    Avatar file deleted

DELETE /actions/user/clear-avatar 
curl \
 --request DELETE 'http://api.example.com/actions/user/clear-avatar' \
 --header "Authorization: $API_KEY"