curl \
--request POST 'http://api.example.com/import/shotgun/versions' \
--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.
curl \
--request POST 'http://api.example.com/auth/login' \
--header "Authorization: $API_KEY"
curl \
--request PUT 'http://api.example.com/auth/email-otp' \
--header "Authorization: $API_KEY"
curl \
--request DELETE 'http://api.example.com/auth/email-otp' \
--header "Authorization: $API_KEY"
Path parameters
-
asset_id
Required
curl \
--request GET 'http://api.example.com/data/assets/{asset_id}/assets' \
--header "Authorization: $API_KEY"
Resource to retrieve the casting of shots from given sequence.
Path parameters
-
project_id
Required -
sequence_id
Required
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/sequences/{sequence_id}/casting' \
--header "Authorization: $API_KEY"
Retrieve all entity links related to given project.
Results can be paginated using page and limit query parameters. If you
prefer a more accurate pagination, you can use and
cursor_created_at to get the next page.
Path parameters
-
project_id
Required
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/entity-links' \
--header "Authorization: $API_KEY"
Delete given entity link.
It's mainly used for synchronisation purpose.
Path parameters
-
project_id
Required -
entity_link_id
Required
curl \
--request DELETE 'http://api.example.com/data/projects/{project_id}/entity-links/{entity_link_id}' \
--header "Authorization: $API_KEY"
Retrieve all asset instances linked to shot.
Path parameters
-
shot_id
Required
curl \
--request GET 'http://api.example.com/data/shots/{shot_id}/asset-instances' \
--header "Authorization: $API_KEY"
Acknowledge given comment.
If it's already acknowledged, remove acknowledgement.
Path parameters
-
task_id
Required -
comment_id
Required
curl \
--request POST 'http://api.example.com/data/tasks/{task_id}/comments/{comment_id}/ack' \
--header "Authorization: $API_KEY"
Creates new comments for given task. Each comments requires a task_id,
text, a task_status and a person as arguments.
curl \
--request POST 'http://api.example.com/actions/tasks/batch-comment' \
--header "Authorization: $API_KEY"
Update a model with data given in the request body.
JSON format is expected. Model performs the validation automatically when fields are modified.
Path parameters
-
instance_id
Required
curl \
--request PUT 'http://api.example.com/data/project-status/{instance_id}' \
--header "Authorization: $API_KEY"
Create a model with data given in the request body.
JSON format is expected. The model performs the validation automatically when instantiated.
curl \
--request POST 'http://api.example.com/data/task-types' \
--header "Authorization: $API_KEY"
Retrieve a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id
Required
curl \
--request GET 'http://api.example.com/data/file-status/{instance_id}' \
--header "Authorization: $API_KEY"
Create a model with data given in the request body.
JSON format is expected. The model performs the validation automatically when instantiated.
curl \
--request POST 'http://api.example.com/data/attachment-files' \
--header "Authorization: $API_KEY"
Create a model with data given in the request body.
JSON format is expected. The model performs the validation automatically when instantiated.
curl \
--request POST 'http://api.example.com/data/custom-actions/' \
--header "Authorization: $API_KEY"
Retrieve all entries for given model.
Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/status-automations/' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/news/' \
--header "Authorization: $API_KEY"
Retrieve a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id
Required
curl \
--request GET 'http://api.example.com/data/subscriptions/{instance_id}' \
--header "Authorization: $API_KEY"
Update a model with data given in the request body.
JSON format is expected. Model performs the validation automatically when fields are modified.
Path parameters
-
instance_id
Required
curl \
--request PUT 'http://api.example.com/data/chat-messages/{instance_id}' \
--header "Authorization: $API_KEY"
Update a model with data given in the request body.
JSON format is expected. Model performs the validation automatically when fields are modified.
Path parameters
-
instance_id
Required
curl \
--request PUT 'http://api.example.com/data/salary-scales/{instance_id}' \
--header "Authorization: $API_KEY"
Delete a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id
Required
curl \
--request DELETE 'http://api.example.com/data/salary-scales/{instance_id}' \
--header "Authorization: $API_KEY"
Retrieve all preview files linked to a given entity.
Path parameters
-
entity_id
Required
curl \
--request GET 'http://api.example.com/data/entities/{entity_id}/preview-files' \
--header "Authorization: $API_KEY"
Get last revisions of output files for given instance grouped by output type and file name.
Path parameters
-
asset_instance_id
Required -
temporal_entity_id
Required
Query parameters
-
output_type_id
Required -
task_type_id
Required -
file_status_id
Required -
representation
Required
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 last revisions of output files for given entity grouped by output type and file name.
Path parameters
-
entity_id
Required
curl \
--request GET 'http://api.example.com/data/entities/{entity_id}/output-files/last-revisions' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/import/shotgun/episodes' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/import/shotgun/remove/shot' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/import/shotgun/remove/episode' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/import/shotgun/remove/sequence' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/status.txt' \
--header "Authorization: $API_KEY"
Return a csv file containing the presence logs based on a daily basis.
Path parameters
-
month_date
Required
curl \
--request GET 'http://api.example.com/data/persons/presence-logs/{month_date}' \
--header "Authorization: $API_KEY"
Return all day off recorded for given month.
curl \
--request GET 'http://api.example.com/data/persons/day-offs/{year}/{month}' \
--header "Authorization: $API_KEY"
Return all day offs recorded for given and person.
Path parameters
-
person_id
Required
curl \
--request GET 'http://api.example.com/data/persons/{person_id}/day-offs' \
--header "Authorization: $API_KEY"
Allow admin to disable two factor authentication for given user.
Prior to disable two factor authentication, it requires to be admin. An admin can't disable two factor authentication for other admins.
Path parameters
-
person_id
Required
curl \
--request DELETE 'http://api.example.com/actions/persons/{person_id}/disable-two-factor-authentication' \
--header "Authorization: $API_KEY"
Path parameters
-
instance_id
Required
curl \
--request GET 'http://api.example.com/movies/low/preview-files/{instance_id}.mp4' \
--header "Authorization: $API_KEY"
Download a thumbnail.
Path parameters
-
instance_id
Required
curl \
--request GET 'http://api.example.com/pictures/thumbnails-square/preview-files/{instance_id}.png' \
--header "Authorization: $API_KEY"
Set given preview as main preview of the related entity.
This preview will be used to illustrate the entity.
Path parameters
-
preview_file_id
Required
curl \
--request PUT 'http://api.example.com/actions/preview-files/{preview_file_id}/set-main-preview' \
--header "Authorization: $API_KEY"
Return task statuses linked to a production
Path parameters
-
project_id
Required
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/settings/task-status' \
--header "Authorization: $API_KEY"
Retrieve all shots, adds project name and asset type name and all related tasks.
curl \
--request GET 'http://api.example.com/data/shots/with-tasks' \
--header "Authorization: $API_KEY"
Set frames for given shots.
curl \
--request POST 'http://api.example.com/actions/projects/{project_id}/task-types/{task_type_id}/set-shot-nb-frames' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/user/desktop-login-logs' \
--header "Authorization: $API_KEY"
Set last preview from given task as main preview of the related entity.
This preview will be used as thumbnail to illustrate the entity.
Path parameters
-
preview_file_id
Required
curl \
--request PUT 'http://api.example.com/actions/tasks/{task_id}/set-main-preview' \
--header "Authorization: $API_KEY"