curl \
--request GET 'http://api.example.com/status/influx' \
--header "Authorization: $API_KEY"
Resource to allow a user to change his password when he forgets it.
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"
Resource to allow a user to change his password when he forgets it.
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/auth/saml/login' \
--header "Authorization: $API_KEY"
Share or unshare all assets (or a list of assets) for given project.
curl \
--request POST 'http://api.example.com/actions/projects/{project_id}/assets/share' \
--header "Authorization: $API_KEY"
Retrieve all shared assets used in project.
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/assets/shared-used' \
--header "Authorization: $API_KEY"
Resource to retrieve the casting of shots from given sequence.
Path parameters
-
project_id
Required -
sequence_id
Required
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/sequences/{sequence_id}/casting' \
--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.
Path parameters
-
project_id
Required
curl \
--request POST 'http://api.example.com/actions/projects/{project_id}/tasks/comment-many' \
--header "Authorization: $API_KEY"
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/persons' \
--header "Authorization: $API_KEY"
Retrieve a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id
Required
curl \
--request GET 'http://api.example.com/data/task-types/{instance_id}' \
--header "Authorization: $API_KEY"
Retrieve a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id
Required
curl \
--request GET 'http://api.example.com/data/file-status/{instance_id}' \
--header "Authorization: $API_KEY"
Update a model with data given in the request body.
JSON format is expected. Model performs the validation automatically when fields are modified.
Path parameters
-
instance_id
Required
curl \
--request PUT 'http://api.example.com/data/softwares/{instance_id}' \
--header "Authorization: $API_KEY"
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/preview-files' \
--header "Authorization: $API_KEY"
Update a model with data given in the request body.
JSON format is expected. Model performs the validation automatically when fields are modified.
Path parameters
-
instance_id
Required
curl \
--request PUT 'http://api.example.com/data/time-spents/{instance_id}' \
--header "Authorization: $API_KEY"
Retrieve all entries for given model.
Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/custom-actions/' \
--header "Authorization: $API_KEY"
Delete a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id
Required
curl \
--request DELETE 'http://api.example.com/data/events/{instance_id}' \
--header "Authorization: $API_KEY"
Retrieve a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id
Required
curl \
--request GET 'http://api.example.com/data/notifications/{instance_id}' \
--header "Authorization: $API_KEY"
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/schedule-items/' \
--header "Authorization: $API_KEY"
Retrieve all entries for given model.
Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/milestones/' \
--header "Authorization: $API_KEY"
Retrieve a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id
Required
curl \
--request GET 'http://api.example.com/data/preview-background-files/{instance_id}' \
--header "Authorization: $API_KEY"
Delete a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id
Required
curl \
--request DELETE 'http://api.example.com/data/preview-background-files/{instance_id}' \
--header "Authorization: $API_KEY"
Retrieve a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id
Required
curl \
--request GET 'http://api.example.com/data/salary-scales/{instance_id}' \
--header "Authorization: $API_KEY"
Retrieve all entries for given model.
Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/plugins' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/edits' \
--header "Authorization: $API_KEY"
Retrieve all time spents linked to a given entity.
Path parameters
-
entity_id
Required
curl \
--request GET 'http://api.example.com/data/entities/{entity_id}/time-spents' \
--header "Authorization: $API_KEY"
Create new output file linked to a given entity.
Output files are linked to entities. 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 entity (an asset, a shot, a sequence, ...). 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. Revision is automatically set.
Path parameters
-
entity_id
Required
curl \
--request POST 'http://api.example.com/data/entities/{entity_id}/output-files/new' \
--header "Authorization: $API_KEY"
Update comment on given working file.
Path parameters
-
working_file_id
Required
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/projects' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/import/shotgun/steps' \
--header "Authorization: $API_KEY"
Path parameters
-
project_id
Required
curl \
--request POST 'http://api.example.com/import/csv/projects/{project_id}/edits' \
--header "Authorization: $API_KEY"
Import the estimations of task-types for given project.
Path parameters
-
project_id
Required -
task_type_id
Required
curl \
--request POST 'http://api.example.com/import/csv/projects/{project_id}/task-types/{task_type_id}/estimations' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/import/kitsu/projects' \
--header "Authorization: $API_KEY"
Retrieve all playlists related to given project.
Path parameters
-
project_id
Required -
playlist_id
Required
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/playlists/{playlist_id}' \
--header "Authorization: $API_KEY"
Download a movie preview.
Path parameters
-
instance_id
Required
curl \
--request GET 'http://api.example.com/movies/originals/preview-files/{instance_id}/download' \
--header "Authorization: $API_KEY"
Download the thumbnail linked to given object instance.
Path parameters
-
instance_id
Required
curl \
--request GET 'http://api.example.com/pictures/thumbnails/organisations/{instance_id}.png' \
--header "Authorization: $API_KEY"
Create a thumbnail for given object instance.
Path parameters
-
instance_id
Required
curl \
--request POST 'http://api.example.com/pictures/thumbnails/organisations/{instance_id}.png' \
--header "Authorization: $API_KEY"
Extract a frame from a preview_file
Path parameters
-
preview_file_id
Required
curl \
--request GET 'http://api.example.com/actions/preview-files/{preview_file_id}/extract-frame' \
--header "Authorization: $API_KEY"
Add an asset type linked to a production.
Path parameters
-
project_id
Required
curl \
--request POST 'http://api.example.com/data/projects/{project_id}/settings/asset-types' \
--header "Authorization: $API_KEY"
Create a new metadata descriptor
It serves to describe extra fields listed in the data attribute of entities.
Path parameters
-
project_id
Required
curl \
--request POST 'http://api.example.com/data/projects/{project_id}/metadata-descriptors' \
--header "Authorization: $API_KEY"
Get a metadata descriptor.
Descriptors serve to describe extra fields listed in the data attribute of entities.
Path parameters
-
project_id
Required -
descriptor_id
Required
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/metadata-descriptors/{descriptor_id}' \
--header "Authorization: $API_KEY"
Retrieve milestones for given production
Path parameters
-
project_id
Required
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/milestones' \
--header "Authorization: $API_KEY"
Path parameters
-
project_id
Required
curl \
--request POST 'http://api.example.com/data/projects/{project_id}/budgets' \
--header "Authorization: $API_KEY"
Retrieve all sequences, adds project name and asset type name and all related tasks.
curl \
--request GET 'http://api.example.com/data/sequences/with-tasks' \
--header "Authorization: $API_KEY"
Retrieve all tasks related to a given shot.
Path parameters
-
sequence_id
Required
curl \
--request GET 'http://api.example.com/data/sequences/{sequence_id}/tasks' \
--header "Authorization: $API_KEY"
Retrieve all task types related to a given shot.
Path parameters
-
sequence_id
Required
curl \
--request GET 'http://api.example.com/data/sequences/{sequence_id}/task-types' \
--header "Authorization: $API_KEY"
Path parameters
-
project_id
Required
curl \
--request POST 'http://api.example.com/data/projects/{project_id}/shots' \
--header "Authorization: $API_KEY"
Query parameters
-
Filter tasks on given project ID
-
Filter tasks on given task status ID
-
Filter tasks on given task type ID ID
-
Filter tasks on given person ID
-
Filter tasks posterior to given start date
-
Filter tasks anterior to given due date
-
Filter tasks on given priority
-
Page number
-
Number of tasks per page
curl \
--request GET 'http://api.example.com/data/tasks/open-tasks' \
--header "Authorization: $API_KEY"
Return tasks related to given entity asset, episode, sequence, shot or scene.
Path parameters
-
entity_id
Required -
task_type_id
Required
curl \
--request GET 'http://api.example.com/data/entities/{entity_id}/task-types/{task_type_id}/tasks' \
--header "Authorization: $API_KEY"
Retrieve all comments to tasks related to given project.
It's mainly used for synchronisation purpose.
Path parameters
-
project_id
Required
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/comments' \
--header "Authorization: $API_KEY"
Retrieve all tasks related to given project.
It's mainly used for synchronisation purpose.
Path parameters
-
project_id
Required
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/tasks' \
--header "Authorization: $API_KEY"
Add preview metadata to given task. The preview file itself should be
uploaded afterward.
Revision is automatically set: it is equal to last revision + 1. It can
be also set manually.
Path parameters
-
task_id
Required -
comment_id
Required
curl \
--request POST 'http://api.example.com/actions/tasks/{task_id}/comments/{comment_id}/add-preview' \
--header "Authorization: $API_KEY"
Add a preview to given comment.
Path parameters
-
task_id
Required -
comment_id
Required -
preview_file_id
Required
curl \
--request POST 'http://api.example.com/actions/tasks/{task_id}/comments/{comment_id}/preview-files/{preview_file_id}' \
--header "Authorization: $API_KEY"
Create a new task for given concept and task type.
Path parameters
-
project_id
Required -
task_type_id
Required
curl \
--request POST 'http://api.example.com/actions/projects/{project_id}/task-types/{task_type_id}/concepts/create-tasks' \
--header "Authorization: $API_KEY"
Create a new task with given task type for each entity of given
entity type.
Path parameters
-
project_id
Required -
task_type_id
Required
curl \
--request POST 'http://api.example.com/actions/projects/{project_id}/task-types/{task_type_id}/create-tasks/{entity_type}/' \
--header "Authorization: $API_KEY"
Return tasks related to given sequence for current user.
Path parameters
-
sequence_id
Required
curl \
--request GET 'http://api.example.com/data/user/sequences/{sequence_id}/task-types' \
--header "Authorization: $API_KEY"
Retrieve filters for current user and only for open projects.
curl \
--request GET 'http://api.example.com/data/user/filters' \
--header "Authorization: $API_KEY"
Update given filter if it's owned by current user.
Path parameters
-
filter_id
Required
curl \
--request PUT 'http://api.example.com/data/user/filters/{filter_id}' \
--header "Authorization: $API_KEY"
Create a desktop login log.
The desktop login log can only be created by the current user.
curl \
--request POST 'http://api.example.com/data/user/desktop-login-logs' \
--header "Authorization: $API_KEY"
Get time spents for current user and given date.
curl \
--request GET 'http://api.example.com/data/user/tasks/{task_id}/time-spents/{date}' \
--header "Authorization: $API_KEY"
Return the list of sequence ids to which the current user has
subscribed for given task type.
Path parameters
-
project_id
Required -
task_type_id
Required
curl \
--request GET 'http://api.example.com/data/user/projects/{project_id}/task-types/{task_type_id}/sequence-subscriptions' \
--header "Authorization: $API_KEY"
Delete chat message.
Path parameters
-
entity_id
Required ID of the entity related to the chat
-
chat_message_id
Required ID of the chat message
curl \
--request DELETE 'http://api.example.com/data/entities/{entity_id}/chat/messages/{chat_message_id}' \
--header "Authorization: $API_KEY"
Retrieve all tasks related to a given concept.
Path parameters
-
concept_id
Required
curl \
--request GET 'http://api.example.com/data/concepts/{concept_id}/tasks' \
--header "Authorization: $API_KEY"