Login is based on email and password. If no user match given email and a destkop ID, it looks in matching the desktop ID with the one stored in database. It is useful for clients that run on desktop tools and that don't know user email.
curl \
--request POST 'http://api.example.com/auth/login' \
--header "Authorization: $API_KEY"Prior to modifying the password, it requires to give the current password (to make sure the user changing the password is not someone who stealed the session). The new password requires a confirmation to ensure that the user didn't make a mistake by typing his new password.
curl \
--request POST 'http://api.example.com/auth/change-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 PUT 'http://api.example.com/data/assets/{asset_id}/casting' \
--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}/assets/shared-used' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/scenes/{scene_id}/camera-instances' \
--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"JSON format is expected. The model performs the validation automatically when instantiated.
curl \
--request POST 'http://api.example.com/data/task-status' \
--header "Authorization: $API_KEY"curl \
--request DELETE '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 DELETE 'http://api.example.com/data/softwares/{instance_id}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/preview-files/{instance_id}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/time-spents/{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"curl \
--request GET '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"curl \
--request GET 'http://api.example.com/data/status-automations/{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/playlists/' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/events/{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/events/{instance_id}' \
--header "Authorization: $API_KEY"Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/notifications/' \
--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"JSON format is expected. Model performs the validation automatically when fields are modified.
curl \
--request PUT 'http://api.example.com/data/notifications/{instance_id}' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/data/notifications/{instance_id}' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/data/news/{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"JSON format is expected. The model performs the validation automatically when instantiated.
curl \
--request POST 'http://api.example.com/data/chats/' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/studios/{instance_id}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/salary-scales' \
--header "Authorization: $API_KEY"Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/plugins' \
--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/{edit_id}/tasks' \
--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}/casting.csv' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/tasks/{task_id}/working-files' \
--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/tasks/{task_id}/working-files/last-revisions' \
--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-files' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/import/shotgun/status' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/import/shotgun/errors' \
--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/shotgun/remove/step' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/import/csv/projects/{project_id}/task-types/{task_type_id}/estimations' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/projects/news' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/persons/{person_id}/time-spents/month/{year}/{month}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/persons/{person_id}/quota-shots/day/{year}/{month}/{day}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/pictures/thumbnails/preview-files/{instance_id}.png' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/pictures/originals/preview-files/{instance_id}/download' \
--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/preview-background-files' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/projects/{project_id}/schedule-items/task-types' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/projects/{project_id}/schedule-items/{task_type_id}/sequences' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/projects/{project_id}/budgets' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/data/projects/{project_id}/budgets' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/scenes/{scene_id}/tasks' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/episodes/{episode_id}/shots' \
--header "Authorization: $API_KEY"