curl \
--request GET 'http://api.example.com/data/projects/{project_id}/sequences' \
--header "Authorization: $API_KEY"
Log in user by creating and registering auth tokens.
Login is based on email and password. If no user match given email and a destkop ID, it looks in matching the desktop ID with the one stored in database. It is useful for clients that run on desktop tools and that don't know user email.
POST
/auth/login
curl \
--request POST 'http://api.example.com/auth/login' \
--header "Authorization: $API_KEY"
GET
/auth/email-otp
curl \
--request GET 'http://api.example.com/auth/email-otp' \
--header "Authorization: $API_KEY"
GET
/auth/saml/login
curl \
--request GET 'http://api.example.com/auth/saml/login' \
--header "Authorization: $API_KEY"
GET
/data/assets/{asset_id}/casting
curl \
--request GET 'http://api.example.com/data/assets/{asset_id}/casting' \
--header "Authorization: $API_KEY"
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"
POST
/actions/assets/share
curl \
--request POST 'http://api.example.com/actions/assets/share' \
--header "Authorization: $API_KEY"
POST
/actions/projects/{project_id}/assets/share
curl \
--request POST 'http://api.example.com/actions/projects/{project_id}/assets/share' \
--header "Authorization: $API_KEY"
GET
/data/projects/{project_id}/assets/shared-used
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/assets/shared-used' \
--header "Authorization: $API_KEY"
GET
/data/persons
curl \
--request GET 'http://api.example.com/data/persons' \
--header "Authorization: $API_KEY"
POST
/data/task-types
curl \
--request POST 'http://api.example.com/data/task-types' \
--header "Authorization: $API_KEY"
POST
/data/task-status
curl \
--request POST 'http://api.example.com/data/task-status' \
--header "Authorization: $API_KEY"
GET
/data/tasks
curl \
--request GET 'http://api.example.com/data/tasks' \
--header "Authorization: $API_KEY"
GET
/data/tasks/{instance_id}
curl \
--request GET 'http://api.example.com/data/tasks/{instance_id}' \
--header "Authorization: $API_KEY"
GET
/data/file-status/
curl \
--request GET 'http://api.example.com/data/file-status/' \
--header "Authorization: $API_KEY"
POST
/data/file-status/
curl \
--request POST 'http://api.example.com/data/file-status/' \
--header "Authorization: $API_KEY"
PUT
/data/output-files/{instance_id}
curl \
--request PUT 'http://api.example.com/data/output-files/{instance_id}' \
--header "Authorization: $API_KEY"
DELETE
/data/output-files/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/output-files/{instance_id}' \
--header "Authorization: $API_KEY"
GET
/data/output-types/{instance_id}
curl \
--request GET 'http://api.example.com/data/output-types/{instance_id}' \
--header "Authorization: $API_KEY"
PUT
/data/comments/{instance_id}
curl \
--request PUT 'http://api.example.com/data/comments/{instance_id}' \
--header "Authorization: $API_KEY"
PUT
/data/time-spents/{instance_id}
curl \
--request PUT 'http://api.example.com/data/time-spents/{instance_id}' \
--header "Authorization: $API_KEY"
POST
/data/asset-instances/
curl \
--request POST 'http://api.example.com/data/asset-instances/' \
--header "Authorization: $API_KEY"
GET
/data/notifications/{instance_id}
curl \
--request GET 'http://api.example.com/data/notifications/{instance_id}' \
--header "Authorization: $API_KEY"
GET
/data/schedule-items/{instance_id}
curl \
--request GET 'http://api.example.com/data/schedule-items/{instance_id}' \
--header "Authorization: $API_KEY"
PUT
/data/schedule-items/{instance_id}
curl \
--request PUT 'http://api.example.com/data/schedule-items/{instance_id}' \
--header "Authorization: $API_KEY"
GET
/data/news/
curl \
--request GET 'http://api.example.com/data/news/' \
--header "Authorization: $API_KEY"
PUT
/data/news/{instance_id}
curl \
--request PUT 'http://api.example.com/data/news/{instance_id}' \
--header "Authorization: $API_KEY"
POST
/data/milestones/
curl \
--request POST 'http://api.example.com/data/milestones/' \
--header "Authorization: $API_KEY"
POST
/data/chat-messages/
curl \
--request POST 'http://api.example.com/data/chat-messages/' \
--header "Authorization: $API_KEY"
DELETE
/data/studios/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/studios/{instance_id}' \
--header "Authorization: $API_KEY"
GET
/data/edits/{edit_id}/task-types
curl \
--request GET 'http://api.example.com/data/edits/{edit_id}/task-types' \
--header "Authorization: $API_KEY"
GET
/data/edits/{edit_id}/versions
curl \
--request GET 'http://api.example.com/data/edits/{edit_id}/versions' \
--header "Authorization: $API_KEY"
GET
/data/episodes/{episode_id}/edits
curl \
--request GET 'http://api.example.com/data/episodes/{episode_id}/edits' \
--header "Authorization: $API_KEY"
GET
/data/entities/{entity_id}/preview-files
curl \
--request GET 'http://api.example.com/data/entities/{entity_id}/preview-files' \
--header "Authorization: $API_KEY"
Create new output file linked to assets through an instance of this asset for a given shot.
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.
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 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
/data/entities/{entity_id}/working-files
curl \
--request GET 'http://api.example.com/data/entities/{entity_id}/working-files' \
--header "Authorization: $API_KEY"
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"
POST
/import/shotgun/status
curl \
--request POST 'http://api.example.com/import/shotgun/status' \
--header "Authorization: $API_KEY"
GET
/import/shotgun/errors
curl \
--request GET 'http://api.example.com/import/shotgun/errors' \
--header "Authorization: $API_KEY"
DELETE
/import/shotgun/errors/{error_id}
curl \
--request DELETE 'http://api.example.com/import/shotgun/errors/{error_id}' \
--header "Authorization: $API_KEY"
POST
/import/shotgun/remove/shot
curl \
--request POST 'http://api.example.com/import/shotgun/remove/shot' \
--header "Authorization: $API_KEY"
POST
/import/shotgun/remove/scene
curl \
--request POST 'http://api.example.com/import/shotgun/remove/scene' \
--header "Authorization: $API_KEY"
POST
/import/shotgun/remove/version
curl \
--request POST 'http://api.example.com/import/shotgun/remove/version' \
--header "Authorization: $API_KEY"
POST
/import/csv/persons
curl \
--request POST 'http://api.example.com/import/csv/persons' \
--header "Authorization: $API_KEY"
POST
/import/kitsu/comments
curl \
--request POST 'http://api.example.com/import/kitsu/comments' \
--header "Authorization: $API_KEY"
GET
/data/projects/{project_id}/news
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/news' \
--header "Authorization: $API_KEY"
GET
/data/persons/{person_id}/time-spents/month/{year}/{month}
curl \
--request GET 'http://api.example.com/data/persons/{person_id}/time-spents/month/{year}/{month}' \
--header "Authorization: $API_KEY"
GET
/data/projects/{project_id}/playlists/all
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/playlists/all' \
--header "Authorization: $API_KEY"
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"
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"
GET
/data/playlists/preview-files/running
curl \
--request GET 'http://api.example.com/data/playlists/preview-files/running' \
--header "Authorization: $API_KEY"
GET
/pictures/originals/preview-files/{instance_id}.{extension}
curl \
--request GET 'http://api.example.com/pictures/originals/preview-files/{instance_id}.{extension}' \
--header "Authorization: $API_KEY"
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"
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"
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"
GET
/data/projects/{project_id}/budgets
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/budgets' \
--header "Authorization: $API_KEY"
GET
/data/episodes/{episode_id}
curl \
--request GET 'http://api.example.com/data/episodes/{episode_id}' \
--header "Authorization: $API_KEY"
GET
/data/sequences/with-tasks
curl \
--request GET 'http://api.example.com/data/sequences/with-tasks' \
--header "Authorization: $API_KEY"
GET
/data/sequences/{sequence_id}/shots
curl \
--request GET 'http://api.example.com/data/sequences/{sequence_id}/shots' \
--header "Authorization: $API_KEY"
GET
/data/projects/{project_id}/sequences