Path parameters
-
episode_id
Required
curl \
--request GET 'http://api.example.com/data/episodes/{episode_id}' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/asset-types' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/episodes/casting' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/sequences/{sequence_id}/casting' \
--header "Authorization: $API_KEY"
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.
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/entity-links' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/scenes/{scene_id}/camera-instances' \
--header "Authorization: $API_KEY"
It requires a text, a task_status and a person as arguments. This way, comments keep history of status changes. When the comment is created, it updates the task status with given task status.
curl \
--request POST 'http://api.example.com/actions/tasks/{task_id}/comment' \
--header "Authorization: $API_KEY"
curl \
--request DELETE 'http://api.example.com/data/projects/{instance_id}' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/project-status/{instance_id}' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/task-status/{instance_id}' \
--header "Authorization: $API_KEY"
JSON format is expected. Model performs the validation automatically when fields are modified.
curl \
--request PUT 'http://api.example.com/data/task-status/{instance_id}' \
--header "Authorization: $API_KEY"
Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/departments' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/organisations/{instance_id}' \
--header "Authorization: $API_KEY"
JSON object.
curl \
--request GET 'http://api.example.com/data/output-types/{instance_id}' \
--header "Authorization: $API_KEY"
JSON format is expected. The model performs the validation automatically when instantiated.
curl \
--request POST 'http://api.example.com/data/working-files' \
--header "Authorization: $API_KEY"
JSON object.
curl \
--request GET 'http://api.example.com/data/working-files/{instance_id}' \
--header "Authorization: $API_KEY"
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"
JSON format is expected. Model performs the validation automatically when fields are modified.
curl \
--request PUT 'http://api.example.com/data/events/{instance_id}' \
--header "Authorization: $API_KEY"
Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/schedule-items/' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/news/' \
--header "Authorization: $API_KEY"
curl \
--request DELETE 'http://api.example.com/data/subscriptions/{instance_id}' \
--header "Authorization: $API_KEY"
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"
JSON format is expected. Model performs the validation automatically when fields are modified.
curl \
--request PUT 'http://api.example.com/data/chats/{instance_id}' \
--header "Authorization: $API_KEY"
Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/chat-messages/' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/salary-scales' \
--header "Authorization: $API_KEY"
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/data/entities/{entity_id}/time-spents' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/export/csv/projects/{project_id}/assets.csv' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/export/csv/projects.csv' \
--header "Authorization: $API_KEY"
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.
curl \
--request POST 'http://api.example.com/data/entities/{entity_id}/output-files/new' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/data/entities/{entity_id}/output-files/next-revision' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/import/shotgun/persons' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/import/shotgun/sequences' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/import/shotgun/assets' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/import/shotgun/tasks' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/import/shotgun/versions' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/import/shotgun/remove/scene' \
--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/csv/persons' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/status' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/stats' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/news' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/persons/{person_id}/day-offs/year/{year}' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/actions/persons/{person_id}/invite' \
--header "Authorization: $API_KEY"
Result is paginated and can be sorted.
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/playlists' \
--header "Authorization: $API_KEY"
It sends them as a dict. Keys are related task type ids and values are arrays of preview for this task type.
curl \
--request GET 'http://api.example.com/data/playlists/entities/{entity_id}/preview-files' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/playlists/preview-files/running' \
--header "Authorization: $API_KEY"
curl \
--request DELETE 'http://api.example.com/data/projects/{project_id}/settings/asset-types/{asset_type_id}' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/data/projects/{project_id}/settings/task-types' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/settings/status-automations' \
--header "Authorization: $API_KEY"
Descriptors serve to describe extra fields listed in the data attribute of entities.
curl \
--request PUT 'http://api.example.com/data/projects/{project_id}/metadata-descriptors/{descriptor_id}' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/scenes/{scene_id}' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/episodes/with-tasks' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/episodes/{episode_id}' \
--header "Authorization: $API_KEY"