Download a thumbnail.
Path parameters
-
instance_id
Required
curl \
--request GET 'http://api.example.com/pictures/thumbnails-square/preview-files/{instance_id}.png' \
--header "Authorization: $API_KEY"
It uses a classic scheme: a token is sent by email to the user. Then he can change his password.
curl \
--request PUT 'http://api.example.com/auth/reset-password' \
--header "Authorization: $API_KEY"
It uses a classic scheme: a token is sent by email to the user. Then he can change his password.
curl \
--request POST 'http://api.example.com/auth/reset-password' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/assets/{asset_id}' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/assets/{asset_id}/casting' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/actions/projects/{project_id}/asset-types/{asset_type_id}/assets/share' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/episodes/{episode_id}/assets/shared-used' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/entities/{entity_id}/casting' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/asset-types/{asset_type_id}/casting' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/episodes/{episode_id}/sequences/all/casting' \
--header "Authorization: $API_KEY"
project.
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/sequences/all/casting' \
--header "Authorization: $API_KEY"
If it's already acknowledged, remove acknowledgement.
curl \
--request POST 'http://api.example.com/data/tasks/{task_id}/comments/{comment_id}/ack' \
--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"
text, a task_status and a person as arguments.
curl \
--request POST 'http://api.example.com/actions/tasks/batch-comment' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/entity-types/{instance_id}' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/entities/{instance_id}' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/tasks' \
--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/file-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/output-files/{instance_id}' \
--header "Authorization: $API_KEY"
curl \
--request DELETE '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"
curl \
--request DELETE '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/attachment-files' \
--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/comments/{instance_id}' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/time-spents/{instance_id}' \
--header "Authorization: $API_KEY"
Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/custom-actions/' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/custom-actions/{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/asset-instances/{instance_id}' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/playlists/{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/events/' \
--header "Authorization: $API_KEY"
curl \
--request DELETE 'http://api.example.com/data/events/{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-filter-groups/' \
--header "Authorization: $API_KEY"
curl \
--request DELETE 'http://api.example.com/data/search-filter-groups/{instance_id}' \
--header "Authorization: $API_KEY"
curl \
--request DELETE 'http://api.example.com/data/milestones/{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"
curl \
--request DELETE 'http://api.example.com/data/metadata-descriptors/{instance_id}' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/preview-background-files/{instance_id}' \
--header "Authorization: $API_KEY"
curl \
--request DELETE 'http://api.example.com/data/preview-background-files/{instance_id}' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/plugins/{instance_id}' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/edits/{edit_id}/versions' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/data/projects/{project_id}/edits' \
--header "Authorization: $API_KEY"
output file.
curl \
--request GET 'http://api.example.com/data/files/{file_id}' \
--header "Authorization: $API_KEY"
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.
curl \
--request POST 'http://api.example.com/data/tasks/{task_id}/working-files/new' \
--header "Authorization: $API_KEY"
Generate file path based on several parameters: task, software, mode, revision and separator. Revision can be computed automatically as next revision if not given.
curl \
--request POST 'http://api.example.com/data/tasks/{task_id}/working-file-path' \
--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"
curl \
--request PUT 'http://api.example.com/actions/working-files/{working_file_id}/comment' \
--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/versions' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/import/shotgun/errors' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/import/shotgun/remove/task' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/import/csv/projects/{project_id}/casting' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/import/csv/projects/{project_id}/episodes/{episode_id}/task-types/{task_type_id}/estimations' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/import/kitsu/comments' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/import/kitsu/entities' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/status/influx' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/config' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/news/{news_id}' \
--header "Authorization: $API_KEY"
Add a new log entry for desktop logins.
curl \
--request POST 'http://api.example.com/data/persons/{person_id}/desktop-login-logs' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/persons/{person_id}/time-spents/year/{year}' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/persons/{person_id}/quota-shots/week/{year}/{week}' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/persons/time-spents/day-table/{year}/{month}' \
--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/{playlist_id}/download/zip' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/pictures/thumbnails-square/preview-files/{instance_id}.png' \
--header "Authorization: $API_KEY"