Adds project name and asset type name.
curl \
--request GET 'http://api.example.com/data/assets/all' \
--header "Authorization: $API_KEY"Adds project name and asset type name and all related tasks. If episode_id is given as parameter, it returns assets not linked to an episode and assets linked to given episode.
curl \
--request GET 'http://api.example.com/data/assets/with-tasks' \
--header "Authorization: $API_KEY"curl \
--request PUT 'http://api.example.com/data/assets/{asset_id}/casting' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/data/tasks/{task_id}/comments/{comment_id}/reply/{reply_id}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/projects/{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/project-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/entity-types/{instance_id}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/task-types/{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/organisations/{instance_id}' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/data/file-status/{instance_id}' \
--header "Authorization: $API_KEY"object.
curl \
--request GET 'http://api.example.com/data/output-files/{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/output-types/{instance_id}' \
--header "Authorization: $API_KEY"Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/working-files' \
--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. Model performs the validation automatically when fields are modified.
curl \
--request PUT 'http://api.example.com/data/attachment-files/{instance_id}' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/data/attachment-files/{instance_id}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/comments/{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/time-spents/' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/data/custom-actions/{instance_id}' \
--header "Authorization: $API_KEY"Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/status-automations/' \
--header "Authorization: $API_KEY"Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/playlists/' \
--header "Authorization: $API_KEY"JSON format is expected. The model performs the validation automatically when instantiated.
curl \
--request POST 'http://api.example.com/data/notifications/' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/notifications/{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/search-filters/' \
--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/search-filters/{instance_id}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/schedule-items/{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/metadata-descriptors/' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/metadata-descriptors/{instance_id}' \
--header "Authorization: $API_KEY"Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/subscriptions/' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/data/subscriptions/{instance_id}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/chat-messages/{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/salary-scales/{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/plugins' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/edits' \
--header "Authorization: $API_KEY"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"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"curl \
--request GET 'http://api.example.com/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-types' \
--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/import/shotgun/tasks' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/import/shotgun/remove/projectconnection' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/import/csv/projects/{project_id}/edits' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/import/kitsu/projects' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/status/influx' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/persons/time-spents/year-table/' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/persons/{person_id}/day-offs' \
--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"It's mainly used for synchronisation purpose.
curl \
--request POST 'http://api.example.com/data/projects/{project_id}/playlists/temp' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/pictures/thumbnails/organisations/{instance_id}.png' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/pictures/thumbnails/projects/{instance_id}' \
--header "Authorization: $API_KEY"This preview will be used to illustrate the entity.
curl \
--request PUT 'http://api.example.com/actions/preview-files/{preview_file_id}/set-main-preview' \
--header "Authorization: $API_KEY"Modifications are applied via three fields:
annotations to give all the annotations that need to be added.
updates that list annotations that needs to be modified.
deletions to list the IDs of annotations that needs to be removed.
curl \
--request PUT 'http://api.example.com/actions/preview-files/{preview_file_id}/update-annotations' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/data/projects/{project_id}/team' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/data/projects/{project_id}/settings/asset-types' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/data/projects/{project_id}/settings/preview-background-files/{preview_background_file_id}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/projects/{project_id}/schedule-items/{task_type_id}/episodes' \
--header "Authorization: $API_KEY"