Authentication

Allow a user to register himself to the service.

POST /auth/register
Jwt authorization

Responses

  • 201

    Registration successful

  • 400

    Invalid password or email

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

Retrieve all shot asset instances linked to given asset.

GET /data/assets/{asset_id}/shot-asset-instances
Jwt authorization

Path parameters

  • asset_id Required

Responses

  • 200

    All shot asset instances linked to given asset

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

Share or unshare all assets (or a list of assets) for given project.

POST /actions/projects/{project_id}/assets/share
Jwt authorization

Path parameters

  • project_id Required

Responses

  • 201

    All assets modified.

POST /actions/projects/{project_id}/assets/share 
curl \
 --request POST 'http://api.example.com/actions/projects/{project_id}/assets/share' \
 --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

  • 200

    Model created

  • 400

    Error

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

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

GET /data/status-automations/{instance_id}
Jwt authorization

Path parameters

  • instance_id Required

Responses

  • 200

    Model as a JSON object

  • 400

    Statement error

  • 404

    Value error

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

Path parameters

  • instance_id Required

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 all entries for given model.

GET /data/chat-messages/
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/chat-messages/ 
curl \
 --request GET 'http://api.example.com/data/chat-messages/' \
 --header "Authorization: $API_KEY"

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

DELETE /data/preview-background-files/{instance_id}
Jwt authorization

Path parameters

  • instance_id Required

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

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

  • 200

    Model created

  • 400

    Error

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

Path parameters

  • instance_id Required

Responses

  • 200

    Model as a JSON object

  • 400

    Statement error

  • 404

    Value error

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

Retrieve all edits related to a given project.

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

Path parameters

  • project_id Required

Responses

  • 200

    All edits related to given project

GET /data/projects/{project_id}/edits 
curl \
 --request GET '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

Path parameters

  • entity_id Required

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 all output files for given poject.

GET /data/projects/{project_id}/output-files
Jwt authorization

Path parameters

  • project_id Required

Query parameters

  • output_type_id Required
  • task_type_id Required
  • file_status_id Required
  • representation Required

Responses

  • 200

    All output files for given project.

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

Import shotgun resource.

POST /import/shotgun/sequences
Jwt authorization

Responses

  • 200

    Resource imported

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

Import remove instance.

POST /import/shotgun/remove/project
Jwt authorization

Responses

  • 204

    Instance removed

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

Index

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"

Get basic configuration for the current instance.

GET /config
Jwt authorization

Responses

  • 200

    Configuration object including self-hosted status, Crisp token, indexer configuration, SAML status, and dark theme status.

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

Retrieve all news related to a given project

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

Path parameters

  • project_id Required

Query parameters

  • before
  • after
  • page
  • limit
  • person_id
  • task_type_id
  • task_status_id
  • episode_id
  • only_preview

Responses

  • 200

    All news related to given project

GET /data/projects/{project_id}/news 
curl \
 --request GET 'http://api.example.com/data/projects/{project_id}/news' \
 --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/{person_id}/day-offs/{date}' \
 --header "Authorization: $API_KEY"

Return all day offs recorded for given and person.

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

Path parameters

  • person_id Required

Responses

  • 200

    All day off recorded for given person.

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

Download given playlist build as .mp4.

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

Path parameters

  • playlist_id Required
  • build_job_id Required

Responses

  • 200

    Given playlist build downloaded as .mp4

  • 400

    Build not finished, need to retry later

GET /data/playlists/{playlist_id}/jobs/{build_job_id}/build/mp4 
curl \
 --request GET 'http://api.example.com/data/playlists/{playlist_id}/jobs/{build_job_id}/build/mp4' \
 --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/{instance_id}.png' \
 --header "Authorization: $API_KEY"

Retrieve all task types related to a given scene.

GET /data/scenes/{scene_id}/task-types
Jwt authorization

Path parameters

  • scene_id Required

Responses

  • 200

    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"

Return a task with many information.

GET /data/tasks/{task_id}/full
Jwt authorization

Full details for assignees, full details for task type, full details for task status, etc.

Path parameters

  • task_id Required

Responses

  • 200

    Task with many information

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

Return task types related to given asset for current user.

GET /data/user/assets/{asset_id}/task-types
Jwt authorization

Path parameters

  • asset_id Required

Responses

  • 200

    Task types related to given asset for current user

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

Mark all notifications as read for the current user.

POST /actions/user/notifications/mark-all-as-read
Jwt authorization

Responses

  • 200

    All notifications marked as read

POST /actions/user/notifications/mark-all-as-read 
curl \
 --request POST 'http://api.example.com/actions/user/notifications/mark-all-as-read' \
 --header "Authorization: $API_KEY"

Delete chat message.

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

Path parameters

  • entity_id Required

    ID of the entity related to the chat

  • chat_message_id Required

    ID of the chat message

Responses

  • 204

    Empty response

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

Retrieve all concepts related to a given project.

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

Path parameters

  • project_id Required

Responses

  • 200

    All concepts related to given project

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