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/milestones/' \
--header "Authorization: $API_KEY"
Once logged out, current user cannot access the API anymore.
curl \
--request GET 'http://api.example.com/auth/logout' \
--header "Authorization: $API_KEY"
curl \
--request DELETE 'http://api.example.com/auth/totp' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/assets/{asset_id}/cast-in' \
--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/actions/assets/share' \
--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"
curl \
--request GET 'http://api.example.com/data/tasks/{task_id}/attachment-files' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/projects/{instance_id}' \
--header "Authorization: $API_KEY"
curl \
--request DELETE 'http://api.example.com/data/projects/{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-types' \
--header "Authorization: $API_KEY"
JSON format is expected. The model performs the validation automatically when instantiated.
curl \
--request POST 'http://api.example.com/data/entities' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/entities/{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/task-types' \
--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"
JSON object.
curl \
--request GET 'http://api.example.com/data/softwares/{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/output-files' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/time-spents/{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/day-offs/{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/asset-instances/' \
--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/schedule-items/{instance_id}' \
--header "Authorization: $API_KEY"
curl \
--request DELETE 'http://api.example.com/data/news/{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/milestones/' \
--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-links/{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"
JSON format is expected. Model performs the validation automatically when fields are modified.
curl \
--request PUT 'http://api.example.com/data/chat-messages/{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/preview-background-files' \
--header "Authorization: $API_KEY"
curl \
--request DELETE 'http://api.example.com/data/plugins/{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/all' \
--header "Authorization: $API_KEY"
Some output files are linked to assets through an instance of this asset for a given shot. 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 instance. 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.
curl \
--request POST 'http://api.example.com/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-files/new' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/entities/{entity_id}/output-types/{output_type_id}/output-files' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/output-files' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/import/shotgun/shots' \
--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/project' \
--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/status.txt' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/status/test-event' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/news/{news_id}' \
--header "Authorization: $API_KEY"
Desktop login logs can only be created by current user.
curl \
--request GET '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/day/{year}/{month}/{day}' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/persons/{person_id}/day-offs/year/{year}' \
--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"
curl \
--request DELETE 'http://api.example.com/data/playlists/{playlist_id}/jobs/{build_job_id}' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/pictures/thumbnails/attachment-files/{attachment_file_id}.png' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/pictures/thumbnails-square/preview-files/{instance_id}.png' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/pictures/originals/preview-files/{instance_id}.png' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/pictures/originals/preview-files/{instance_id}.{extension}' \
--header "Authorization: $API_KEY"
curl \
--request GET '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"
curl \
--request GET 'http://api.example.com/pictures/preview-background-files/{instance_id}.{extension}' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/data/projects/{project_id}/settings/asset-types' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/settings/status-automations' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/schedule-items' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/shots/{shot_id}/assets' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/scenes/with-tasks' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/sequences/{sequence_id}/tasks' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/persons/{person_id}/tasks' \
--header "Authorization: $API_KEY"
It return only tasks related to open projects.
curl \
--request GET 'http://api.example.com/data/persons/{person_id}/done-tasks' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/entities/{entity_id}/task-types/{task_type_id}/tasks' \
--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"
curl \
--request GET 'http://api.example.com/data/user/assets/{asset_id}/task-types' \
--header "Authorization: $API_KEY"
to it.
curl \
--request GET 'http://api.example.com/data/user/sequences/{sequence_id}/shots' \
--header "Authorization: $API_KEY"
curl \
--request DELETE 'http://api.example.com/actions/user/chats/{entity_id}/join' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/entities/{entity_id}/entities-linked/with-tasks' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/concepts/with-tasks' \
--header "Authorization: $API_KEY"