Get time spent on a given task and date.
GET
/actions/tasks/{task_id}/time-spents/{date}
curl \
--request GET 'http://api.example.com/actions/tasks/{task_id}/time-spents/{date}' \
--header "Authorization: $API_KEY"
Log user out by revoking his auth tokens.
Once logged out, current user cannot access the API anymore.
GET
/auth/logout
curl \
--request GET 'http://api.example.com/auth/logout' \
--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.
PUT
/auth/reset-password
curl \
--request PUT 'http://api.example.com/auth/reset-password' \
--header "Authorization: $API_KEY"Path parameters
-
asset_type_id
Required
GET
/data/asset-types/{asset_type_id}
curl \
--request GET 'http://api.example.com/data/asset-types/{asset_type_id}' \
--header "Authorization: $API_KEY"Retrieve all entities that are not shot, sequence, episode, or edit.
Adds project name and asset type name.
GET
/data/assets
curl \
--request GET 'http://api.example.com/data/assets' \
--header "Authorization: $API_KEY"Create new asset with given parameters.
Path parameters
-
project_id
Required -
asset_type_id
Required
POST
/data/projects/{project_id}/asset-types/{asset_type_id}/assets/new
curl \
--request POST 'http://api.example.com/data/projects/{project_id}/asset-types/{asset_type_id}/assets/new' \
--header "Authorization: $API_KEY"Share or unshare all assets for given project and asset type.
POST
/actions/projects/{project_id}/asset-types/{asset_type_id}/assets/share
curl \
--request POST 'http://api.example.com/actions/projects/{project_id}/asset-types/{asset_type_id}/assets/share' \
--header "Authorization: $API_KEY"Resource to retrieve the casting of episodes.
Path parameters
-
project_id
Required
GET
/data/projects/{project_id}/episodes/casting
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/episodes/casting' \
--header "Authorization: $API_KEY"Resource to retrieve the casting of shots from given episode.
Path parameters
-
project_id
Required -
episode_id
Required
GET
/data/projects/{project_id}/episodes/{episode_id}/sequences/all/casting
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/episodes/{episode_id}/sequences/all/casting' \
--header "Authorization: $API_KEY"Creates new comments for given task. Each comments requires a task_id,
text, a task_status and a person as arguments.
POST
/actions/tasks/batch-comment
curl \
--request POST 'http://api.example.com/actions/tasks/batch-comment' \
--header "Authorization: $API_KEY"Delete a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id
Required
DELETE
/data/projects/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/projects/{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
PUT
/data/project-status/{instance_id}
curl \
--request PUT 'http://api.example.com/data/project-status/{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
GET
/data/entity-types/{instance_id}
curl \
--request GET 'http://api.example.com/data/entity-types/{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
DELETE
/data/task-types/{instance_id}
curl \
--request DELETE '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
GET
/data/file-status/{instance_id}
curl \
--request GET 'http://api.example.com/data/file-status/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve a software corresponding at given ID and return it as a
JSON object.
Path parameters
-
software_id
Required
GET
/data/softwares/{instance_id}
curl \
--request GET 'http://api.example.com/data/softwares/{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
PUT
/data/output-types/{instance_id}
curl \
--request PUT 'http://api.example.com/data/output-types/{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.
POST
/data/working-files
curl \
--request POST 'http://api.example.com/data/working-files' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/custom-actions/
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
DELETE
/data/custom-actions/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/custom-actions/{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.
POST
/data/events/
curl \
--request POST 'http://api.example.com/data/events/' \
--header "Authorization: $API_KEY"Retrieve a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id
Required
GET
/data/news/{instance_id}
curl \
--request GET 'http://api.example.com/data/news/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/entity-links/
curl \
--request GET 'http://api.example.com/data/entity-links/' \
--header "Authorization: $API_KEY"Delete a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id
Required
DELETE
/data/preview-background-files/{instance_id}
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
GET
/data/studios/{instance_id}
curl \
--request GET 'http://api.example.com/data/studios/{instance_id}' \
--header "Authorization: $API_KEY"
GET
/data/events/last
curl \
--request GET 'http://api.example.com/data/events/last' \
--header "Authorization: $API_KEY"
GET
/data/events/login-logs/last
curl \
--request GET 'http://api.example.com/data/events/login-logs/last' \
--header "Authorization: $API_KEY"Get information about a file that could be a working file as much as an
output file.
Path parameters
-
file_id
Required
GET
/data/files/{file_id}
curl \
--request GET 'http://api.example.com/data/files/{file_id}' \
--header "Authorization: $API_KEY"Generate a working file path from file tree template.
Generate file path based on several parameters: task, software, mode, revision and separator. Revision can be computed automatically as next revision if not given.
Path parameters
-
task_id
Required
POST
/data/tasks/{task_id}/working-file-path
curl \
--request POST 'http://api.example.com/data/tasks/{task_id}/working-file-path' \
--header "Authorization: $API_KEY"Get last revisions of output files for given instance grouped by output type and file name.
Path parameters
-
asset_instance_id
Required -
temporal_entity_id
Required
Query parameters
-
output_type_id
Required -
task_type_id
Required -
file_status_id
Required -
representation
Required
GET
/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-files/last-revisions
curl \
--request GET 'http://api.example.com/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-files/last-revisions' \
--header "Authorization: $API_KEY"Get all working files for a given entity and possibly a task and a name.
Path parameters
-
entity_id
Required
GET
/data/entities/{entity_id}/working-files
curl \
--request GET 'http://api.example.com/data/entities/{entity_id}/working-files' \
--header "Authorization: $API_KEY"Generate an output file path from file tree template
Generate file path based on several parameters: entity, output type, task type, revision, mode, name and separator. Revision can be computed automatically as next revision if not given.
Path parameters
-
entity_id
Required
POST
/data/entities/{entity_id}/output-file-path
curl \
--request POST 'http://api.example.com/data/entities/{entity_id}/output-file-path' \
--header "Authorization: $API_KEY"Path parameters
-
working_file_id
Required
GET
/data/working-files/{working_file_id}/file
curl \
--request GET 'http://api.example.com/data/working-files/{working_file_id}/file' \
--header "Authorization: $API_KEY"
POST
/import/shotgun/sequences
curl \
--request POST 'http://api.example.com/import/shotgun/sequences' \
--header "Authorization: $API_KEY"
POST
/import/shotgun/remove/scene
curl \
--request POST 'http://api.example.com/import/shotgun/remove/scene' \
--header "Authorization: $API_KEY"
POST
/import/shotgun/remove/version
curl \
--request POST 'http://api.example.com/import/shotgun/remove/version' \
--header "Authorization: $API_KEY"
GET
/stats
curl \
--request GET 'http://api.example.com/stats' \
--header "Authorization: $API_KEY"Get aggregated time spents for given person and year.
GET
/data/persons/{person_id}/time-spents/year/{year}
curl \
--request GET 'http://api.example.com/data/persons/{person_id}/time-spents/year/{year}' \
--header "Authorization: $API_KEY"Create a thumbnail for given object instance.
Path parameters
-
instance_id
Required
POST
/pictures/thumbnails/organisations/{instance_id}
curl \
--request POST 'http://api.example.com/pictures/thumbnails/organisations/{instance_id}' \
--header "Authorization: $API_KEY"Download the thumbnail linked to given object instance.
Path parameters
-
instance_id
Required
GET
/pictures/thumbnails/organisations/{instance_id}.png
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
POST
/pictures/thumbnails/persons/{instance_id}.png
curl \
--request POST 'http://api.example.com/pictures/thumbnails/persons/{instance_id}.png' \
--header "Authorization: $API_KEY"Extract a frame from a preview_file
Path parameters
-
preview_file_id
Required
GET
/actions/preview-files/{preview_file_id}/extract-frame
curl \
--request GET 'http://api.example.com/actions/preview-files/{preview_file_id}/extract-frame' \
--header "Authorization: $API_KEY"Retrieve episodes schedule items for given task type
Path parameters
-
project_id
Required -
task_type_id
Required
GET
/data/projects/{project_id}/schedule-items/{task_type_id}/episodes
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/schedule-items/{task_type_id}/episodes' \
--header "Authorization: $API_KEY"Path parameters
-
project_id
Required
GET
/data/projects/{project_id}/budgets
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/budgets' \
--header "Authorization: $API_KEY"Delete a budget entry for given production and budget.
Path parameters
-
project_id
Required -
budget_id
Required -
entry_id
Required
DELETE
/data/projects/{project_id}/budgets/{budget_id}/entries/{entry_id}
curl \
--request DELETE 'http://api.example.com/data/projects/{project_id}/budgets/{budget_id}/entries/{entry_id}' \
--header "Authorization: $API_KEY"Retrieve all assets tasks related to a given episode.
Path parameters
-
episode_id
Required
GET
/data/episodes/{episode_id}/asset-tasks
curl \
--request GET 'http://api.example.com/data/episodes/{episode_id}/asset-tasks' \
--header "Authorization: $API_KEY"Path parameters
-
sequence_id
Required
DELETE
/data/sequences/{sequence_id}
curl \
--request DELETE 'http://api.example.com/data/sequences/{sequence_id}' \
--header "Authorization: $API_KEY"