Authentication

Jwt authorization (http_api_key)

Format in header: Authorization: Bearer {token}.

Value example: Bearer xxxxx.yyyyy.zzzzz

Log user out by revoking his auth tokens.

GET /auth/logout
Jwt authorization

Once logged out, current user cannot access the API anymore.

Responses

  • 200

    Logout successful

  • 500

    Access token not found

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

Resource to allow a user to register a FIDO device.

POST /auth/fido
Jwt authorization

Responses

  • 200

    FIDO device registered.

  • 400

    Invalid password Wrong or expired token Inactive user

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

Resource to retrieve the casting of episodes.

GET /data/projects/{project_id}/episodes/casting
Jwt authorization

Responses

  • 200

    Casting of episodes

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

Delete given entity link.

DELETE /data/projects/{project_id}/entity-links/{entity_link_id}
Jwt authorization

It's mainly used for synchronisation purpose.

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

Retrieve all asset instances linked to scene.

GET /data/scenes/{scene_id}/asset-instances
Jwt authorization

Responses

  • 200

    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"

Retrieve all entries for given model.

GET /data/projects
Jwt authorization

Filters can be specified in the query string.

Responses

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

Create a model with data given in the request body.

POST /data/projects
Jwt authorization

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

Responses

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

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

DELETE /data/projects/{instance_id}
Jwt authorization

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

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

Create a model with data given in the request body.

POST /data/project-status
Jwt authorization

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

Responses

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

Retrieve all entries for given model.

GET /data/organisations
Jwt authorization

Filters can be specified in the query string.

Responses

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

Retrieve all entries for given model.

GET /data/softwares
Jwt authorization

Filters can be specified in the query string.

Responses

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

Update a model with data given in the request body.

PUT /data/softwares/{instance_id}
Jwt authorization

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

Responses

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

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

Retrieve all entries for given model.

GET /data/day-offs/
Jwt authorization

Filters can be specified in the query string.

Responses

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

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

GET /data/news/{instance_id}
Jwt authorization

Responses

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

Update a model with data given in the request body.

PUT /data/news/{instance_id}
Jwt authorization

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

Responses

PUT /data/news/{instance_id} 
curl \
 --request PUT 'http://api.example.com/data/news/{instance_id}' \
 --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
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/entity-links/{instance_id}
Jwt authorization

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

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

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

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/{instance_id}' \
 --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"

Create a model with data given in the request body.

POST /data/studios
Jwt authorization

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"

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

GET /data/salary-scales/{instance_id}
Jwt authorization

Responses

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

Retrieve all edits, adds project name and all related tasks.

GET /data/edits/with-tasks
Jwt authorization

Responses

  • 200

    All edits and all related tasks.

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

Delete given edit.

DELETE /data/edits/{edit_id}
Jwt authorization

Responses

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

Create an edit for given project.

POST /data/projects/{project_id}/edits
Jwt authorization

Path parameters

Responses

  • 201

    Edit created for given project

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

Retrieve all news linked to a given entity.

GET /data/entities/{entity_id}/news
Jwt authorization

Responses

  • 200

    All news linked to given entity

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

Get information about a file that could be a working file as much as an

GET /data/files/{file_id}
Jwt authorization

output file.

Responses

  • 200

    Information about file

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

Get last revisions of output files for given instance grouped by output type and file name.

GET /data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-files/last-revisions
Jwt authorization

Responses

  • 200

    Last revisions of output files for given instance grouped by output type and file name

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

Get all output files for given asset instance and given output type.

GET /data/asset-instances/{asset_instance_id}/output-files
Jwt authorization

Responses

  • 200

    All output files for given asset instance and given temporal entity (shot, sequence, etc.)

GET /data/asset-instances/{asset_instance_id}/output-files 
curl \
 --request GET 'http://api.example.com/data/asset-instances/{asset_instance_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/projects
Jwt authorization

Responses

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

Import shotgun resource.

POST /import/shotgun/episodes
Jwt authorization

Responses

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

Import shotgun error resource.

GET /import/shotgun/errors
Jwt authorization

Responses

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

Serialize shotgun error resource.

POST /import/shotgun/errors
Jwt authorization

Responses

  • 200

    Resource serialized

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

Import remove instance.

POST /import/shotgun/remove/note
Jwt authorization

Responses

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

Import Kitsu resource.

POST /import/kitsu/tasks
Jwt authorization

Responses

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

Retrieve status of database and time.

GET /status/influx
Jwt authorization

Responses

  • 200

    Status of database, key value, event stream, job queue and time

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

Persons

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"

Return all day off recorded for given month.

GET /data/persons/day-offs/{year}/{month}
Jwt authorization

Responses

  • 200

    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"

Return all day off recorded for given month and person.

GET /data/persons/{person_id}/day-offs/month/{year}/{month}
Jwt authorization

Responses

  • 200

    All day off recorded for given month and person

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

Playlists

Download given playlist as zip.

GET /data/playlists/{playlist_id}/download/zip
Jwt authorization

Responses

  • 200

    Given playlist downloaded as zip

GET /data/playlists/{playlist_id}/download/zip 
curl \
 --request GET 'http://api.example.com/data/playlists/{playlist_id}/download/zip' \
 --header "Authorization: $API_KEY"

Retrieve all playlists related to given project.

POST /data/projects/{project_id}/playlists/temp
Jwt authorization

It's mainly used for synchronisation purpose.

Path parameters

Responses

  • 200

    All playlists related to given project

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

Remove people listed in a production team.

DELETE /data/projects/{project_id}/team/{person_id}
Jwt authorization

Responses

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

Path parameters

Responses

  • 201

    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"

Remove a preview background file from a production.

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

Responses

DELETE /data/projects/{project_id}/settings/preview-background-files/{preview_background_file_id} 
curl \
 --request DELETE 'http://api.example.com/data/projects/{project_id}/settings/preview-background-files/{preview_background_file_id}' \
 --header "Authorization: $API_KEY"

Retrieve time spents for given production

GET /data/projects/{project_id}/time-spents
Jwt authorization

Responses

  • 200

    All time spents of given production

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

Update given shot.

PUT /data/shots/{shot_id}
Jwt authorization

Responses

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

Retrieve all previews related to a given shot.

GET /data/shots/{shot_id}/preview-files
Jwt authorization

It sends them as a dict. Keys are related task type ids and values are arrays of preview for this task type.

Responses

  • 200

    All previews related to given episode

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

Mark given scene as source of given shot.

POST /data/scenes/{scene_id}/shots
Jwt authorization

Path parameters

Responses

  • 200

    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"

Retrieve given episode.

GET /data/episodes/{episode_id}
Jwt authorization

Responses

GET /data/episodes/{episode_id} 
curl \
 --request GET 'http://api.example.com/data/episodes/{episode_id}' \
 --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 all episodes related to a given project.

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

Responses

  • 200

    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"

Retrieve quotas statistics for shots.

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

Responses

  • 200

    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 time spent by a person on a task for a given day.

POST /actions/tasks/{task_id}/time-spents/{date}/persons/{person_id}
Jwt authorization

Path parameters

Responses

  • 201

    Time spent by given person on given task for given day is set

  • 404

    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"

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

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

Responses

  • 201

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

  • 404

    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"

Add given timeframe to time spent by a person on a task for a given day.

POST /actions/tasks/{task_id}/time-spents/{date}/persons/{person_id}/add
Jwt authorization

Path parameters

Responses

  • 201

    Given timeframe added to time spent by given person on given task for given day

  • 404

    Wrong date format

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

Change a task status to "to review".

PUT /actions/tasks/{task_id}/to-review
Jwt authorization

It creates a new preview file entry and set path from the hard disk.

Responses

  • 200

    Task status changed to "to review"

  • 400

    Given person not found

PUT /actions/tasks/{task_id}/to-review 
curl \
 --request PUT 'http://api.example.com/actions/tasks/{task_id}/to-review' \
 --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"

Delete given filter if it's owned by current user.

DELETE /data/user/filters/{filter_id}
Jwt authorization

Responses

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

Retrieve filter groups for current user and only for open projects.

GET /data/user/filter-groups
Jwt authorization

Responses

  • 200

    Filter groups for current user and only for open projects

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

Create filter group for current user and only for open projects.

POST /data/user/filter-groups
Jwt authorization

Responses

  • 201

    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 desktop login log.

POST /data/user/desktop-login-logs
Jwt authorization

The desktop login log can only be created by the current user.

Responses

  • 201

    Desktop login log created

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

Return true if current user has subscribed to given sequence and

GET /data/user/entities/{sequence_id}/task-types/{task_type_id}/subscribed
Jwt authorization

task type.

Responses

  • 200

    True if current user has subscribed to given sequence and task type, False otherwise

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

Get chat message.

GET /data/entities/{entity_id}/chat/messages/{chat_message_id}
Jwt authorization

Path parameters

Responses

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

Entity