Resource to allow a user to enable TOTP.

POST /auth/totp

Responses

  • 200

    TOTP enabled

  • 400

    Invalid password Wrong or expired token Inactive user

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









































































































Retrieve all scene asset instances linked to given asset.

GET /data/assets/{asset_id}/scene-asset-instances

Path parameters

  • asset_id Required

Responses

  • 200

    All scene asset instances linked to given asset

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
























Retrieve all assets for given project.

GET /data/projects/{project_id}/assets

Path parameters

  • project_id Required

Responses

  • 200

    All assets for given project

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


















































































Acknowledge given comment.

POST /data/tasks/{task_id}/comments/{comment_id}/ack

If it's already acknowledged, remove acknowledgement.

Path parameters

  • task_id Required
  • comment_id Required

Responses

  • 200

    Comment acknowledged

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




















Return all attachment files related to given project.

GET /data/projects/{project_id}/attachment-files

Path parameters

  • project_id Required

Responses

  • 200

    All attachment files related to given project

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




Create a new comment for given task.

POST /actions/tasks/{task_id}/comment

It requires a text, a task_status and a person as arguments. This way, comments keep history of status changes. When the comment is created, it updates the task status with given task status.

Path parameters

  • task_id Required

Responses

  • 201

    New comment created

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












Crud





















































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

DELETE /data/project-status/{instance_id}

Path parameters

  • instance_id Required

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

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








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

GET /data/entity-types/{instance_id}

Path parameters

  • instance_id Required

Responses

  • 200

    Model as a JSON object

  • 400

    Statement error

  • 404

    Value error

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
























































































































Create a model with data given in the request body.

POST /data/file-status/

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

Responses

  • 200

    Model created

  • 400

    Error

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




Update a model with data given in the request body.

PUT /data/file-status/{instance_id}

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/file-status/{instance_id}
curl \
 --request PUT 'http://api.example.com/data/file-status/{instance_id}' \
 --header "Authorization: $API_KEY"
























































































Create a model with data given in the request body.

POST /data/working-files

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"












Retrieve all entries for given model.

GET /data/attachment-files

Filters can be specified in the query string.

Responses

  • 200

    All entries for given model

  • 400

    Format error

  • 403

    Permission denied

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












































































Create a model with data given in the request body.

POST /data/custom-actions/

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

Responses

  • 200

    Model created

  • 400

    Error

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




















































Create a model with data given in the request body.

POST /data/playlists/

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

Responses

  • 200

    Model created

  • 400

    Error

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
















































































































































Update a model with data given in the request body.

PUT /data/milestones/{instance_id}

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/milestones/{instance_id}
curl \
 --request PUT 'http://api.example.com/data/milestones/{instance_id}' \
 --header "Authorization: $API_KEY"
















Update a model with data given in the request body.

PUT /data/metadata-descriptors/{instance_id}

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/metadata-descriptors/{instance_id}
curl \
 --request PUT 'http://api.example.com/data/metadata-descriptors/{instance_id}' \
 --header "Authorization: $API_KEY"




























































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

DELETE /data/chats/{instance_id}

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

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"









































































































Retrieve all edits related to a given project.

GET /data/projects/{project_id}/edits

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"











































Export a given playlist as csv.

GET /export/csv/playlists/{playlist_id}

Path parameters

  • playlist_id Required

Responses

  • 200

    Playlist exported as csv

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




Export as csv.

GET /export/csv/projects.csv

Responses

  • 200

    Exported as csv

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

































Create new output file linked to assets through an instance of this asset for a given shot.

POST /data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-files/new

Some output files are linked to assets through an instance of this asset for a given shot. Each time a CG artist is satisfied by what he did on a working file, he can create an output file that will be linked to a target instance. It keeps track of the working file at the origin of the output file. An output type is required for better categorization (textures, caches, ...). A task type can be set too to give the department related to the output file.

Path parameters

  • asset_instance_id Required
  • temporal_entity_id Required

Responses

  • 200

    New output file created

  • 400

    Given output file already exists Given person not found Given output type not found

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




















Get all working files for a given entity and possibly a task and a name.

GET /data/entities/{entity_id}/working-files

Path parameters

  • entity_id Required

Responses

  • 200

    All working files for given entity and possibly a task and a name

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




































Download a working file.

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

Path parameters

  • working_file_id Required

Responses

  • 200

    Working file downloaded

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

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

Responses

  • 200

    Resource imported

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








Import shotgun error resource.

GET /import/shotgun/errors

Responses

  • 200

    Resource imported

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








Delete error.

DELETE /import/shotgun/errors/{error_id}

Path parameters

  • error_id Required

Responses

  • 204

    Error deleted

  • 404

    Error non-existant or Statement error

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












Import remove instance.

POST /import/shotgun/remove/scene

Responses

  • 204

    Instance removed

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
































Import remove instance.

POST /import/shotgun/remove/version

Responses

  • 204

    Instance removed

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




































Import Kitsu resource.

POST /import/kitsu/comments

Responses

  • 200

    Resource imported

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






















































Retrieve all news related to a given project

GET /data/projects/{project_id}/news

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"













Return a csv file containing the presence logs based on a daily basis.

GET /data/persons/presence-logs/{month_date}

Path parameters

  • month_date Required

Responses

  • 200

    CSV file containing the presence logs based on a daily basis

GET /data/persons/presence-logs/{month_date}
curl \
 --request GET 'http://api.example.com/data/persons/presence-logs/{month_date}' \
 --header "Authorization: $API_KEY"

































































































Retrieve all playlists related to given project.

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

It's mainly used for synchronisation purpose.

Path parameters

  • project_id Required

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}

Path parameters

  • project_id Required
  • playlist_id Required

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"


































































































































































































































Remove a preview background file from a production.

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

Path parameters

  • project_id Required
  • preview_background_file_id Required

Responses

  • 204

    Empty response

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"

Return preview background files linked to a production

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

Path parameters

  • project_id Required

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"
















Update a metadata descriptor.

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

  • 200

    Metadata descriptor updated

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
































Retrieve budgets for given production

GET /data/projects/{project_id}/budgets

Path parameters

  • project_id Required

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 data versions of given shot.

GET /data/shots/{shot_id}/versions

Path parameters

  • shot_id Required

Responses

  • 204

    Data versions of given shot

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