Resource to allow a user to enable OTP by email.

POST /auth/email-otp

Responses

  • 200

    OTP by email enabled

  • 400

    Invalid password Wrong or expired token Inactive user

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





































Retrieve given asset type.

GET /data/asset-types/{asset_type_id}

Path parameters

  • asset_type_id Required

Responses

  • 200

    Given asset type

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




















Retrieve all assets linked to given asset.

GET /data/assets/{asset_id}/assets

Path parameters

  • asset_id Required

Responses

  • 200

    All assets linked to given asset

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

















































































































Retrieve all asset instances linked to scene.

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

Path parameters

  • scene_id Required

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"

































































Creates new comments for given task. Each comments requires a task_id,

POST /actions/tasks/batch-comment

text, a task_status and a person as arguments.

Responses

  • 201

    New comments created

POST /actions/tasks/batch-comment
curl \
 --request POST 'http://api.example.com/actions/tasks/batch-comment' \
 --header "Authorization: $API_KEY"









































Create a model with data given in the request body.

POST /data/project-status

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

Responses

  • 200

    Model created

  • 400

    Error

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












































































































































































































Create a model with data given in the request body.

POST /data/output-types

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

Responses

  • 200

    Model created

  • 400

    Error

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




















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

GET /data/preview-files/{instance_id}

Path parameters

  • instance_id Required

Responses

  • 200

    Model as a JSON object

  • 400

    Statement error

  • 404

    Value error

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




































































































































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

GET /data/status-automations/{instance_id}

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/news/{instance_id}

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

Retrieve all entries for given model.

GET /data/milestones/

Filters can be specified in the query string.

Responses

  • 200

    All entries for given model

  • 400

    Format error

  • 403

    Permission denied

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




































































































Create a model with data given in the request body.

POST /data/chat-messages/

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

Responses

  • 200

    Model created

  • 400

    Error

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








































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

GET /data/studios/{instance_id}

Path parameters

  • instance_id Required

Responses

  • 200

    Model as a JSON object

  • 400

    Statement error

  • 404

    Value error

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





































































Retrieve all task types related to a given edit.

GET /data/edits/{edit_id}/task-types

Path parameters

  • edit_id Required

Responses

  • 200

    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"










































Retrieve last events.

GET /data/events/last

Query parameters

  • after
  • before
  • only_files
  • limit
  • project_id

Responses

  • 200

    All login logs

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









































Export as csv.

GET /export/csv/task-types.csv

Responses

  • 200

    Exported as csv

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

Files

























































































Store a working file.

POST /data/working-files/{working_file_id}/file

Path parameters

  • working_file_id Required

Responses

  • 201

    Working file stored

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





















































Import shotgun resource.

POST /import/shotgun/versions

Responses

  • 200

    Resource imported

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








Serialize shotgun error resource.

POST /import/shotgun/errors

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

Responses

  • 204

    Instance removed

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































































































































































Get aggregated time spents for given person and week.

GET /data/persons/{person_id}/time-spents/week/{year}/{week}

Path parameters

  • person_id Required
  • year Required
  • week Required

Responses

  • 200

    Aggregated time spents for given person and week

  • 404

    Wrong date format

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
















Return a table giving time spent by user and by month for given year.

GET /data/persons/time-spents/year-table/

Responses

  • 200

    Table giving time spent by user and by month for given year

GET /data/persons/time-spents/year-table/
curl \
 --request GET 'http://api.example.com/data/persons/time-spents/year-table/' \
 --header "Authorization: $API_KEY"












Return all day off recorded for given month.

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

Path parameters

  • year Required
  • month Required

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"













































Retrieve all playlists related to given episode.

GET /data/projects/{project_id}/episodes/{episode_id}/playlists

The full list is returned because the number of playlists in an episode is not that big.

Path parameters

  • project_id Required
  • episode_id Required

Responses

  • 200

    All playlists related to given episode

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




































Previews

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

GET /data/playlists/preview-files/running

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"

























































































































































































Remove a status automation from a production.

DELETE /data/projects/{project_id}/settings/status-automations/{status_automation_id}

Path parameters

  • project_id Required
  • status_automation_id Required

Responses

  • 204

    Empty response

DELETE /data/projects/{project_id}/settings/status-automations/{status_automation_id}
curl \
 --request DELETE 'http://api.example.com/data/projects/{project_id}/settings/status-automations/{status_automation_id}' \
 --header "Authorization: $API_KEY"




























Delete a metadata descriptor.

DELETE /data/projects/{project_id}/metadata-descriptors/{descriptor_id}

Descriptors serve to describe extra fields listed in the data attribute of entities.

Path parameters

  • project_id Required
  • descriptor_id Required

Responses

  • 204

    Empty response

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

Retrieve milestones for given production

GET /data/projects/{project_id}/milestones

Path parameters

  • project_id Required

Responses

  • 200

    All milestones of given production

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














































































































































































Retrieve all tasks related to a given episode.

GET /data/episodes/{episode_id}/tasks

Path parameters

  • episode_id Required

Responses

  • 200

    All tasks related to given episode

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




















































Create a shot for given project.

POST /data/projects/{project_id}/shots

Path parameters

  • project_id Required

Responses

  • 201

    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 number of tasks by status, task_types and episodes for given project.

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

Path parameters

  • project_id Required

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"





























Delete a comment corresponding at given ID.

DELETE /data/tasks/{task_id}/comments/{comment_id}

Path parameters

  • task_id Required
  • comment_id Required

Responses

  • 204

    Comment corresponding at given ID deleted

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




















Return tasks related to given entity asset, episode, sequence, shot or scene.

GET /data/entities/{entity_id}/task-types/{task_type_id}/tasks

Path parameters

  • entity_id Required
  • task_type_id Required

Responses

  • 200

    Tasks related to given entity asset, episode, sequence, shot or scene

GET /data/entities/{entity_id}/task-types/{task_type_id}/tasks
curl \
 --request GET 'http://api.example.com/data/entities/{entity_id}/task-types/{task_type_id}/tasks' \
 --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}

Path parameters

  • task_id Required
  • date Required
  • person_id Required

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"

























































Return tasks related to given scene for current user.

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

Path parameters

  • scene_id Required

Responses

  • 200

    Tasks related to given scene

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
































































































Retrieve desktop login logs.

GET /data/user/desktop-login-logs

Responses

  • 200

    Desktop login logs

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