Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/custom-actions/
curl \
--request GET 'http://api.example.com/data/custom-actions/' \
--header "Authorization: $API_KEY"Resource to allow a user to change his password when he forgets it.
It uses a classic scheme: a token is sent by email to the user. Then he can change his password.
PUT
/auth/reset-password
curl \
--request PUT 'http://api.example.com/auth/reset-password' \
--header "Authorization: $API_KEY"Resource to allow a user to change his password when he forgets it.
It uses a classic scheme: a token is sent by email to the user. Then he can change his password.
POST
/auth/reset-password
curl \
--request POST 'http://api.example.com/auth/reset-password' \
--header "Authorization: $API_KEY"
PUT
/auth/recovery-codes
curl \
--request PUT 'http://api.example.com/auth/recovery-codes' \
--header "Authorization: $API_KEY"
PUT
/auth/fido
curl \
--request PUT 'http://api.example.com/auth/fido' \
--header "Authorization: $API_KEY"Retrieve all scene asset instances linked to asset.
Path parameters
-
asset_id
Required
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 and entity type.
Path parameters
-
project_id
Required -
asset_type_id
Required
GET
/data/projects/{project_id}/asset-types/{asset_type_id}/assets
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/asset-types/{asset_type_id}/assets' \
--header "Authorization: $API_KEY"Share or unshare all assets (or a list of assets) for given project.
POST
/actions/projects/{project_id}/assets/share
curl \
--request POST 'http://api.example.com/actions/projects/{project_id}/assets/share' \
--header "Authorization: $API_KEY"Retrieve all shared assets used in project.
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"Resource to allow the modification of assets linked to an entity.
Path parameters
-
project_id
Required -
entity_id
Required
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 assets from given asset type.
Path parameters
-
project_id
Required -
asset_type_id
Required
GET
/data/projects/{project_id}/asset-types/{asset_type_id}/casting
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/asset-types/{asset_type_id}/casting' \
--header "Authorization: $API_KEY"Retrieve all asset instances linked to shot.
Path parameters
-
shot_id
Required
GET
/data/shots/{shot_id}/asset-instances
curl \
--request GET 'http://api.example.com/data/shots/{shot_id}/asset-instances' \
--header "Authorization: $API_KEY"Delete given comment reply.
Path parameters
-
task_id
Required -
comment_id
Required -
reply_id
Required
DELETE
/data/tasks/{task_id}/comments/{comment_id}/reply/{reply_id}
curl \
--request DELETE 'http://api.example.com/data/tasks/{task_id}/comments/{comment_id}/reply/{reply_id}' \
--header "Authorization: $API_KEY"Add given files to the comment entry as attachments.
Path parameters
-
task_id
Required -
comment_id
Required
POST
/actions/tasks/{task_id}/comments/{comment_id}/add-attachment
curl \
--request POST 'http://api.example.com/actions/tasks/{task_id}/comments/{comment_id}/add-attachment' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/project-status
curl \
--request GET 'http://api.example.com/data/project-status' \
--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
PUT
/data/task-status/{instance_id}
curl \
--request PUT 'http://api.example.com/data/task-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.
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.
Path parameters
-
instance_id
Required
GET
/data/comments/{instance_id}
curl \
--request GET 'http://api.example.com/data/comments/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id
Required
GET
/data/events/{instance_id}
curl \
--request GET 'http://api.example.com/data/events/{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
PUT
/data/notifications/{instance_id}
curl \
--request PUT 'http://api.example.com/data/notifications/{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
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.
Path parameters
-
instance_id
Required
DELETE
/data/entity-links/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/entity-links/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id
Required
GET
/data/studios/{instance_id}
curl \
--request GET 'http://api.example.com/data/studios/{instance_id}' \
--header "Authorization: $API_KEY"
GET
/data/salary-scales
curl \
--request GET 'http://api.example.com/data/salary-scales' \
--header "Authorization: $API_KEY"Create new working file.
A working file is a file used to produce output files. It is the file the CG artist is working on. It is versioned, tied to a task and a software and requires a comment each time it is created. A path is generated for each file created. The path format is defined in the file tree template file.
Path parameters
-
task_id
Required
POST
/data/tasks/{task_id}/working-files/new
curl \
--request POST 'http://api.example.com/data/tasks/{task_id}/working-files/new' \
--header "Authorization: $API_KEY"Generate a working file path from file tree template.
Generate file path based on several parameters: task, software, mode, revision and separator. Revision can be computed automatically as next revision if not given.
Path parameters
-
task_id
Required
POST
/data/tasks/{task_id}/working-file-path
curl \
--request POST 'http://api.example.com/data/tasks/{task_id}/working-file-path' \
--header "Authorization: $API_KEY"Return all types of output generated for given instance.
Path parameters
-
asset_instance_id
Required -
temporal_entity_id
Required
GET
/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-types
curl \
--request GET 'http://api.example.com/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-types' \
--header "Authorization: $API_KEY"
POST
/import/shotgun/episodes
curl \
--request POST 'http://api.example.com/import/shotgun/episodes' \
--header "Authorization: $API_KEY"
POST
/import/shotgun/notes
curl \
--request POST 'http://api.example.com/import/shotgun/notes' \
--header "Authorization: $API_KEY"Path parameters
-
error_id
Required
DELETE
/import/shotgun/errors/{error_id}
curl \
--request DELETE 'http://api.example.com/import/shotgun/errors/{error_id}' \
--header "Authorization: $API_KEY"Import project shots via a .csv file.
Path parameters
-
project_id
Required
POST
/import/csv/projects/{project_id}/shots
curl \
--request POST 'http://api.example.com/import/csv/projects/{project_id}/shots' \
--header "Authorization: $API_KEY"
GET
/status/resources
curl \
--request GET 'http://api.example.com/status/resources' \
--header "Authorization: $API_KEY"Retrieve all build jobs related to given project.
It's mainly used for synchronisation purpose.
Path parameters
-
project_id
Required
GET
/data/projects/{project_id}/build-jobs
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/build-jobs' \
--header "Authorization: $API_KEY"Create a thumbnail for given object instance.
Path parameters
-
instance_id
Required
POST
/pictures/thumbnails/projects/{instance_id}
curl \
--request POST 'http://api.example.com/pictures/thumbnails/projects/{instance_id}' \
--header "Authorization: $API_KEY"Download a preview background file.
Path parameters
-
instance_id
Required -
extension
Required
GET
/pictures/preview-background-files/{instance_id}.{extension}
curl \
--request GET 'http://api.example.com/pictures/preview-background-files/{instance_id}.{extension}' \
--header "Authorization: $API_KEY"Remove an asset type from a production.
Path parameters
-
project_id
Required -
asset_type_id
Required
DELETE
/data/projects/{project_id}/settings/asset-types/{asset_type_id}
curl \
--request DELETE 'http://api.example.com/data/projects/{project_id}/settings/asset-types/{asset_type_id}' \
--header "Authorization: $API_KEY"Retrieve a budget entry for given production and budget
Path parameters
-
project_id
Required -
budget_id
Required -
entry_id
Required
GET
/data/projects/{project_id}/budgets/{budget_id}/entries/{entry_id}
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/budgets/{budget_id}/entries/{entry_id}' \
--header "Authorization: $API_KEY"Retrieve all shots, adds project name and asset type name and all related tasks.
GET
/data/shots/with-tasks
curl \
--request GET 'http://api.example.com/data/shots/with-tasks' \
--header "Authorization: $API_KEY"Retrieve all previews related to a given shot.
It sends them as a dict. Keys are related task type ids and values are arrays of preview for this task type.
Path parameters
-
shot_id
Required
GET
/data/shots/{shot_id}/preview-files
curl \
--request GET 'http://api.example.com/data/shots/{shot_id}/preview-files' \
--header "Authorization: $API_KEY"Retrieve all sequence entries for a given episode.
Filters can be specified in the query string.
Path parameters
-
episode_id
Required
GET
/data/episodes/{episode_id}/sequences
curl \
--request GET 'http://api.example.com/data/episodes/{episode_id}/sequences' \
--header "Authorization: $API_KEY"Return task assigned to given user of which status has is_done flag sets to false.
Path parameters
-
person_id
Required
GET
/data/persons/{person_id}/tasks
curl \
--request GET 'http://api.example.com/data/persons/{person_id}/tasks' \
--header "Authorization: $API_KEY"Return tasks related to given asset for current user.
Path parameters
-
asset_id
Required
GET
/data/user/assets/{asset_id}/tasks
curl \
--request GET 'http://api.example.com/data/user/assets/{asset_id}/tasks' \
--header "Authorization: $API_KEY"Return the list of sequence ids to which the current user has
subscribed for given task type.
Path parameters
-
project_id
Required -
task_type_id
Required
GET
/data/user/projects/{project_id}/task-types/{task_type_id}/sequence-subscriptions
curl \
--request GET 'http://api.example.com/data/user/projects/{project_id}/task-types/{task_type_id}/sequence-subscriptions' \
--header "Authorization: $API_KEY"