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/output-files' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/auth/saml/login' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/assets/{asset_id}/casting' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/assets/{asset_id}/shot-asset-instances' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/data/projects/{project_id}/asset-types/{asset_type_id}/assets/new' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/actions/projects/{project_id}/assets/share' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/data/scenes/{scene_id}/asset-instances' \
--header "Authorization: $API_KEY"
curl \
--request DELETE 'http://api.example.com/data/tasks/{task_id}/comments/{comment_id}/attachments/{attachment_id}' \
--header "Authorization: $API_KEY"
Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/softwares' \
--header "Authorization: $API_KEY"
JSON format is expected. The model performs the validation automatically when instantiated.
curl \
--request POST 'http://api.example.com/data/output-files' \
--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. Model performs the validation automatically when fields are modified.
curl \
--request PUT 'http://api.example.com/data/working-files/{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"
curl \
--request GET 'http://api.example.com/data/custom-actions/{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/status-automations/' \
--header "Authorization: $API_KEY"
Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/events/' \
--header "Authorization: $API_KEY"
JSON format is expected. The model performs the validation automatically when instantiated.
curl \
--request POST 'http://api.example.com/data/subscriptions/' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/studios/{instance_id}' \
--header "Authorization: $API_KEY"
curl \
--request DELETE 'http://api.example.com/data/salary-scales/{instance_id}' \
--header "Authorization: $API_KEY"
curl \
--request DELETE 'http://api.example.com/data/plugins/{instance_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"
curl \
--request GET 'http://api.example.com/data/entities/{entity_id}/working-files' \
--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/tasks' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/import/csv/projects/{project_id}/casting' \
--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' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/persons/{person_id}/time-spents/{date}' \
--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/movies/low/preview-files/{instance_id}.mp4' \
--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"
curl \
--request POST 'http://api.example.com/data/projects/{project_id}/settings/task-types' \
--header "Authorization: $API_KEY"
It serves to describe extra fields listed in the data attribute of entities.
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/metadata-descriptors' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/budgets/{budget_id}' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/shots/{shot_id}' \
--header "Authorization: $API_KEY"
curl \
--request DELETE 'http://api.example.com/data/sequences/{sequence_id}' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/scenes' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/episodes/retake-stats' \
--header "Authorization: $API_KEY"
It's mainly used for synchronisation purpose.
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/comments' \
--header "Authorization: $API_KEY"
uploaded afterward.
Revision is automatically set: it is equal to last revision + 1. It can
be also set manually.
curl \
--request POST 'http://api.example.com/actions/tasks/{task_id}/comments/{comment_id}/add-preview' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/user/sequences/{sequence_id}/task-types' \
--header "Authorization: $API_KEY"
The user will no longer receive notifications for this task.
curl \
--request DELETE 'http://api.example.com/actions/user/tasks/{task_id}/unsubscribe' \
--header "Authorization: $API_KEY"