curl \
--request PUT 'http://api.example.com/auth/fido' \
--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 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/entities/{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-status' \
--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/preview-files' \
--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/day-offs/{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/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
curl \
--request PUT 'http://api.example.com/data/search-filters/{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/schedule-items/{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/entity-links/' \
--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/chats/' \
--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/preview-background-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/salary-scales' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/export/csv/time-spents.csv' \
--header "Authorization: $API_KEY"
Return last working files revision for each file name for given task.
Path parameters
-
task_id
Required
curl \
--request GET 'http://api.example.com/data/tasks/{task_id}/working-files/last-revisions' \
--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
curl \
--request POST 'http://api.example.com/data/tasks/{task_id}/working-file-path' \
--header "Authorization: $API_KEY"
Get all output files for given asset instance and given output type.
Path parameters
-
asset_instance_id
Required -
temporal_entity_id
Required -
output_type_id
Required
curl \
--request GET 'http://api.example.com/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-types/{output_type_id}/output-files' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/import/shotgun/remove/note' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/import/shotgun/remove/version' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/stats' \
--header "Authorization: $API_KEY"
Get aggregated time spents for given person and year.
curl \
--request GET 'http://api.example.com/data/persons/{person_id}/time-spents/year/{year}' \
--header "Authorization: $API_KEY"
Path parameters
-
instance_id
Required
curl \
--request GET 'http://api.example.com/movies/tiles/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"
Path parameters
-
project_id
Required
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/budgets' \
--header "Authorization: $API_KEY"
Retrieve all task types related to a given scene.
Path parameters
-
scene_id
Required
curl \
--request GET 'http://api.example.com/data/scenes/{scene_id}/task-types' \
--header "Authorization: $API_KEY"
Path parameters
-
scene_id
Required
curl \
--request POST 'http://api.example.com/data/scenes/{scene_id}/shots' \
--header "Authorization: $API_KEY"
Path parameters
-
episode_id
Required
curl \
--request GET 'http://api.example.com/data/episodes/{episode_id}' \
--header "Authorization: $API_KEY"
Path parameters
-
episode_id
Required
curl \
--request DELETE 'http://api.example.com/data/episodes/{episode_id}' \
--header "Authorization: $API_KEY"
Path parameters
-
sequence_id
Required
curl \
--request DELETE 'http://api.example.com/data/sequences/{sequence_id}' \
--header "Authorization: $API_KEY"
Retrieve all scenes related to a given sequence.
Path parameters
-
sequence_id
Required
curl \
--request GET 'http://api.example.com/data/sequences/{sequence_id}/scenes' \
--header "Authorization: $API_KEY"
Retrieve quotas statistics for shots.
Path parameters
-
project_id
Required -
task_type_id
Required
Query parameters
-
count_mode
Required
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/quotas/{task_type_id}' \
--header "Authorization: $API_KEY"
For all entities assigned to given person (that have at least one task assigned to given person), returns all tasks for given task type.
curl \
--request GET 'http://api.example.com/data/persons/{person_id}/related-tasks/{task_type_id}' \
--header "Authorization: $API_KEY"
Retrieve all comments to tasks related to given project.
It's mainly used for synchronisation purpose.
Path parameters
-
project_id
Required
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/comments' \
--header "Authorization: $API_KEY"
Set time spent by a person on a task for a given day.
curl \
--request POST 'http://api.example.com/actions/tasks/{task_id}/time-spents/{date}/persons/{person_id}' \
--header "Authorization: $API_KEY"
Delete preview from given comment.
Path parameters
-
task_id
Required -
comment_id
Required -
preview_file_id
Required
curl \
--request DELETE 'http://api.example.com/actions/tasks/{task_id}/comments/{comment_id}/preview-files/{preview_file_id}' \
--header "Authorization: $API_KEY"
Create a new task with given task type for each entity of given
entity type.
Path parameters
-
project_id
Required -
task_type_id
Required
curl \
--request POST 'http://api.example.com/actions/projects/{project_id}/task-types/{task_type_id}/create-tasks/{entity_type}/' \
--header "Authorization: $API_KEY"
Return tasks related to given asset for current user.
Path parameters
-
asset_id
Required
curl \
--request GET 'http://api.example.com/data/user/assets/{asset_id}/tasks' \
--header "Authorization: $API_KEY"
Return tasks related to given sequence for current user.
Path parameters
-
sequence_id
Required
curl \
--request GET 'http://api.example.com/data/user/sequences/{sequence_id}/task-types' \
--header "Authorization: $API_KEY"
Return assets of which type is given asset type and are listed in given
project if user has access to this project.
Path parameters
-
project_id
Required -
asset_type_id
Required
curl \
--request GET 'http://api.example.com/data/user/projects/{project_id}/asset-types/{asset_type_id}/assets' \
--header "Authorization: $API_KEY"
Path parameters
-
notification_id
Required
curl \
--request PUT 'http://api.example.com/data/user/notifications/{notification_id}' \
--header "Authorization: $API_KEY"