Delete given shot from given scene.
DELETE
/data/scenes/{scene_id}/shots/{shot_id}
curl \
--request DELETE 'http://api.example.com/data/scenes/{scene_id}/shots/{shot_id}' \
--header "Authorization: $API_KEY"
POST
/auth/totp
curl \
--request POST 'http://api.example.com/auth/totp' \
--header "Authorization: $API_KEY"
POST
/auth/fido
curl \
--request POST 'http://api.example.com/auth/fido' \
--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"Retrieve all camera instances linked to scene.
Path parameters
-
scene_id
Required
GET
/data/scenes/{scene_id}/camera-instances
curl \
--request GET 'http://api.example.com/data/scenes/{scene_id}/camera-instances' \
--header "Authorization: $API_KEY"Reply to given comment.
Add comment to its replies list.
Path parameters
-
task_id
Required -
comment_id
Required
POST
/data/tasks/{task_id}/comments/{comment_id}/reply
curl \
--request POST 'http://api.example.com/data/tasks/{task_id}/comments/{comment_id}/reply' \
--header "Authorization: $API_KEY"Download attachment file.
Path parameters
-
attachment_file_id
Required -
file_name
Required
GET
/data/attachment-files/{attachment_file_id}/file/{file_name}
curl \
--request GET 'http://api.example.com/data/attachment-files/{attachment_file_id}/file/{file_name}' \
--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-types/{instance_id}
curl \
--request PUT 'http://api.example.com/data/task-types/{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/organisations/{instance_id}
curl \
--request GET 'http://api.example.com/data/organisations/{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/file-status/
curl \
--request POST 'http://api.example.com/data/file-status/' \
--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/file-status/{instance_id}
curl \
--request GET 'http://api.example.com/data/file-status/{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/file-status/{instance_id}
curl \
--request PUT 'http://api.example.com/data/file-status/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve an output type corresponding at given ID and return it as a
JSON object.
Path parameters
-
output_type_id
Required
GET
/data/output-types/{instance_id}
curl \
--request GET 'http://api.example.com/data/output-types/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/comments
curl \
--request GET 'http://api.example.com/data/comments' \
--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/comments
curl \
--request POST 'http://api.example.com/data/comments' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/events/
curl \
--request GET 'http://api.example.com/data/events/' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/search-filter-groups/
curl \
--request GET 'http://api.example.com/data/search-filter-groups/' \
--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/milestones/
curl \
--request POST 'http://api.example.com/data/milestones/' \
--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/milestones/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/milestones/{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"Delete a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id
Required
DELETE
/data/chat-messages/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/chat-messages/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve all previews related to a given edit.
It sends them as a dict. Keys are related task type ids and values are arrays of preview for this task type.
Path parameters
-
edit_id
Required
GET
/data/edits/{edit_id}/preview-files
curl \
--request GET 'http://api.example.com/data/edits/{edit_id}/preview-files' \
--header "Authorization: $API_KEY"Path parameters
-
entity_id
Required
GET
/data/entities/{entity_id}/news
curl \
--request GET 'http://api.example.com/data/entities/{entity_id}/news' \
--header "Authorization: $API_KEY"Get next revision for given asset instance, output type, task type and name.
Path parameters
-
asset_instance_id
Required -
temporal_entity_id
Required
POST
/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-files/next-revision
curl \
--request POST 'http://api.example.com/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-files/next-revision' \
--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
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"Create new output file linked to a given entity.
Output files are linked to entities. 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 entity (an asset, a shot, a sequence, ...). 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. Revision is automatically set.
Path parameters
-
entity_id
Required
POST
/data/entities/{entity_id}/output-files/new
curl \
--request POST 'http://api.example.com/data/entities/{entity_id}/output-files/new' \
--header "Authorization: $API_KEY"Get all output files for given poject.
Path parameters
-
project_id
Required
Query parameters
-
output_type_id
Required -
task_type_id
Required -
file_status_id
Required -
representation
Required
GET
/data/projects/{project_id}/output-files
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/output-files' \
--header "Authorization: $API_KEY"Define a template file to use for given project.
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
-
project_id
Required
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"
POST
/import/shotgun/remove/project
curl \
--request POST 'http://api.example.com/import/shotgun/remove/project' \
--header "Authorization: $API_KEY"
POST
/import/csv/persons
curl \
--request POST 'http://api.example.com/import/csv/persons' \
--header "Authorization: $API_KEY"Import project casting links via a .csv file.
Path parameters
-
project_id
Required
POST
/import/csv/projects/{project_id}/casting
curl \
--request POST 'http://api.example.com/import/csv/projects/{project_id}/casting' \
--header "Authorization: $API_KEY"
GET
/stats
curl \
--request GET 'http://api.example.com/stats' \
--header "Authorization: $API_KEY"Return a csv file containing the presence logs based on a daily basis.
Path parameters
-
month_date
Required
GET
/data/persons/presence-logs/{month_date}
curl \
--request GET 'http://api.example.com/data/persons/presence-logs/{month_date}' \
--header "Authorization: $API_KEY"Get aggregated time spents for given person and year.
GET
/data/persons/{person_id}/time-spents/year/{year}
curl \
--request GET 'http://api.example.com/data/persons/{person_id}/time-spents/year/{year}' \
--header "Authorization: $API_KEY"Get ended shots used for quota calculation of this week.
Query parameters
-
count_mode
Required
GET
/data/persons/{person_id}/quota-shots/week/{year}/{week}
curl \
--request GET 'http://api.example.com/data/persons/{person_id}/quota-shots/week/{year}/{week}' \
--header "Authorization: $API_KEY"Remove a user from given department.
Path parameters
-
person_id
Required -
department_id
Required
DELETE
/actions/persons/{person_id}/departments/{department_id}
curl \
--request DELETE 'http://api.example.com/actions/persons/{person_id}/departments/{department_id}' \
--header "Authorization: $API_KEY"
GET
/data/shots/all
curl \
--request GET 'http://api.example.com/data/shots/all' \
--header "Authorization: $API_KEY"Path parameters
-
scene_id
Required
GET
/data/scenes/{scene_id}/tasks
curl \
--request GET 'http://api.example.com/data/scenes/{scene_id}/tasks' \
--header "Authorization: $API_KEY"Retrieve all task types related to a given scene.
Path parameters
-
scene_id
Required
GET
/data/scenes/{scene_id}/task-types
curl \
--request GET 'http://api.example.com/data/scenes/{scene_id}/task-types' \
--header "Authorization: $API_KEY"