curl \
--request POST 'http://api.example.com/data/project-status' \
--header "Authorization: $API_KEY"
Log in user by creating and registering auth tokens.
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"
Allow the user to change his password.
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"
curl \
--request PUT 'http://api.example.com/auth/totp' \
--header "Authorization: $API_KEY"
curl \
--request DELETE 'http://api.example.com/auth/email-otp' \
--header "Authorization: $API_KEY"
curl \
--request PUT 'http://api.example.com/auth/recovery-codes' \
--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/asset-types' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/asset-types/{asset_type_id}' \
--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/projects/{project_id}/asset-types/{asset_type_id}/assets' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/actions/projects/{project_id}/assets/share' \
--header "Authorization: $API_KEY"
curl \
--request PUT 'http://api.example.com/data/projects/{project_id}/entities/{entity_id}/casting' \
--header "Authorization: $API_KEY"
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"
curl \
--request POST 'http://api.example.com/actions/tasks/{task_id}/comments/{comment_id}/add-attachment' \
--header "Authorization: $API_KEY"
Create several comments at once.
Each comment requires a text, a task id, a task_status and a person as arguments. This way, comments keep history of status changes. When the comment is created, it updates the task status with given task status.
curl \
--request POST 'http://api.example.com/actions/projects/{project_id}/tasks/comment-many' \
--header "Authorization: $API_KEY"
curl \
--request DELETE 'http://api.example.com/data/project-status/{instance_id}' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/entities' \
--header "Authorization: $API_KEY"
curl \
--request DELETE 'http://api.example.com/data/entities/{instance_id}' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/data/task-status' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/departments/{instance_id}' \
--header "Authorization: $API_KEY"
curl \
--request PUT 'http://api.example.com/data/file-status/{instance_id}' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/softwares/{instance_id}' \
--header "Authorization: $API_KEY"
curl \
--request DELETE 'http://api.example.com/data/softwares/{instance_id}' \
--header "Authorization: $API_KEY"
curl \
--request DELETE 'http://api.example.com/data/output-files/{instance_id}' \
--header "Authorization: $API_KEY"
curl \
--request PUT 'http://api.example.com/data/preview-files/{instance_id}' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/data/working-files' \
--header "Authorization: $API_KEY"
curl \
--request PUT 'http://api.example.com/data/attachment-files/{instance_id}' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/comments' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/time-spents/{instance_id}' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/asset-instances/' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/asset-instances/{instance_id}' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/events/{instance_id}' \
--header "Authorization: $API_KEY"
curl \
--request DELETE 'http://api.example.com/data/events/{instance_id}' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/notifications/' \
--header "Authorization: $API_KEY"
curl \
--request PUT 'http://api.example.com/data/notifications/{instance_id}' \
--header "Authorization: $API_KEY"
curl \
--request PUT 'http://api.example.com/data/search-filter-groups/{instance_id}' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/schedule-items/' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/data/schedule-items/' \
--header "Authorization: $API_KEY"
curl \
--request PUT 'http://api.example.com/data/milestones/{instance_id}' \
--header "Authorization: $API_KEY"
curl \
--request DELETE 'http://api.example.com/data/milestones/{instance_id}' \
--header "Authorization: $API_KEY"
curl \
--request DELETE 'http://api.example.com/data/entity-links/{instance_id}' \
--header "Authorization: $API_KEY"
curl \
--request PUT 'http://api.example.com/data/chats/{instance_id}' \
--header "Authorization: $API_KEY"
curl \
--request DELETE 'http://api.example.com/data/chat-messages/{instance_id}' \
--header "Authorization: $API_KEY"
curl \
--request PUT 'http://api.example.com/data/preview-background-files/{instance_id}' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/episodes/{episode_id}/edits' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/data/projects/{project_id}/edits' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/export/csv/projects/{project_id}/casting.csv' \
--header "Authorization: $API_KEY"
Create new working file.
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"
curl \
--request GET 'http://api.example.com/data/working-files/{working_file_id}/file' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/import/shotgun/scenes' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/import/shotgun/steps' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/import/shotgun/projectconnections' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/import/shotgun/remove/person' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/import/shotgun/remove/shot' \
--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/shotgun/remove/note' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/import/otio/projects/{project_id}/episodes/{episode_id}' \
--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/entity-links' \
--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/status/resources' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/persons/day-offs/{year}/{month}' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/playlists' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/episodes/{episode_id}/playlists' \
--header "Authorization: $API_KEY"
curl \
--request GET '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/preview-files/{instance_id}.png' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/pictures/thumbnails/persons/{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 GET '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 POST '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}/milestones' \
--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/projects/{project_id}/schedule-items/{task_type_id}/episodes' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/budgets/{budget_id}/entries/{entry_id}' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/shots/all' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/shots/{shot_id}/preview-files' \
--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}/tasks' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/sequences/{sequence_id}/task-types' \
--header "Authorization: $API_KEY"
curl \
--request DELETE 'http://api.example.com/data/tasks/{task_id}/comments/{comment_id}' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/tasks/{task_id}/full' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/persons/{person_id}/tasks' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/preview-files' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/persons/task-dates' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/actions/tasks/{task_id}/time-spents/{date}' \
--header "Authorization: $API_KEY"
curl \
--request DELETE 'http://api.example.com/actions/tasks/{task_id}/time-spents/{date}/persons/{person_id}' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/actions/projects/{project_id}/task-types/{task_type_id}/edits/create-tasks' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/actions/projects/{project_id}/task-types/{task_type_id}/concepts/create-tasks' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/user/context' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/user/shots/{shot_id}/tasks' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/user/sequences/{sequence_id}/scenes' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/user/filters' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/user/chats' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/entities/{entity_id}/chat/messages' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/entities/{entity_id}/chat/messages/{chat_message_id}' \
--header "Authorization: $API_KEY"
curl \
--request DELETE 'http://api.example.com/data/entities/{entity_id}/chat/messages/{chat_message_id}' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/concepts/{concept_id}' \
--header "Authorization: $API_KEY"