curl \
--request POST 'http://api.example.com/import/shotgun/projects' \
--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"
curl \
--request DELETE 'http://api.example.com/auth/totp' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/auth/email-otp' \
--header "Authorization: $API_KEY"
Path parameters
-
asset_id
Required
curl \
--request GET 'http://api.example.com/data/assets/{asset_id}/tasks' \
--header "Authorization: $API_KEY"
Retrieve all task types of tasks related to given asset.
Path parameters
-
asset_id
Required
curl \
--request GET 'http://api.example.com/data/assets/{asset_id}/task-types' \
--header "Authorization: $API_KEY"
Path parameters
-
asset_id
Required
curl \
--request PUT 'http://api.example.com/data/assets/{asset_id}/casting' \
--header "Authorization: $API_KEY"
Retrieve all asset types for given project.
Path parameters
-
project_id
Required
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/asset-types' \
--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"
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/task-status/{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/departments' \
--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/attachment-files' \
--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/comments' \
--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/time-spents/{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/schedule-items/{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/milestones/' \
--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/metadata-descriptors/{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/entity-links/{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/chats/{instance_id}' \
--header "Authorization: $API_KEY"
Retrieve all previews related to a given edit.
It sends them as a dict. Keys are related task type ids and values are arrays of preview for this task type.
Path parameters
-
edit_id
Required
curl \
--request GET 'http://api.example.com/data/edits/{edit_id}/preview-files' \
--header "Authorization: $API_KEY"
Retrieve all edits related to a given episode.
Path parameters
-
episode_id
Required
curl \
--request GET 'http://api.example.com/data/episodes/{episode_id}/edits' \
--header "Authorization: $API_KEY"
Create new output file linked to assets through an instance of this asset for a given shot.
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.
Path parameters
-
asset_instance_id
Required -
temporal_entity_id
Required
curl \
--request POST 'http://api.example.com/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-files/new' \
--header "Authorization: $API_KEY"
Get all working files for a given entity and possibly a task and a name.
Path parameters
-
entity_id
Required
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/episodes' \
--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/errors' \
--header "Authorization: $API_KEY"
Import the estimations of task-types for given episode of given project.
Path parameters
-
project_id
Required -
task_type_id
Required -
episode_id
Required
curl \
--request POST 'http://api.example.com/import/csv/projects/{project_id}/episodes/{episode_id}/task-types/{task_type_id}/estimations' \
--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/projects' \
--header "Authorization: $API_KEY"
Query parameters
-
project_id
Required
curl \
--request GET 'http://api.example.com/data/projects/news' \
--header "Authorization: $API_KEY"
Return a csv file containing the presence logs based on a daily basis.
Path parameters
-
month_date
Required
curl \
--request GET 'http://api.example.com/data/persons/presence-logs/{month_date}' \
--header "Authorization: $API_KEY"
Get aggregated time spents for given person and year.
curl \
--request GET 'http://api.example.com/data/persons/{person_id}/time-spents/year/{year}' \
--header "Authorization: $API_KEY"
Return a table giving time spent by user and by week for given year.
Path parameters
-
year
Required
curl \
--request GET 'http://api.example.com/data/persons/time-spents/week-table/{year}' \
--header "Authorization: $API_KEY"
Return all day off recorded for given month and person.
curl \
--request GET 'http://api.example.com/data/persons/{person_id}/day-offs/month/{year}/{month}' \
--header "Authorization: $API_KEY"
Download a generic file preview as attachment.
Path parameters
-
instance_id
Required
curl \
--request GET 'http://api.example.com/pictures/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/projects/{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/preview-background-files/{instance_id}.png' \
--header "Authorization: $API_KEY"
Remove people listed in a production team.
Path parameters
-
project_id
Required -
person_id
Required
curl \
--request DELETE 'http://api.example.com/data/projects/{project_id}/team/{person_id}' \
--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"
Delete a budget for given production
Path parameters
-
project_id
Required -
budget_id
Required
curl \
--request DELETE 'http://api.example.com/data/projects/{project_id}/budgets/{budget_id}' \
--header "Authorization: $API_KEY"
Path parameters
-
scene_id
Required
curl \
--request DELETE 'http://api.example.com/data/scenes/{scene_id}' \
--header "Authorization: $API_KEY"
Path parameters
-
sequence_id
Required
curl \
--request GET 'http://api.example.com/data/sequences/{sequence_id}' \
--header "Authorization: $API_KEY"
Retrieve all sequences related to a given project.
Path parameters
-
project_id
Required
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/sequences' \
--header "Authorization: $API_KEY"
Path parameters
-
project_id
Required
curl \
--request POST 'http://api.example.com/data/projects/{project_id}/sequences' \
--header "Authorization: $API_KEY"
Return tasks related to given asset for current user.
Path parameters
-
asset_id
Required
curl \
--request GET 'http://api.example.com/data/user/assets/{asset_id}/tasks' \
--header "Authorization: $API_KEY"
Return tasks related to given shot for current user.
Path parameters
-
shot_id
Required
curl \
--request GET 'http://api.example.com/data/user/shots/{shot_id}/tasks' \
--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}/tasks' \
--header "Authorization: $API_KEY"
Return shots related to given sequence if the current user has access
to it.
Path parameters
-
sequence_id
Required
curl \
--request GET 'http://api.example.com/data/user/sequences/{sequence_id}/shots' \
--header "Authorization: $API_KEY"
Return tasks currently assigned to current user and of which status has
is_done attribute set to true.
curl \
--request GET 'http://api.example.com/data/user/done-tasks' \
--header "Authorization: $API_KEY"
Retrieve filter groups for current user and only for open projects.
curl \
--request GET 'http://api.example.com/data/user/filter-groups' \
--header "Authorization: $API_KEY"
Create filter group for current user and only for open projects.
curl \
--request POST 'http://api.example.com/data/user/filter-groups' \
--header "Authorization: $API_KEY"
Path parameters
-
entity_id
Required ID of the entity related to the chat
curl \
--request POST 'http://api.example.com/data/entities/{entity_id}/chat/messages' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/concepts' \
--header "Authorization: $API_KEY"
Path parameters
-
concept_id
Required
curl \
--request DELETE 'http://api.example.com/data/concepts/{concept_id}' \
--header "Authorization: $API_KEY"