Responses

  • OTP by email disabled.

  • Invalid password. Wrong or expired token. Inactive user. Wrong 2FA.

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
























Responses

  • Redirect to the SAML IDP.

  • Wrong parameter.

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

































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




















Retrieve all scene asset instances linked to asset.

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

Responses

  • All scene asset instances linked to 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"




Create an asset instance inside given asset.

POST /data/assets/{asset_id}/asset-asset-instances

Path parameters

Responses

  • Asset instance created inside given asset

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












































Resource to allow the modification of assets linked to an entity.

PUT /data/projects/{project_id}/entities/{entity_id}/casting

Responses

  • Modification of assets linked to an entity

PUT /data/projects/{project_id}/entities/{entity_id}/casting
curl \
 --request PUT http://api.example.com/data/projects/{project_id}/entities/{entity_id}/casting \
 --header "Authorization: $API_KEY"
















Resource to retrieve the casting of shots from all sequences of given

GET /data/projects/{project_id}/sequences/all/casting

project.

Responses

  • Casting for all shots from given project.

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
















Responses

  • All camera instances linked to scene

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








Remove an asset instance from given shot.

DELETE /data/shots/{shot_id}/asset-instances/{asset_instance_id}

Responses

  • Asset instance removed from given shot

DELETE /data/shots/{shot_id}/asset-instances/{asset_instance_id}
curl \
 --request DELETE http://api.example.com/data/shots/{shot_id}/asset-instances/{asset_instance_id} \
 --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

Responses

  • 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"




























































Retrieve all entries for given model.

GET /data/projects

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"












Responses

  • Model deleted

  • Statement or integrity error

  • Instance non-existant

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












Update a model with data given in the request body.

PUT /data/project-status/{instance_id}

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

Responses

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








































































































Update a model with data given in the request body.

PUT /data/departments/{instance_id}

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

Responses

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












































Retrieve all entries for given model.

GET /data/softwares

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"

Create a model with data given in the request body.

POST /data/softwares

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

Responses

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
















































































































































Responses

  • Model deleted

  • Statement or integrity error

  • Instance non-existant

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
































Update a model with data given in the request body.

PUT /data/custom-actions/{instance_id}

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

Responses

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








































Retrieve all entries for given model.

GET /data/playlists/

Filters can be specified in the query string.

Responses

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








Update a model with data given in the request body.

PUT /data/playlists/{instance_id}

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

Responses

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




































































































Responses

  • Model deleted

  • Statement or integrity error

  • Instance non-existant

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

Retrieve all entries for given model.

GET /data/news/

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"

Create a model with data given in the request body.

POST /data/news/

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

Responses

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




























Responses

  • Model deleted

  • Statement or integrity error

  • Instance non-existant

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








































Retrieve all entries for given model.

GET /data/entity-links/

Filters can be specified in the query string.

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








































































Responses

  • Model deleted

  • Statement or integrity error

  • 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"




























































































































































































































Download a working file.

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

Responses

  • 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"




Define a template file to use for given project.

POST /actions/projects/{project_id}/set-file-tree

Template files are located on the server side. Each template has a name which means that you just have to give a name to "select" the template to link with the project.

Path parameters

Responses

  • Template file defined

  • Selected tree not available

POST /actions/projects/{project_id}/set-file-tree
curl \
 --request POST http://api.example.com/actions/projects/{project_id}/set-file-tree \
 --header "Authorization: $API_KEY"

























































































































Import remove instance.

POST /import/shotgun/remove/version

Responses

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




























Import an OTIO file to enter frame_in / frame_out / nb_frames (it can

POST /import/otio/projects/{project_id}

be every adapter supported by OpenTimelineIO, for example: EDL, OTIO...
).

Path parameters

Responses

  • .

  • The .otio file is not properly formatted.

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

































































Retrieve a single given news related to a given project

GET /data/projects/{project_id}/news/{news_id}

Responses

  • Single given news related to given project

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