Kitsu API
0.20.55
Base URL
http://api.example.comWelcome to the Kitsu API specification
Version: 0.20.55
The Kitsu API allows to store and manage the data of your animation/VFX production. Through it you can link all the tools of your pipeline and make sure they are all synchronized.
An easy to use Python client to access this API is available: Python Kitsu Client documentation
Authentication
Before you can use any of the endpoints outline below, you will have to get a JWT token to authorize your requests.
You will find the information to retrieve it in the Zou documentation.
This is version 0.20.55 of this API documentation.
Last update on Jun 17, 2025.
This API is provided under license AGPL 3.0.
Authentication
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.
POST
/auth/login
curl \
--request POST 'http://api.example.com/auth/login' \
--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"Returns information if the user is authenticated else it returns a 401
response.
GET
/auth/authenticated
curl \
--request GET 'http://api.example.com/auth/authenticated' \
--header "Authorization: $API_KEY"
POST
/auth/register
curl \
--request POST 'http://api.example.com/auth/register' \
--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.
POST
/auth/change-password
curl \
--request POST 'http://api.example.com/auth/change-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.
PUT
/auth/reset-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.
POST
/auth/reset-password
curl \
--request POST 'http://api.example.com/auth/reset-password' \
--header "Authorization: $API_KEY"Tokens are considered as outdated every two weeks.
This route allows to make their lifetime long before they get outdated.
GET
/auth/refresh-token
curl \
--request GET 'http://api.example.com/auth/refresh-token' \
--header "Authorization: $API_KEY"
PUT
/auth/totp
curl \
--request PUT 'http://api.example.com/auth/totp' \
--header "Authorization: $API_KEY"
POST
/auth/totp
curl \
--request POST 'http://api.example.com/auth/totp' \
--header "Authorization: $API_KEY"
DELETE
/auth/totp
curl \
--request DELETE 'http://api.example.com/auth/totp' \
--header "Authorization: $API_KEY"
GET
/auth/email-otp
curl \
--request GET 'http://api.example.com/auth/email-otp' \
--header "Authorization: $API_KEY"
PUT
/auth/email-otp
curl \
--request PUT 'http://api.example.com/auth/email-otp' \
--header "Authorization: $API_KEY"
POST
/auth/email-otp
curl \
--request POST 'http://api.example.com/auth/email-otp' \
--header "Authorization: $API_KEY"
DELETE
/auth/email-otp
curl \
--request DELETE 'http://api.example.com/auth/email-otp' \
--header "Authorization: $API_KEY"
PUT
/auth/recovery-codes
curl \
--request PUT 'http://api.example.com/auth/recovery-codes' \
--header "Authorization: $API_KEY"
GET
/auth/fido
curl \
--request GET 'http://api.example.com/auth/fido' \
--header "Authorization: $API_KEY"
PUT
/auth/fido
curl \
--request PUT 'http://api.example.com/auth/fido' \
--header "Authorization: $API_KEY"
POST
/auth/fido
curl \
--request POST 'http://api.example.com/auth/fido' \
--header "Authorization: $API_KEY"
DELETE
/auth/fido
curl \
--request DELETE 'http://api.example.com/auth/fido' \
--header "Authorization: $API_KEY"
POST
/auth/saml/sso
curl \
--request POST 'http://api.example.com/auth/saml/sso' \
--header "Authorization: $API_KEY"
GET
/auth/saml/login
curl \
--request GET 'http://api.example.com/auth/saml/login' \
--header "Authorization: $API_KEY"Retrieve all asset types (entity types that are not shot, sequence or episode).
GET
/data/asset-types
curl \
--request GET 'http://api.example.com/data/asset-types' \
--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"Retrieve all entities that are not shot, sequence, episode, or edit.
Adds project name and asset type name.
GET
/data/assets/all
curl \
--request GET 'http://api.example.com/data/assets/all' \
--header "Authorization: $API_KEY"Retrieve all entities that are not shot, sequence, episode, or edit.
Adds project name and asset type name and all related tasks.
If episode_id is given as parameter, it returns assets not linked
to an episode and assets linked to given episode.
GET
/data/assets/with-tasks
curl \
--request GET 'http://api.example.com/data/assets/with-tasks' \
--header "Authorization: $API_KEY"Path parameters
-
asset_id
Required
GET
/data/assets/{asset_id}
curl \
--request GET 'http://api.example.com/data/assets/{asset_id}' \
--header "Authorization: $API_KEY"Path parameters
-
asset_id
Required
DELETE
/data/assets/{asset_id}
curl \
--request DELETE 'http://api.example.com/data/assets/{asset_id}' \
--header "Authorization: $API_KEY"Path parameters
-
asset_id
Required
GET
/data/assets/{asset_id}/assets
curl \
--request GET 'http://api.example.com/data/assets/{asset_id}/assets' \
--header "Authorization: $API_KEY"Path parameters
-
asset_id
Required
GET
/data/assets/{asset_id}/tasks
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
GET
/data/assets/{asset_id}/task-types
curl \
--request GET 'http://api.example.com/data/assets/{asset_id}/task-types' \
--header "Authorization: $API_KEY"Retrieve the list of shots that cast given asset.
Path parameters
-
asset_id
Required
GET
/data/assets/{asset_id}/cast-in
curl \
--request GET 'http://api.example.com/data/assets/{asset_id}/cast-in' \
--header "Authorization: $API_KEY"Path parameters
-
asset_id
Required
GET
/data/assets/{asset_id}/casting
curl \
--request GET 'http://api.example.com/data/assets/{asset_id}/casting' \
--header "Authorization: $API_KEY"Path parameters
-
asset_id
Required
PUT
/data/assets/{asset_id}/casting
curl \
--request PUT 'http://api.example.com/data/assets/{asset_id}/casting' \
--header "Authorization: $API_KEY"Retrieve all shot asset instances linked to given asset.
Path parameters
-
asset_id
Required
GET
/data/assets/{asset_id}/shot-asset-instances
curl \
--request GET 'http://api.example.com/data/assets/{asset_id}/shot-asset-instances' \
--header "Authorization: $API_KEY"Retrieve all scene asset instances linked to given asset.
Path parameters
-
asset_id
Required
GET
/data/assets/{asset_id}/scene-asset-instances
curl \
--request GET 'http://api.example.com/data/assets/{asset_id}/scene-asset-instances' \
--header "Authorization: $API_KEY"Retrieve all asset instances instantiated inside given asset.
Path parameters
-
asset_id
Required
GET
/data/assets/{asset_id}/asset-asset-instances
curl \
--request GET 'http://api.example.com/data/assets/{asset_id}/asset-asset-instances' \
--header "Authorization: $API_KEY"Create an asset instance inside given asset.
Path parameters
-
asset_id
Required
POST
/data/assets/{asset_id}/asset-asset-instances
curl \
--request POST 'http://api.example.com/data/assets/{asset_id}/asset-asset-instances' \
--header "Authorization: $API_KEY"Retrieve all assets for given project and asset type.
Path parameters
-
project_id
Required -
asset_type_id
Required
GET
/data/projects/{project_id}/asset-types/{asset_type_id}/assets
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/asset-types/{asset_type_id}/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"Retrieve all asset types for given project.
Path parameters
-
project_id
Required
GET
/data/projects/{project_id}/asset-types
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/asset-types' \
--header "Authorization: $API_KEY"Retrieve all asset types of assets casted in given shot.
Path parameters
-
shot_id
Required
GET
/data/shots/{shot_id}/asset-types
curl \
--request GET 'http://api.example.com/data/shots/{shot_id}/asset-types' \
--header "Authorization: $API_KEY"Path parameters
-
project_id
Required
GET
/data/projects/{project_id}/assets
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/assets' \
--header "Authorization: $API_KEY"
POST
/actions/assets/share
curl \
--request POST 'http://api.example.com/actions/assets/share' \
--header "Authorization: $API_KEY"Share or unshare all assets (or a list of assets) for given project.
POST
/actions/projects/{project_id}/assets/share
curl \
--request POST 'http://api.example.com/actions/projects/{project_id}/assets/share' \
--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"Retrieve all shared assets used in project.
GET
/data/projects/{project_id}/assets/shared-used
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/assets/shared-used' \
--header "Authorization: $API_KEY"Retrieve all shared assets used in project episode.
GET
/data/projects/{project_id}/episodes/{episode_id}/assets/shared-used
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/episodes/{episode_id}/assets/shared-used' \
--header "Authorization: $API_KEY"Resource to retrieve the casting of a given entity.
Path parameters
-
project_id
Required -
entity_id
Required
GET
/data/projects/{project_id}/entities/{entity_id}/casting
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/entities/{entity_id}/casting' \
--header "Authorization: $API_KEY"Resource to allow the modification of assets linked to an entity.
Path parameters
-
project_id
Required -
entity_id
Required
PUT
/data/projects/{project_id}/entities/{entity_id}/casting
curl \
--request PUT 'http://api.example.com/data/projects/{project_id}/entities/{entity_id}/casting' \
--header "Authorization: $API_KEY"Resource to retrieve the casting of assets from given asset type.
Path parameters
-
project_id
Required -
asset_type_id
Required
GET
/data/projects/{project_id}/asset-types/{asset_type_id}/casting
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/asset-types/{asset_type_id}/casting' \
--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 sequence.
Path parameters
-
project_id
Required -
sequence_id
Required
GET
/data/projects/{project_id}/sequences/{sequence_id}/casting
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/sequences/{sequence_id}/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"Resource to retrieve the casting of shots from all sequences of given
project.
Path parameters
-
project_id
Required
GET
/data/projects/{project_id}/sequences/all/casting
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/sequences/all/casting' \
--header "Authorization: $API_KEY"Retrieve all entity links related to given project.
Results can be paginated using page and limit query parameters. If you
prefer a more accurate pagination, you can use and
cursor_created_at to get the next page.
Path parameters
-
project_id
Required
GET
/data/projects/{project_id}/entity-links
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/entity-links' \
--header "Authorization: $API_KEY"Delete given entity link.
It's mainly used for synchronisation purpose.
Path parameters
-
project_id
Required -
entity_link_id
Required
DELETE
/data/projects/{project_id}/entity-links/{entity_link_id}
curl \
--request DELETE 'http://api.example.com/data/projects/{project_id}/entity-links/{entity_link_id}' \
--header "Authorization: $API_KEY"Retrieve all asset instances linked to scene.
Path parameters
-
scene_id
Required
GET
/data/scenes/{scene_id}/asset-instances
curl \
--request GET 'http://api.example.com/data/scenes/{scene_id}/asset-instances' \
--header "Authorization: $API_KEY"Create an asset instance on given scene.
Path parameters
-
scene_id
Required
POST
/data/scenes/{scene_id}/asset-instances
curl \
--request POST 'http://api.example.com/data/scenes/{scene_id}/asset-instances' \
--header "Authorization: $API_KEY"Retrieve all camera instances linked to scene.
Path parameters
-
scene_id
Required
GET
/data/scenes/{scene_id}/camera-instances
curl \
--request GET 'http://api.example.com/data/scenes/{scene_id}/camera-instances' \
--header "Authorization: $API_KEY"Retrieve all asset instances linked to shot.
Path parameters
-
shot_id
Required
GET
/data/shots/{shot_id}/asset-instances
curl \
--request GET 'http://api.example.com/data/shots/{shot_id}/asset-instances' \
--header "Authorization: $API_KEY"Path parameters
-
shot_id
Required
POST
/data/shots/{shot_id}/asset-instances
curl \
--request POST 'http://api.example.com/data/shots/{shot_id}/asset-instances' \
--header "Authorization: $API_KEY"Remove an asset instance from given shot.
Path parameters
-
shot_id
Required -
asset_instance_id
Required
DELETE
/data/shots/{shot_id}/asset-instances/{asset_instance_id}
curl \
--request DELETE 'http://api.example.com/data/shots/{shot_id}/asset-instances/{asset_instance_id}' \
--header "Authorization: $API_KEY"Acknowledge given comment.
If it's already acknowledged, remove acknowledgement.
Path parameters
-
task_id
Required -
comment_id
Required
POST
/data/tasks/{task_id}/comments/{comment_id}/ack
curl \
--request POST 'http://api.example.com/data/tasks/{task_id}/comments/{comment_id}/ack' \
--header "Authorization: $API_KEY"Reply to given comment.
Add comment to its replies list.
Path parameters
-
task_id
Required -
comment_id
Required
POST
/data/tasks/{task_id}/comments/{comment_id}/reply
curl \
--request POST 'http://api.example.com/data/tasks/{task_id}/comments/{comment_id}/reply' \
--header "Authorization: $API_KEY"Delete attachment linked to a comment matching given ID.
Path parameters
-
task_id
Required -
comment_id
Required -
attachment_id
Required
DELETE
/data/tasks/{task_id}/comments/{comment_id}/attachments/{attachment_id}
curl \
--request DELETE 'http://api.example.com/data/tasks/{task_id}/comments/{comment_id}/attachments/{attachment_id}' \
--header "Authorization: $API_KEY"Delete given comment reply.
Path parameters
-
task_id
Required -
comment_id
Required -
reply_id
Required
DELETE
/data/tasks/{task_id}/comments/{comment_id}/reply/{reply_id}
curl \
--request DELETE 'http://api.example.com/data/tasks/{task_id}/comments/{comment_id}/reply/{reply_id}' \
--header "Authorization: $API_KEY"Download attachment file.
Path parameters
-
attachment_file_id
Required -
file_name
Required
GET
/data/attachment-files/{attachment_file_id}/file/{file_name}
curl \
--request GET 'http://api.example.com/data/attachment-files/{attachment_file_id}/file/{file_name}' \
--header "Authorization: $API_KEY"Add given files to the comment entry as attachments.
Path parameters
-
task_id
Required -
comment_id
Required
POST
/actions/tasks/{task_id}/comments/{comment_id}/add-attachment
curl \
--request POST 'http://api.example.com/actions/tasks/{task_id}/comments/{comment_id}/add-attachment' \
--header "Authorization: $API_KEY"Return all attachment files related to given project.
Path parameters
-
project_id
Required
GET
/data/projects/{project_id}/attachment-files
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/attachment-files' \
--header "Authorization: $API_KEY"Return all attachment files related to given task.
Path parameters
-
task_id
Required
GET
/data/tasks/{task_id}/attachment-files
curl \
--request GET 'http://api.example.com/data/tasks/{task_id}/attachment-files' \
--header "Authorization: $API_KEY"Create a new comment for given task.
It requires a text, 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
-
task_id
Required
POST
/actions/tasks/{task_id}/comment
curl \
--request POST 'http://api.example.com/actions/tasks/{task_id}/comment' \
--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
POST
/actions/projects/{project_id}/tasks/comment-many
curl \
--request POST 'http://api.example.com/actions/projects/{project_id}/tasks/comment-many' \
--header "Authorization: $API_KEY"Creates new comments for given task. Each comments requires a text, a
task_status and a person as arguments.
Path parameters
-
task_id
Required
POST
/actions/tasks/{task_id}/batch-comment
curl \
--request POST 'http://api.example.com/actions/tasks/{task_id}/batch-comment' \
--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"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/persons
curl \
--request GET 'http://api.example.com/data/persons' \
--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/persons
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
GET
/data/persons/{instance_id}
curl \
--request GET 'http://api.example.com/data/persons/{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/persons/{instance_id}
curl \
--request PUT 'http://api.example.com/data/persons/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/projects
curl \
--request GET 'http://api.example.com/data/projects' \
--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/projects
curl \
--request POST 'http://api.example.com/data/projects' \
--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/projects/{instance_id}
curl \
--request GET '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/projects/{instance_id}
curl \
--request PUT 'http://api.example.com/data/projects/{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/projects/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/projects/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/project-status
curl \
--request GET 'http://api.example.com/data/project-status' \
--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/project-status
curl \
--request POST 'http://api.example.com/data/project-status' \
--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/project-status/{instance_id}
curl \
--request GET 'http://api.example.com/data/project-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
PUT
/data/project-status/{instance_id}
curl \
--request PUT 'http://api.example.com/data/project-status/{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/project-status/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/project-status/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/entity-types
curl \
--request GET 'http://api.example.com/data/entity-types' \
--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/entity-types
curl \
--request POST 'http://api.example.com/data/entity-types' \
--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"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/entity-types/{instance_id}
curl \
--request PUT '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/entity-types/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/entity-types/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/entities
curl \
--request GET 'http://api.example.com/data/entities' \
--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/entities
curl \
--request POST 'http://api.example.com/data/entities' \
--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/entities/{instance_id}
curl \
--request GET 'http://api.example.com/data/entities/{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/entities/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/entities/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/task-types
curl \
--request GET 'http://api.example.com/data/task-types' \
--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/task-types
curl \
--request POST 'http://api.example.com/data/task-types' \
--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/task-types/{instance_id}
curl \
--request GET 'http://api.example.com/data/task-types/{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/task-types/{instance_id}
curl \
--request PUT 'http://api.example.com/data/task-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 all entries for given model.
Filters can be specified in the query string.
GET
/data/task-status
curl \
--request GET 'http://api.example.com/data/task-status' \
--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/task-status
curl \
--request POST 'http://api.example.com/data/task-status' \
--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/task-status/{instance_id}
curl \
--request GET 'http://api.example.com/data/task-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
PUT
/data/task-status/{instance_id}
curl \
--request PUT 'http://api.example.com/data/task-status/{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-status/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/task-status/{instance_id}' \
--header "Authorization: $API_KEY"
GET
/data/tasks
curl \
--request GET 'http://api.example.com/data/tasks' \
--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/tasks/{instance_id}
curl \
--request GET 'http://api.example.com/data/tasks/{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/tasks/{instance_id}
curl \
--request PUT 'http://api.example.com/data/tasks/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/departments
curl \
--request GET 'http://api.example.com/data/departments' \
--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/departments
curl \
--request POST 'http://api.example.com/data/departments' \
--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/departments/{instance_id}
curl \
--request GET 'http://api.example.com/data/departments/{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/departments/{instance_id}
curl \
--request PUT 'http://api.example.com/data/departments/{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/departments/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/departments/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/organisations
curl \
--request GET 'http://api.example.com/data/organisations' \
--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/organisations
curl \
--request POST 'http://api.example.com/data/organisations' \
--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/organisations/{instance_id}
curl \
--request GET 'http://api.example.com/data/organisations/{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/organisations/{instance_id}
curl \
--request PUT 'http://api.example.com/data/organisations/{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/organisations/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/organisations/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/file-status/
curl \
--request GET 'http://api.example.com/data/file-status/' \
--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/file-status/
curl \
--request POST 'http://api.example.com/data/file-status/' \
--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"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/file-status/{instance_id}
curl \
--request PUT 'http://api.example.com/data/file-status/{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/file-status/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/file-status/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/softwares
curl \
--request GET 'http://api.example.com/data/softwares' \
--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/softwares
curl \
--request POST 'http://api.example.com/data/softwares' \
--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/softwares/{instance_id}
curl \
--request PUT 'http://api.example.com/data/softwares/{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/softwares/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/softwares/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/output-files
curl \
--request GET 'http://api.example.com/data/output-files' \
--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/output-files
curl \
--request POST 'http://api.example.com/data/output-files' \
--header "Authorization: $API_KEY"Retrieve a model corresponding at given ID and return it as a JSON
object.
Path parameters
-
output_file_id
Required
GET
/data/output-files/{instance_id}
curl \
--request GET 'http://api.example.com/data/output-files/{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-files/{instance_id}
curl \
--request PUT 'http://api.example.com/data/output-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
DELETE
/data/output-files/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/output-files/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/output-types
curl \
--request GET 'http://api.example.com/data/output-types' \
--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/output-types
curl \
--request POST 'http://api.example.com/data/output-types' \
--header "Authorization: $API_KEY"Retrieve an output type corresponding at given ID and return it as a
JSON object.
Path parameters
-
output_type_id
Required
GET
/data/output-types/{instance_id}
curl \
--request GET 'http://api.example.com/data/output-types/{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"Delete a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id
Required
DELETE
/data/output-types/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/output-types/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/preview-files
curl \
--request GET 'http://api.example.com/data/preview-files' \
--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/preview-files
curl \
--request POST 'http://api.example.com/data/preview-files' \
--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/preview-files/{instance_id}
curl \
--request GET 'http://api.example.com/data/preview-files/{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/preview-files/{instance_id}
curl \
--request PUT 'http://api.example.com/data/preview-files/{instance_id}' \
--header "Authorization: $API_KEY"Delete a preview file corresponding at given ID and retuns
a 204 status code.
Path parameters
-
instance_id
Required
DELETE
/data/preview-files/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/preview-files/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/working-files
curl \
--request GET 'http://api.example.com/data/working-files' \
--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 a working file corresponding at given ID and return it as a
JSON object.
Path parameters
-
working_file_id
Required
GET
/data/working-files/{instance_id}
curl \
--request GET 'http://api.example.com/data/working-files/{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/working-files/{instance_id}
curl \
--request PUT 'http://api.example.com/data/working-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
DELETE
/data/working-files/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/working-files/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/attachment-files
curl \
--request GET 'http://api.example.com/data/attachment-files' \
--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/attachment-files
curl \
--request POST 'http://api.example.com/data/attachment-files' \
--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/attachment-files/{instance_id}
curl \
--request GET 'http://api.example.com/data/attachment-files/{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/attachment-files/{instance_id}
curl \
--request PUT 'http://api.example.com/data/attachment-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
DELETE
/data/attachment-files/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/attachment-files/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/comments
curl \
--request GET 'http://api.example.com/data/comments' \
--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/comments
curl \
--request POST '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
GET
/data/comments/{instance_id}
curl \
--request GET 'http://api.example.com/data/comments/{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/comments/{instance_id}
curl \
--request PUT 'http://api.example.com/data/comments/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/time-spents/
curl \
--request GET 'http://api.example.com/data/time-spents/' \
--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/time-spents/
curl \
--request POST 'http://api.example.com/data/time-spents/' \
--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/time-spents/{instance_id}
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
PUT
/data/time-spents/{instance_id}
curl \
--request PUT 'http://api.example.com/data/time-spents/{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/time-spents/{instance_id}
curl \
--request DELETE '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.
GET
/data/day-offs/
curl \
--request GET 'http://api.example.com/data/day-offs/' \
--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/day-offs/
curl \
--request POST 'http://api.example.com/data/day-offs/' \
--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/day-offs/{instance_id}
curl \
--request GET 'http://api.example.com/data/day-offs/{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/day-offs/{instance_id}
curl \
--request PUT 'http://api.example.com/data/day-offs/{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/day-offs/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/day-offs/{instance_id}' \
--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"Create a model with data given in the request body.
JSON format is expected. The model performs the validation automatically when instantiated.
POST
/data/custom-actions/
curl \
--request POST 'http://api.example.com/data/custom-actions/' \
--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/custom-actions/{instance_id}
curl \
--request GET 'http://api.example.com/data/custom-actions/{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/custom-actions/{instance_id}
curl \
--request PUT 'http://api.example.com/data/custom-actions/{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/custom-actions/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/custom-actions/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/status-automations/
curl \
--request GET 'http://api.example.com/data/status-automations/' \
--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/status-automations/
curl \
--request POST 'http://api.example.com/data/status-automations/' \
--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/status-automations/{instance_id}
curl \
--request GET 'http://api.example.com/data/status-automations/{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/status-automations/{instance_id}
curl \
--request PUT 'http://api.example.com/data/status-automations/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/asset-instances/
curl \
--request GET 'http://api.example.com/data/asset-instances/' \
--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/asset-instances/
curl \
--request POST 'http://api.example.com/data/asset-instances/' \
--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/asset-instances/{instance_id}
curl \
--request GET 'http://api.example.com/data/asset-instances/{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/asset-instances/{instance_id}
curl \
--request PUT 'http://api.example.com/data/asset-instances/{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/asset-instances/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/asset-instances/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/playlists/
curl \
--request GET 'http://api.example.com/data/playlists/' \
--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/playlists/
curl \
--request POST 'http://api.example.com/data/playlists/' \
--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/playlists/{instance_id}
curl \
--request GET 'http://api.example.com/data/playlists/{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/playlists/{instance_id}
curl \
--request PUT 'http://api.example.com/data/playlists/{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/playlists/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/playlists/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/events/
curl \
--request GET 'http://api.example.com/data/events/' \
--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/events/{instance_id}
curl \
--request GET 'http://api.example.com/data/events/{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/events/{instance_id}
curl \
--request PUT 'http://api.example.com/data/events/{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/events/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/events/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/notifications/
curl \
--request GET 'http://api.example.com/data/notifications/' \
--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/notifications/
curl \
--request POST 'http://api.example.com/data/notifications/' \
--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/notifications/{instance_id}
curl \
--request GET 'http://api.example.com/data/notifications/{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/notifications/{instance_id}
curl \
--request PUT 'http://api.example.com/data/notifications/{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/notifications/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/notifications/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/search-filters/
curl \
--request GET 'http://api.example.com/data/search-filters/' \
--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/search-filters/
curl \
--request POST 'http://api.example.com/data/search-filters/' \
--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/search-filters/{instance_id}
curl \
--request GET 'http://api.example.com/data/search-filters/{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/search-filters/{instance_id}
curl \
--request PUT 'http://api.example.com/data/search-filters/{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/search-filters/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/search-filters/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/search-filter-groups/
curl \
--request GET 'http://api.example.com/data/search-filter-groups/' \
--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/search-filter-groups/
curl \
--request POST 'http://api.example.com/data/search-filter-groups/' \
--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/search-filter-groups/{instance_id}
curl \
--request GET 'http://api.example.com/data/search-filter-groups/{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/search-filter-groups/{instance_id}
curl \
--request PUT 'http://api.example.com/data/search-filter-groups/{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/search-filter-groups/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/search-filter-groups/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/schedule-items/
curl \
--request GET 'http://api.example.com/data/schedule-items/' \
--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/schedule-items/
curl \
--request POST 'http://api.example.com/data/schedule-items/' \
--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/schedule-items/{instance_id}
curl \
--request GET 'http://api.example.com/data/schedule-items/{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/schedule-items/{instance_id}
curl \
--request PUT 'http://api.example.com/data/schedule-items/{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/schedule-items/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/schedule-items/{instance_id}' \
--header "Authorization: $API_KEY"
GET
/data/news/
curl \
--request GET 'http://api.example.com/data/news/' \
--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/news/
curl \
--request POST 'http://api.example.com/data/news/' \
--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"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/news/{instance_id}
curl \
--request PUT 'http://api.example.com/data/news/{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/news/{instance_id}
curl \
--request DELETE '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/milestones/
curl \
--request GET 'http://api.example.com/data/milestones/' \
--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/milestones/
curl \
--request POST '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
GET
/data/milestones/{instance_id}
curl \
--request GET 'http://api.example.com/data/milestones/{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/milestones/{instance_id}
curl \
--request PUT 'http://api.example.com/data/milestones/{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/milestones/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/milestones/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/metadata-descriptors/
curl \
--request GET 'http://api.example.com/data/metadata-descriptors/' \
--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/metadata-descriptors/
curl \
--request POST 'http://api.example.com/data/metadata-descriptors/' \
--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/metadata-descriptors/{instance_id}
curl \
--request GET 'http://api.example.com/data/metadata-descriptors/{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/metadata-descriptors/{instance_id}
curl \
--request PUT 'http://api.example.com/data/metadata-descriptors/{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/metadata-descriptors/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/metadata-descriptors/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/subscriptions/
curl \
--request GET 'http://api.example.com/data/subscriptions/' \
--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/subscriptions/
curl \
--request POST 'http://api.example.com/data/subscriptions/' \
--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/subscriptions/{instance_id}
curl \
--request GET 'http://api.example.com/data/subscriptions/{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/subscriptions/{instance_id}
curl \
--request PUT 'http://api.example.com/data/subscriptions/{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/subscriptions/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/subscriptions/{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"Create a model with data given in the request body.
JSON format is expected. The model performs the validation automatically when instantiated.
POST
/data/entity-links/
curl \
--request POST 'http://api.example.com/data/entity-links/' \
--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-links/{instance_id}
curl \
--request GET 'http://api.example.com/data/entity-links/{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/entity-links/{instance_id}
curl \
--request PUT 'http://api.example.com/data/entity-links/{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/entity-links/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/entity-links/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/chats/
curl \
--request GET 'http://api.example.com/data/chats/' \
--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/chats/
curl \
--request POST 'http://api.example.com/data/chats/' \
--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/chats/{instance_id}
curl \
--request GET 'http://api.example.com/data/chats/{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/chats/{instance_id}
curl \
--request PUT 'http://api.example.com/data/chats/{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/chats/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/chats/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/chat-messages/
curl \
--request GET 'http://api.example.com/data/chat-messages/' \
--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/chat-messages/
curl \
--request POST 'http://api.example.com/data/chat-messages/' \
--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/chat-messages/{instance_id}
curl \
--request GET 'http://api.example.com/data/chat-messages/{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/chat-messages/{instance_id}
curl \
--request PUT 'http://api.example.com/data/chat-messages/{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/chat-messages/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/chat-messages/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/preview-background-files
curl \
--request GET 'http://api.example.com/data/preview-background-files' \
--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/preview-background-files
curl \
--request POST 'http://api.example.com/data/preview-background-files' \
--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/preview-background-files/{instance_id}
curl \
--request GET 'http://api.example.com/data/preview-background-files/{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/preview-background-files/{instance_id}
curl \
--request PUT '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
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 all entries for given model.
Filters can be specified in the query string.
GET
/data/studios
curl \
--request GET 'http://api.example.com/data/studios' \
--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/studios
curl \
--request POST 'http://api.example.com/data/studios' \
--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"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/studios/{instance_id}
curl \
--request PUT 'http://api.example.com/data/studios/{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/studios/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/studios/{instance_id}' \
--header "Authorization: $API_KEY"
GET
/data/salary-scales
curl \
--request GET 'http://api.example.com/data/salary-scales' \
--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/salary-scales
curl \
--request POST 'http://api.example.com/data/salary-scales' \
--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/salary-scales/{instance_id}
curl \
--request GET 'http://api.example.com/data/salary-scales/{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/salary-scales/{instance_id}
curl \
--request PUT 'http://api.example.com/data/salary-scales/{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/salary-scales/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/salary-scales/{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/plugins/{instance_id}
curl \
--request GET 'http://api.example.com/data/plugins/{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/plugins/{instance_id}
curl \
--request PUT 'http://api.example.com/data/plugins/{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/plugins/{instance_id}
curl \
--request DELETE 'http://api.example.com/data/plugins/{instance_id}' \
--header "Authorization: $API_KEY"Retrieve all entries for given model.
Filters can be specified in the query string.
GET
/data/plugins
curl \
--request GET 'http://api.example.com/data/plugins' \
--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/plugins
curl \
--request POST 'http://api.example.com/data/plugins' \
--header "Authorization: $API_KEY"
GET
/data/edits
curl \
--request GET 'http://api.example.com/data/edits' \
--header "Authorization: $API_KEY"
GET
/data/edits/all
curl \
--request GET 'http://api.example.com/data/edits/all' \
--header "Authorization: $API_KEY"Retrieve all edits, adds project name and all related tasks.
GET
/data/edits/with-tasks
curl \
--request GET 'http://api.example.com/data/edits/with-tasks' \
--header "Authorization: $API_KEY"Path parameters
-
edit_id
Required
GET
/data/edits/{edit_id}
curl \
--request GET 'http://api.example.com/data/edits/{edit_id}' \
--header "Authorization: $API_KEY"Path parameters
-
edit_id
Required
DELETE
/data/edits/{edit_id}
curl \
--request DELETE 'http://api.example.com/data/edits/{edit_id}' \
--header "Authorization: $API_KEY"Retrieve all task types related to a given edit.
Path parameters
-
edit_id
Required
GET
/data/edits/{edit_id}/task-types
curl \
--request GET 'http://api.example.com/data/edits/{edit_id}/task-types' \
--header "Authorization: $API_KEY"Path parameters
-
edit_id
Required
GET
/data/edits/{edit_id}/tasks
curl \
--request GET 'http://api.example.com/data/edits/{edit_id}/tasks' \
--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
GET
/data/edits/{edit_id}/preview-files
curl \
--request GET 'http://api.example.com/data/edits/{edit_id}/preview-files' \
--header "Authorization: $API_KEY"Path parameters
-
edit_id
Required
GET
/data/edits/{edit_id}/versions
curl \
--request GET 'http://api.example.com/data/edits/{edit_id}/versions' \
--header "Authorization: $API_KEY"Retrieve all edits related to a given episode.
Path parameters
-
episode_id
Required
GET
/data/episodes/{episode_id}/edits
curl \
--request GET 'http://api.example.com/data/episodes/{episode_id}/edits' \
--header "Authorization: $API_KEY"Retrieve all tasks related to a given episode.
Path parameters
-
episode_id
Required
GET
/data/episodes/{episode_id}/edit-tasks
curl \
--request GET 'http://api.example.com/data/episodes/{episode_id}/edit-tasks' \
--header "Authorization: $API_KEY"Retrieve all edits related to a given project.
Path parameters
-
project_id
Required
GET
/data/projects/{project_id}/edits
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/edits' \
--header "Authorization: $API_KEY"Path parameters
-
project_id
Required
POST
/data/projects/{project_id}/edits
curl \
--request POST 'http://api.example.com/data/projects/{project_id}/edits' \
--header "Authorization: $API_KEY"Path parameters
-
entity_id
Required
GET
/data/entities/{entity_id}/news
curl \
--request GET 'http://api.example.com/data/entities/{entity_id}/news' \
--header "Authorization: $API_KEY"Retrieve all preview files linked to a given entity.
Path parameters
-
entity_id
Required
GET
/data/entities/{entity_id}/preview-files
curl \
--request GET 'http://api.example.com/data/entities/{entity_id}/preview-files' \
--header "Authorization: $API_KEY"Retrieve all time spents linked to a given entity.
Path parameters
-
entity_id
Required
GET
/data/entities/{entity_id}/time-spents
curl \
--request GET 'http://api.example.com/data/entities/{entity_id}/time-spents' \
--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"Export assets linked to a given project as csv.
Path parameters
-
project_id
Required
GET
/export/csv/projects/{project_id}/assets.csv
curl \
--request GET 'http://api.example.com/export/csv/projects/{project_id}/assets.csv' \
--header "Authorization: $API_KEY"Export shots linked to a given project as csv.
Path parameters
-
project_id
Required
GET
/export/csv/projects/{project_id}/shots.csv
curl \
--request GET 'http://api.example.com/export/csv/projects/{project_id}/shots.csv' \
--header "Authorization: $API_KEY"Export casting linked to a given project as csv.
Path parameters
-
project_id
Required
GET
/export/csv/projects/{project_id}/casting.csv
curl \
--request GET 'http://api.example.com/export/csv/projects/{project_id}/casting.csv' \
--header "Authorization: $API_KEY"Export edits linked to a given project as csv.
Path parameters
-
project_id
Required
GET
/export/csv/projects/{project_id}/edits.csv
curl \
--request GET 'http://api.example.com/export/csv/projects/{project_id}/edits.csv' \
--header "Authorization: $API_KEY"Path parameters
-
playlist_id
Required
GET
/export/csv/playlists/{playlist_id}
curl \
--request GET 'http://api.example.com/export/csv/playlists/{playlist_id}' \
--header "Authorization: $API_KEY"
GET
/export/csv/persons.csv
curl \
--request GET 'http://api.example.com/export/csv/persons.csv' \
--header "Authorization: $API_KEY"
GET
/export/csv/projects.csv
curl \
--request GET 'http://api.example.com/export/csv/projects.csv' \
--header "Authorization: $API_KEY"
GET
/export/csv/tasks.csv
curl \
--request GET 'http://api.example.com/export/csv/tasks.csv' \
--header "Authorization: $API_KEY"
GET
/export/csv/time-spents.csv
curl \
--request GET 'http://api.example.com/export/csv/time-spents.csv' \
--header "Authorization: $API_KEY"
GET
/export/csv/task-types.csv
curl \
--request GET 'http://api.example.com/export/csv/task-types.csv' \
--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"Return last working files revision for each file name for given task.
Path parameters
-
task_id
Required
GET
/data/tasks/{task_id}/working-files
curl \
--request GET 'http://api.example.com/data/tasks/{task_id}/working-files' \
--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.
Path parameters
-
task_id
Required
POST
/data/tasks/{task_id}/working-files/new
curl \
--request POST 'http://api.example.com/data/tasks/{task_id}/working-files/new' \
--header "Authorization: $API_KEY"Return last working files revision for each file name for given task.
Path parameters
-
task_id
Required
GET
/data/tasks/{task_id}/working-files/last-revisions
curl \
--request GET 'http://api.example.com/data/tasks/{task_id}/working-files/last-revisions' \
--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"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
POST
/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-files/new
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 next revision for given asset instance, output type, task type and name.
Path parameters
-
asset_instance_id
Required -
temporal_entity_id
Required
POST
/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-files/next-revision
curl \
--request POST 'http://api.example.com/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-files/next-revision' \
--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"Return all types of output generated for given instance.
Path parameters
-
asset_instance_id
Required -
temporal_entity_id
Required
GET
/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-types
curl \
--request GET 'http://api.example.com/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-types' \
--header "Authorization: $API_KEY"Get all output files for given asset instance and given output type.
Path parameters
-
asset_instance_id
Required -
temporal_entity_id
Required -
output_type_id
Required
GET
/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-types/{output_type_id}/output-files
curl \
--request GET 'http://api.example.com/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-types/{output_type_id}/output-files' \
--header "Authorization: $API_KEY"Generate an output file path from file tree template
Generate file path based on several parameters: asset instance, output type, task type, revision, mode, name and separator. Revision can be computed automatically as next revision in case no revision is given in parameter.
Path parameters
-
asset_instance_id
Required -
temporal_entity_id
Required
POST
/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-file-path
curl \
--request POST 'http://api.example.com/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-file-path' \
--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"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
POST
/data/entities/{entity_id}/output-files/new
curl \
--request POST 'http://api.example.com/data/entities/{entity_id}/output-files/new' \
--header "Authorization: $API_KEY"Get next revision for given entity, output type, task type and name.
Path parameters
-
entity_id
Required
POST
/data/entities/{entity_id}/output-files/next-revision
curl \
--request POST 'http://api.example.com/data/entities/{entity_id}/output-files/next-revision' \
--header "Authorization: $API_KEY"Get last revisions of output files for given entity grouped by output type and file name.
Path parameters
-
entity_id
Required
GET
/data/entities/{entity_id}/output-files/last-revisions
curl \
--request GET 'http://api.example.com/data/entities/{entity_id}/output-files/last-revisions' \
--header "Authorization: $API_KEY"Return all types of output generated for given entity.
Path parameters
-
entity_id
Required
GET
/data/entities/{entity_id}/output-types
curl \
--request GET 'http://api.example.com/data/entities/{entity_id}/output-types' \
--header "Authorization: $API_KEY"Get all output files for given entity and given output type.
Path parameters
-
entity_id
Required -
output_type_id
Required
GET
/data/entities/{entity_id}/output-types/{output_type_id}/output-files
curl \
--request GET 'http://api.example.com/data/entities/{entity_id}/output-types/{output_type_id}/output-files' \
--header "Authorization: $API_KEY"Get all output files for given entity.
Path parameters
-
entity_id
Required
Query parameters
-
output_type_id
Required -
task_type_id
Required -
file_status_id
Required -
representation
Required
GET
/data/entities/{entity_id}/output-files
curl \
--request GET 'http://api.example.com/data/entities/{entity_id}/output-files' \
--header "Authorization: $API_KEY"Get all output files for given poject.
Path parameters
-
project_id
Required
Query parameters
-
output_type_id
Required -
task_type_id
Required -
file_status_id
Required -
representation
Required
GET
/data/projects/{project_id}/output-files
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/output-files' \
--header "Authorization: $API_KEY"Get all output files for given asset instance and given output type.
Path parameters
-
asset_instance_id
Required
Query parameters
-
temporal_entity_id
Required -
output_type_id
Required -
task_type_id
Required -
file_status_id
Required -
representation
Required
GET
/data/asset-instances/{asset_instance_id}/output-files
curl \
--request GET 'http://api.example.com/data/asset-instances/{asset_instance_id}/output-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"Path parameters
-
working_file_id
Required
POST
/data/working-files/{working_file_id}/file
curl \
--request POST 'http://api.example.com/data/working-files/{working_file_id}/file' \
--header "Authorization: $API_KEY"Define a template file to use for given project.
Template files are located on the server side. Each template has a name which means that you just have to give a name to "select" the template to link with the project.
Path parameters
-
project_id
Required
POST
/actions/projects/{project_id}/set-file-tree
curl \
--request POST 'http://api.example.com/actions/projects/{project_id}/set-file-tree' \
--header "Authorization: $API_KEY"Update comment on given working file.
Path parameters
-
working_file_id
Required
PUT
/actions/working-files/{working_file_id}/comment
curl \
--request PUT 'http://api.example.com/actions/working-files/{working_file_id}/comment' \
--header "Authorization: $API_KEY"Update working file modification date with current date.
Path parameters
-
working_file_id
Required
PUT
/actions/working-files/{working_file_id}/modified
curl \
--request PUT 'http://api.example.com/actions/working-files/{working_file_id}/modified' \
--header "Authorization: $API_KEY"
POST
/import/shotgun/persons
curl \
--request POST 'http://api.example.com/import/shotgun/persons' \
--header "Authorization: $API_KEY"
POST
/import/shotgun/projects
curl \
--request POST 'http://api.example.com/import/shotgun/projects' \
--header "Authorization: $API_KEY"
POST
/import/shotgun/episodes
curl \
--request POST 'http://api.example.com/import/shotgun/episodes' \
--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/shots
curl \
--request POST 'http://api.example.com/import/shotgun/shots' \
--header "Authorization: $API_KEY"
POST
/import/shotgun/scenes
curl \
--request POST 'http://api.example.com/import/shotgun/scenes' \
--header "Authorization: $API_KEY"
POST
/import/shotgun/assets
curl \
--request POST 'http://api.example.com/import/shotgun/assets' \
--header "Authorization: $API_KEY"
POST
/import/shotgun/steps
curl \
--request POST 'http://api.example.com/import/shotgun/steps' \
--header "Authorization: $API_KEY"
POST
/import/shotgun/status
curl \
--request POST 'http://api.example.com/import/shotgun/status' \
--header "Authorization: $API_KEY"
POST
/import/shotgun/tasks
curl \
--request POST 'http://api.example.com/import/shotgun/tasks' \
--header "Authorization: $API_KEY"
POST
/import/shotgun/versions
curl \
--request POST 'http://api.example.com/import/shotgun/versions' \
--header "Authorization: $API_KEY"
POST
/import/shotgun/notes
curl \
--request POST 'http://api.example.com/import/shotgun/notes' \
--header "Authorization: $API_KEY"
GET
/import/shotgun/errors
curl \
--request GET 'http://api.example.com/import/shotgun/errors' \
--header "Authorization: $API_KEY"
POST
/import/shotgun/errors
curl \
--request POST 'http://api.example.com/import/shotgun/errors' \
--header "Authorization: $API_KEY"
POST
/import/shotgun/projectconnections
curl \
--request POST 'http://api.example.com/import/shotgun/projectconnections' \
--header "Authorization: $API_KEY"Path parameters
-
error_id
Required
DELETE
/import/shotgun/errors/{error_id}
curl \
--request DELETE 'http://api.example.com/import/shotgun/errors/{error_id}' \
--header "Authorization: $API_KEY"
POST
/import/shotgun/remove/project
curl \
--request POST 'http://api.example.com/import/shotgun/remove/project' \
--header "Authorization: $API_KEY"
POST
/import/shotgun/remove/person
curl \
--request POST 'http://api.example.com/import/shotgun/remove/person' \
--header "Authorization: $API_KEY"
POST
/import/shotgun/remove/shot
curl \
--request POST 'http://api.example.com/import/shotgun/remove/shot' \
--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/episode
curl \
--request POST 'http://api.example.com/import/shotgun/remove/episode' \
--header "Authorization: $API_KEY"
POST
/import/shotgun/remove/sequence
curl \
--request POST 'http://api.example.com/import/shotgun/remove/sequence' \
--header "Authorization: $API_KEY"
POST
/import/shotgun/remove/asset
curl \
--request POST 'http://api.example.com/import/shotgun/remove/asset' \
--header "Authorization: $API_KEY"
POST
/import/shotgun/remove/projectconnection
curl \
--request POST 'http://api.example.com/import/shotgun/remove/projectconnection' \
--header "Authorization: $API_KEY"
POST
/import/shotgun/remove/step
curl \
--request POST 'http://api.example.com/import/shotgun/remove/step' \
--header "Authorization: $API_KEY"
POST
/import/shotgun/remove/status
curl \
--request POST 'http://api.example.com/import/shotgun/remove/status' \
--header "Authorization: $API_KEY"
POST
/import/shotgun/remove/task
curl \
--request POST 'http://api.example.com/import/shotgun/remove/task' \
--header "Authorization: $API_KEY"
POST
/import/shotgun/remove/note
curl \
--request POST 'http://api.example.com/import/shotgun/remove/note' \
--header "Authorization: $API_KEY"
POST
/import/shotgun/remove/version
curl \
--request POST 'http://api.example.com/import/shotgun/remove/version' \
--header "Authorization: $API_KEY"
POST
/import/csv/persons
curl \
--request POST 'http://api.example.com/import/csv/persons' \
--header "Authorization: $API_KEY"Import project assets via a .csv file.
Path parameters
-
project_id
Required
POST
/import/csv/projects/{project_id}/assets
curl \
--request POST 'http://api.example.com/import/csv/projects/{project_id}/assets' \
--header "Authorization: $API_KEY"Import project shots via a .csv file.
Path parameters
-
project_id
Required
POST
/import/csv/projects/{project_id}/shots
curl \
--request POST 'http://api.example.com/import/csv/projects/{project_id}/shots' \
--header "Authorization: $API_KEY"Path parameters
-
project_id
Required
POST
/import/csv/projects/{project_id}/edits
curl \
--request POST 'http://api.example.com/import/csv/projects/{project_id}/edits' \
--header "Authorization: $API_KEY"Import project casting links via a .csv file.
Path parameters
-
project_id
Required
POST
/import/csv/projects/{project_id}/casting
curl \
--request POST 'http://api.example.com/import/csv/projects/{project_id}/casting' \
--header "Authorization: $API_KEY"Import the estimations of task-types for given project.
Path parameters
-
project_id
Required -
task_type_id
Required
POST
/import/csv/projects/{project_id}/task-types/{task_type_id}/estimations
curl \
--request POST 'http://api.example.com/import/csv/projects/{project_id}/task-types/{task_type_id}/estimations' \
--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
POST
/import/csv/projects/{project_id}/episodes/{episode_id}/task-types/{task_type_id}/estimations
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"Import an OTIO file to enter frame_in / frame_out / nb_frames (it can
be every adapter supported by OpenTimelineIO, for example: EDL, OTIO...
).
Path parameters
-
project_id
Required
POST
/import/otio/projects/{project_id}
curl \
--request POST 'http://api.example.com/import/otio/projects/{project_id}' \
--header "Authorization: $API_KEY"Import an OTIO file to enter frame_in / frame_out / nb_frames (it can
be every adapter supported by OpenTimelineIO, for example: edl, otio...
).
Path parameters
-
project_id
Required -
episode_id
Required
POST
/import/otio/projects/{project_id}/episodes/{episode_id}
curl \
--request POST 'http://api.example.com/import/otio/projects/{project_id}/episodes/{episode_id}' \
--header "Authorization: $API_KEY"
POST
/import/kitsu/comments
curl \
--request POST 'http://api.example.com/import/kitsu/comments' \
--header "Authorization: $API_KEY"
POST
/import/kitsu/entities
curl \
--request POST 'http://api.example.com/import/kitsu/entities' \
--header "Authorization: $API_KEY"
POST
/import/kitsu/entity-links
curl \
--request POST 'http://api.example.com/import/kitsu/entity-links' \
--header "Authorization: $API_KEY"
POST
/import/kitsu/projects
curl \
--request POST 'http://api.example.com/import/kitsu/projects' \
--header "Authorization: $API_KEY"
POST
/import/kitsu/tasks
curl \
--request POST 'http://api.example.com/import/kitsu/tasks' \
--header "Authorization: $API_KEY"
GET
/
curl \
--request GET 'http://api.example.com/' \
--header "Authorization: $API_KEY"
GET
/status
curl \
--request GET 'http://api.example.com/status' \
--header "Authorization: $API_KEY"
GET
/status/influx
curl \
--request GET 'http://api.example.com/status/influx' \
--header "Authorization: $API_KEY"
GET
/status/resources
curl \
--request GET 'http://api.example.com/status/resources' \
--header "Authorization: $API_KEY"
GET
/status.txt
curl \
--request GET 'http://api.example.com/status.txt' \
--header "Authorization: $API_KEY"
GET
/status/test-event
curl \
--request GET 'http://api.example.com/status/test-event' \
--header "Authorization: $API_KEY"
GET
/stats
curl \
--request GET 'http://api.example.com/stats' \
--header "Authorization: $API_KEY"
GET
/config
curl \
--request GET 'http://api.example.com/config' \
--header "Authorization: $API_KEY"Query parameters
-
project_id
Required
GET
/data/projects/news
curl \
--request GET 'http://api.example.com/data/projects/news' \
--header "Authorization: $API_KEY"Path parameters
-
project_id
Required
GET
/data/projects/{project_id}/news
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/news' \
--header "Authorization: $API_KEY"Retrieve a single given news related to a given project
Path parameters
-
project_id
Required -
news_id
Required
GET
/data/projects/{project_id}/news/{news_id}
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/news/{news_id}' \
--header "Authorization: $API_KEY"Retrieve desktop login logs.
Desktop login logs can only be created by current user.
Path parameters
-
person_id
Required
GET
/data/persons/{person_id}/desktop-login-logs
curl \
--request GET 'http://api.example.com/data/persons/{person_id}/desktop-login-logs' \
--header "Authorization: $API_KEY"Create desktop login logs.
Add a new log entry for desktop logins.
Path parameters
-
person_id
Required
POST
/data/persons/{person_id}/desktop-login-logs
curl \
--request POST 'http://api.example.com/data/persons/{person_id}/desktop-login-logs' \
--header "Authorization: $API_KEY"Return a csv file containing the presence logs based on a daily basis.
Path parameters
-
month_date
Required
GET
/data/persons/presence-logs/{month_date}
curl \
--request GET 'http://api.example.com/data/persons/presence-logs/{month_date}' \
--header "Authorization: $API_KEY"Get time spents for given person and date.
GET
/data/persons/{person_id}/time-spents/{date}
curl \
--request GET 'http://api.example.com/data/persons/{person_id}/time-spents/{date}' \
--header "Authorization: $API_KEY"Get day off object for given person and date.
GET
/data/persons/{person_id}/day-offs/{date}
curl \
--request GET 'http://api.example.com/data/persons/{person_id}/day-offs/{date}' \
--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"Get aggregated time spents for given person and month.
GET
/data/persons/{person_id}/time-spents/month/{year}/{month}
curl \
--request GET 'http://api.example.com/data/persons/{person_id}/time-spents/month/{year}/{month}' \
--header "Authorization: $API_KEY"Get aggregated time spents for given person and week.
GET
/data/persons/{person_id}/time-spents/week/{year}/{week}
curl \
--request GET 'http://api.example.com/data/persons/{person_id}/time-spents/week/{year}/{week}' \
--header "Authorization: $API_KEY"Get aggregated time spents for given person and day.
GET
/data/persons/{person_id}/time-spents/day/{year}/{month}/{day}
curl \
--request GET 'http://api.example.com/data/persons/{person_id}/time-spents/day/{year}/{month}/{day}' \
--header "Authorization: $API_KEY"Get ended shots used for quota calculation of this month.
Query parameters
-
count_mode
Required
GET
/data/persons/{person_id}/quota-shots/month/{year}/{month}
curl \
--request GET 'http://api.example.com/data/persons/{person_id}/quota-shots/month/{year}/{month}' \
--header "Authorization: $API_KEY"Get ended shots used for quota calculation of this week.
Query parameters
-
count_mode
Required
GET
/data/persons/{person_id}/quota-shots/week/{year}/{week}
curl \
--request GET 'http://api.example.com/data/persons/{person_id}/quota-shots/week/{year}/{week}' \
--header "Authorization: $API_KEY"Get ended shots used for quota calculation of this day.
Query parameters
-
count_mode
Required
GET
/data/persons/{person_id}/quota-shots/day/{year}/{month}/{day}
curl \
--request GET 'http://api.example.com/data/persons/{person_id}/quota-shots/day/{year}/{month}/{day}' \
--header "Authorization: $API_KEY"Return a table giving time spent by user and by month for given year.
GET
/data/persons/time-spents/year-table/
curl \
--request GET 'http://api.example.com/data/persons/time-spents/year-table/' \
--header "Authorization: $API_KEY"Return a table giving time spent by user and by month for given year.
Path parameters
-
year
Required
GET
/data/persons/time-spents/month-table/{year}
curl \
--request GET 'http://api.example.com/data/persons/time-spents/month-table/{year}' \
--header "Authorization: $API_KEY"Return a table giving time spent by user and by week for given year.
Path parameters
-
year
Required
GET
/data/persons/time-spents/week-table/{year}
curl \
--request GET 'http://api.example.com/data/persons/time-spents/week-table/{year}' \
--header "Authorization: $API_KEY"Return a table giving time spent by user and by day for given year and month.
GET
/data/persons/time-spents/day-table/{year}/{month}
curl \
--request GET 'http://api.example.com/data/persons/time-spents/day-table/{year}/{month}' \
--header "Authorization: $API_KEY"Return all day off recorded for given month.
GET
/data/persons/day-offs/{year}/{month}
curl \
--request GET 'http://api.example.com/data/persons/day-offs/{year}/{month}' \
--header "Authorization: $API_KEY"Return all day off recorded for given week and person.
GET
/data/persons/{person_id}/day-offs/week/{year}/{week}
curl \
--request GET 'http://api.example.com/data/persons/{person_id}/day-offs/week/{year}/{week}' \
--header "Authorization: $API_KEY"Return all day off recorded for given month and person.
GET
/data/persons/{person_id}/day-offs/month/{year}/{month}
curl \
--request GET 'http://api.example.com/data/persons/{person_id}/day-offs/month/{year}/{month}' \
--header "Authorization: $API_KEY"Return all day off recorded for given year and person.
GET
/data/persons/{person_id}/day-offs/year/{year}
curl \
--request GET 'http://api.example.com/data/persons/{person_id}/day-offs/year/{year}' \
--header "Authorization: $API_KEY"Return all day offs recorded for given and person.
Path parameters
-
person_id
Required
GET
/data/persons/{person_id}/day-offs
curl \
--request GET 'http://api.example.com/data/persons/{person_id}/day-offs' \
--header "Authorization: $API_KEY"Sends an email to given person to invite him/her to connect to Kitsu.
Path parameters
-
person_id
Required
GET
/actions/persons/{person_id}/invite
curl \
--request GET 'http://api.example.com/actions/persons/{person_id}/invite' \
--header "Authorization: $API_KEY"Path parameters
-
person_id
Required
POST
/actions/persons/{person_id}/departments/add
curl \
--request POST 'http://api.example.com/actions/persons/{person_id}/departments/add' \
--header "Authorization: $API_KEY"Remove a user from given department.
Path parameters
-
person_id
Required -
department_id
Required
DELETE
/actions/persons/{person_id}/departments/{department_id}
curl \
--request DELETE 'http://api.example.com/actions/persons/{person_id}/departments/{department_id}' \
--header "Authorization: $API_KEY"Allow admin to change password for given user.
Prior to modifying the password, it requires to be admin. An admin can't change other admins password. The new password requires a confirmation to ensure that the admin didn't make a mistake by typing the new password.
Path parameters
-
person_id
Required
POST
/actions/persons/{person_id}/change-password
curl \
--request POST 'http://api.example.com/actions/persons/{person_id}/change-password' \
--header "Authorization: $API_KEY"Allow admin to disable two factor authentication for given user.
Prior to disable two factor authentication, it requires to be admin. An admin can't disable two factor authentication for other admins.
Path parameters
-
person_id
Required
DELETE
/actions/persons/{person_id}/disable-two-factor-authentication
curl \
--request DELETE 'http://api.example.com/actions/persons/{person_id}/disable-two-factor-authentication' \
--header "Authorization: $API_KEY"Retrieve all playlists related to given project.
Result is paginated and can be sorted.
Path parameters
-
project_id
Required
GET
/data/projects/{project_id}/playlists
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/playlists' \
--header "Authorization: $API_KEY"Retrieve all playlists related to given project.
It's mainly used for synchronisation purpose.
Path parameters
-
project_id
Required
GET
/data/projects/{project_id}/playlists/all
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/playlists/all' \
--header "Authorization: $API_KEY"Retrieve all playlists related to given episode.
The full list is returned because the number of playlists in an episode is not that big.
Path parameters
-
project_id
Required -
episode_id
Required
GET
/data/projects/{project_id}/episodes/{episode_id}/playlists
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/episodes/{episode_id}/playlists' \
--header "Authorization: $API_KEY"Retrieve all playlists related to given project.
Path parameters
-
project_id
Required -
playlist_id
Required
GET
/data/projects/{project_id}/playlists/{playlist_id}
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/playlists/{playlist_id}' \
--header "Authorization: $API_KEY"Retrieve all previews related to a given entity.
It sends them as a dict. Keys are related task type ids and values are arrays of preview for this task type.
Path parameters
-
entity_id
Required
GET
/data/playlists/entities/{entity_id}/preview-files
curl \
--request GET 'http://api.example.com/data/playlists/entities/{entity_id}/preview-files' \
--header "Authorization: $API_KEY"Retrieve build job related to given playlist.
Path parameters
-
playlist_id
Required -
build_job_id
Required
GET
/data/playlists/{playlist_id}/jobs/{build_job_id}
curl \
--request GET 'http://api.example.com/data/playlists/{playlist_id}/jobs/{build_job_id}' \
--header "Authorization: $API_KEY"Remove given build job related to given playlist.
Path parameters
-
playlist_id
Required -
build_job_id
Required
DELETE
/data/playlists/{playlist_id}/jobs/{build_job_id}
curl \
--request DELETE 'http://api.example.com/data/playlists/{playlist_id}/jobs/{build_job_id}' \
--header "Authorization: $API_KEY"Retrieve all build jobs related to given project.
It's mainly used for synchronisation purpose.
Path parameters
-
project_id
Required
GET
/data/projects/{project_id}/build-jobs
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/build-jobs' \
--header "Authorization: $API_KEY"Path parameters
-
playlist_id
Required
GET
/data/playlists/{playlist_id}/build/mp4
curl \
--request GET 'http://api.example.com/data/playlists/{playlist_id}/build/mp4' \
--header "Authorization: $API_KEY"Download given playlist build as .mp4.
Path parameters
-
playlist_id
Required -
build_job_id
Required
GET
/data/playlists/{playlist_id}/jobs/{build_job_id}/build/mp4
curl \
--request GET 'http://api.example.com/data/playlists/{playlist_id}/jobs/{build_job_id}/build/mp4' \
--header "Authorization: $API_KEY"Path parameters
-
playlist_id
Required
GET
/data/playlists/{playlist_id}/download/zip
curl \
--request GET 'http://api.example.com/data/playlists/{playlist_id}/download/zip' \
--header "Authorization: $API_KEY"Retrieve all playlists related to given project.
It's mainly used for synchronisation purpose.
Path parameters
-
project_id
Required
POST
/data/projects/{project_id}/playlists/temp
curl \
--request POST 'http://api.example.com/data/projects/{project_id}/playlists/temp' \
--header "Authorization: $API_KEY"Retrieve all preview files from open productions with states equals to processing or broken.
GET
/data/playlists/preview-files/running
curl \
--request GET 'http://api.example.com/data/playlists/preview-files/running' \
--header "Authorization: $API_KEY"Main resource to add a preview.
It stores the preview file and generates three picture files matching preview when it's possible: a square thumbnail, a rectangle thumbnail and a midsize file.
Path parameters
-
instance_id
Required
POST
/pictures/preview-files/{instance_id}
curl \
--request POST 'http://api.example.com/pictures/preview-files/{instance_id}' \
--header "Authorization: $API_KEY"Download a movie preview.
It stores the preview file and generates three picture files matching preview when it's possible: a square thumbnail, a rectangle thumbnail and a midsize file.
Path parameters
-
instance_id
Required
GET
/movies/originals/preview-files/{instance_id}.mp4
curl \
--request GET 'http://api.example.com/movies/originals/preview-files/{instance_id}.mp4' \
--header "Authorization: $API_KEY"Download a movie preview.
Path parameters
-
instance_id
Required
GET
/movies/originals/preview-files/{instance_id}/download
curl \
--request GET 'http://api.example.com/movies/originals/preview-files/{instance_id}/download' \
--header "Authorization: $API_KEY"Path parameters
-
instance_id
Required
GET
/movies/low/preview-files/{instance_id}.mp4
curl \
--request GET 'http://api.example.com/movies/low/preview-files/{instance_id}.mp4' \
--header "Authorization: $API_KEY"Path parameters
-
instance_id
Required
GET
/pictures/thumbnails/preview-files/{instance_id}.png
curl \
--request GET 'http://api.example.com/pictures/thumbnails/preview-files/{instance_id}.png' \
--header "Authorization: $API_KEY"Download the thumbnail representing given attachment file.
Path parameters
-
attachment_file_id
Required
GET
/pictures/thumbnails/attachment-files/{attachment_file_id}.png
curl \
--request GET 'http://api.example.com/pictures/thumbnails/attachment-files/{attachment_file_id}.png' \
--header "Authorization: $API_KEY"Download a thumbnail.
Path parameters
-
instance_id
Required
GET
/pictures/thumbnails-square/preview-files/{instance_id}.png
curl \
--request GET 'http://api.example.com/pictures/thumbnails-square/preview-files/{instance_id}.png' \
--header "Authorization: $API_KEY"Path parameters
-
instance_id
Required
GET
/pictures/originals/preview-files/{instance_id}.png
curl \
--request GET 'http://api.example.com/pictures/originals/preview-files/{instance_id}.png' \
--header "Authorization: $API_KEY"Download a generic file preview.
Path parameters
-
instance_id
Required -
extension
Required
GET
/pictures/originals/preview-files/{instance_id}.{extension}
curl \
--request GET 'http://api.example.com/pictures/originals/preview-files/{instance_id}.{extension}' \
--header "Authorization: $API_KEY"Download a generic file preview as attachment.
Path parameters
-
instance_id
Required
GET
/pictures/originals/preview-files/{instance_id}/download
curl \
--request GET 'http://api.example.com/pictures/originals/preview-files/{instance_id}/download' \
--header "Authorization: $API_KEY"Path parameters
-
instance_id
Required
GET
/pictures/previews/preview-files/{instance_id}.png
curl \
--request GET 'http://api.example.com/pictures/previews/preview-files/{instance_id}.png' \
--header "Authorization: $API_KEY"Path parameters
-
instance_id
Required
GET
/movies/tiles/preview-files/{instance_id}.png
curl \
--request GET 'http://api.example.com/movies/tiles/preview-files/{instance_id}.png' \
--header "Authorization: $API_KEY"Download the thumbnail linked to given object instance.
Path parameters
-
instance_id
Required
GET
/pictures/thumbnails/organisations/{instance_id}
curl \
--request GET 'http://api.example.com/pictures/thumbnails/organisations/{instance_id}' \
--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/organisations/{instance_id}.png
curl \
--request POST 'http://api.example.com/pictures/thumbnails/organisations/{instance_id}.png' \
--header "Authorization: $API_KEY"Download the thumbnail linked to given object instance.
Path parameters
-
instance_id
Required
GET
/pictures/thumbnails/persons/{instance_id}
curl \
--request GET 'http://api.example.com/pictures/thumbnails/persons/{instance_id}' \
--header "Authorization: $API_KEY"Create a thumbnail for given object instance.
Path parameters
-
instance_id
Required
POST
/pictures/thumbnails/persons/{instance_id}
curl \
--request POST 'http://api.example.com/pictures/thumbnails/persons/{instance_id}' \
--header "Authorization: $API_KEY"Download the thumbnail linked to given object instance.
Path parameters
-
instance_id
Required
GET
/pictures/thumbnails/persons/{instance_id}.png
curl \
--request GET 'http://api.example.com/pictures/thumbnails/persons/{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"Download the thumbnail linked to given object instance.
Path parameters
-
instance_id
Required
GET
/pictures/thumbnails/projects/{instance_id}
curl \
--request GET 'http://api.example.com/pictures/thumbnails/projects/{instance_id}' \
--header "Authorization: $API_KEY"Create a thumbnail for given object instance.
Path parameters
-
instance_id
Required
POST
/pictures/thumbnails/projects/{instance_id}
curl \
--request POST 'http://api.example.com/pictures/thumbnails/projects/{instance_id}' \
--header "Authorization: $API_KEY"Download the thumbnail linked to given object instance.
Path parameters
-
instance_id
Required
GET
/pictures/thumbnails/projects/{instance_id}.png
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
POST
/pictures/thumbnails/projects/{instance_id}.png
curl \
--request POST 'http://api.example.com/pictures/thumbnails/projects/{instance_id}.png' \
--header "Authorization: $API_KEY"Download the thumbnail linked to given object instance.
Path parameters
-
instance_id
Required
GET
/pictures/thumbnails/preview-background-files/{instance_id}.png
curl \
--request GET 'http://api.example.com/pictures/thumbnails/preview-background-files/{instance_id}.png' \
--header "Authorization: $API_KEY"Create a thumbnail for given object instance.
Path parameters
-
instance_id
Required
POST
/pictures/thumbnails/preview-background-files/{instance_id}.png
curl \
--request POST 'http://api.example.com/pictures/thumbnails/preview-background-files/{instance_id}.png' \
--header "Authorization: $API_KEY"Download a preview background file.
Path parameters
-
instance_id
Required -
extension
Required
GET
/pictures/preview-background-files/{instance_id}.{extension}
curl \
--request GET 'http://api.example.com/pictures/preview-background-files/{instance_id}.{extension}' \
--header "Authorization: $API_KEY"Set given preview as main preview of the related entity.
This preview will be used to illustrate the entity.
Path parameters
-
preview_file_id
Required
PUT
/actions/preview-files/{preview_file_id}/set-main-preview
curl \
--request PUT 'http://api.example.com/actions/preview-files/{preview_file_id}/set-main-preview' \
--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"Allow to change orders of previews for a single revision.
This preview will be used to illustrate the entity.
Path parameters
-
preview_file_id
Required
PUT
/actions/preview-files/{preview_file_id}/update-position
curl \
--request PUT 'http://api.example.com/actions/preview-files/{preview_file_id}/update-position' \
--header "Authorization: $API_KEY"Allow to modify the annotations stored at the preview level.
Modifications are applied via three fields:
annotationsto give all the annotations that need to be added.updatesthat list annotations that needs to be modified.deletionsto list the IDs of annotations that needs to be removed.
Path parameters
-
preview_file_id
Required
PUT
/actions/preview-files/{preview_file_id}/update-annotations
curl \
--request PUT 'http://api.example.com/actions/preview-files/{preview_file_id}/update-annotations' \
--header "Authorization: $API_KEY"Return the list of projects currently running.
Most of the time, past projects are not needed.
GET
/data/projects/open
curl \
--request GET 'http://api.example.com/data/projects/open' \
--header "Authorization: $API_KEY"Return all projects listed in database.
Ensure that user has at least the manager level before that.
GET
/data/projects/all
curl \
--request GET 'http://api.example.com/data/projects/all' \
--header "Authorization: $API_KEY"Return the people listed in a production team.
Path parameters
-
project_id
Required
GET
/data/projects/{project_id}/team
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/team' \
--header "Authorization: $API_KEY"Path parameters
-
project_id
Required
POST
/data/projects/{project_id}/team
curl \
--request POST 'http://api.example.com/data/projects/{project_id}/team' \
--header "Authorization: $API_KEY"Retrieve task types linked to the production
Path parameters
-
project_id
Required
GET
/data/projects/{project_id}/task-types
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/task-types' \
--header "Authorization: $API_KEY"Remove people listed in a production team.
Path parameters
-
project_id
Required -
person_id
Required
DELETE
/data/projects/{project_id}/team/{person_id}
curl \
--request DELETE 'http://api.example.com/data/projects/{project_id}/team/{person_id}' \
--header "Authorization: $API_KEY"Add an asset type linked to a production.
Path parameters
-
project_id
Required
POST
/data/projects/{project_id}/settings/asset-types
curl \
--request POST 'http://api.example.com/data/projects/{project_id}/settings/asset-types' \
--header "Authorization: $API_KEY"Remove an asset type from a production.
Path parameters
-
project_id
Required -
asset_type_id
Required
DELETE
/data/projects/{project_id}/settings/asset-types/{asset_type_id}
curl \
--request DELETE 'http://api.example.com/data/projects/{project_id}/settings/asset-types/{asset_type_id}' \
--header "Authorization: $API_KEY"Add a task type linked to a production.
Path parameters
-
project_id
Required
POST
/data/projects/{project_id}/settings/task-types
curl \
--request POST 'http://api.example.com/data/projects/{project_id}/settings/task-types' \
--header "Authorization: $API_KEY"Remove a task type from a production.
Path parameters
-
project_id
Required -
task_type_id
Required
DELETE
/data/projects/{project_id}/settings/task-types/{task_type_id}
curl \
--request DELETE 'http://api.example.com/data/projects/{project_id}/settings/task-types/{task_type_id}' \
--header "Authorization: $API_KEY"Return task statuses linked to a production
Path parameters
-
project_id
Required
GET
/data/projects/{project_id}/settings/task-status
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/settings/task-status' \
--header "Authorization: $API_KEY"Add a task type linked to a production.
Path parameters
-
project_id
Required
POST
/data/projects/{project_id}/settings/task-status
curl \
--request POST 'http://api.example.com/data/projects/{project_id}/settings/task-status' \
--header "Authorization: $API_KEY"Remove a task status from a production.
Path parameters
-
project_id
Required -
task_status_id
Required
DELETE
/data/projects/{project_id}/settings/task-status/{task_status_id}
curl \
--request DELETE 'http://api.example.com/data/projects/{project_id}/settings/task-status/{task_status_id}' \
--header "Authorization: $API_KEY"Get a status automation linked to a production.
Path parameters
-
project_id
Required
GET
/data/projects/{project_id}/settings/status-automations
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/settings/status-automations' \
--header "Authorization: $API_KEY"Add a status automation linked to a production.
Path parameters
-
project_id
Required
POST
/data/projects/{project_id}/settings/status-automations
curl \
--request POST 'http://api.example.com/data/projects/{project_id}/settings/status-automations' \
--header "Authorization: $API_KEY"Remove a status automation from a production.
Path parameters
-
project_id
Required -
status_automation_id
Required
DELETE
/data/projects/{project_id}/settings/status-automations/{status_automation_id}
curl \
--request DELETE 'http://api.example.com/data/projects/{project_id}/settings/status-automations/{status_automation_id}' \
--header "Authorization: $API_KEY"Remove a preview background file from a production.
Path parameters
-
project_id
Required -
preview_background_file_id
Required
DELETE
/data/projects/{project_id}/settings/preview-background-files/{preview_background_file_id}
curl \
--request DELETE 'http://api.example.com/data/projects/{project_id}/settings/preview-background-files/{preview_background_file_id}' \
--header "Authorization: $API_KEY"Return preview background files linked to a production
Path parameters
-
project_id
Required
GET
/data/projects/{project_id}/settings/preview-background-files
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/settings/preview-background-files' \
--header "Authorization: $API_KEY"Add a preview background file linked to a production.
Path parameters
-
project_id
Required
POST
/data/projects/{project_id}/settings/preview-background-files
curl \
--request POST 'http://api.example.com/data/projects/{project_id}/settings/preview-background-files' \
--header "Authorization: $API_KEY"Get all metadata descriptors
It serves to describe extra fields listed in the data attribute of entities.
Path parameters
-
project_id
Required
GET
/data/projects/{project_id}/metadata-descriptors
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/metadata-descriptors' \
--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
POST
/data/projects/{project_id}/metadata-descriptors
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
GET
/data/projects/{project_id}/metadata-descriptors/{descriptor_id}
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/metadata-descriptors/{descriptor_id}' \
--header "Authorization: $API_KEY"Update a metadata descriptor.
Descriptors serve to describe extra fields listed in the data attribute of entities.
Path parameters
-
project_id
Required -
descriptor_id
Required
PUT
/data/projects/{project_id}/metadata-descriptors/{descriptor_id}
curl \
--request PUT 'http://api.example.com/data/projects/{project_id}/metadata-descriptors/{descriptor_id}' \
--header "Authorization: $API_KEY"Delete a metadata descriptor.
Descriptors serve to describe extra fields listed in the data attribute of entities.
Path parameters
-
project_id
Required -
descriptor_id
Required
DELETE
/data/projects/{project_id}/metadata-descriptors/{descriptor_id}
curl \
--request DELETE '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
GET
/data/projects/{project_id}/milestones
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/milestones' \
--header "Authorization: $API_KEY"Retrieve schedule items for given production
Path parameters
-
project_id
Required
GET
/data/projects/{project_id}/schedule-items
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/schedule-items' \
--header "Authorization: $API_KEY"Retrieve task type schedule items for given production
Path parameters
-
project_id
Required
GET
/data/projects/{project_id}/schedule-items/task-types
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/schedule-items/task-types' \
--header "Authorization: $API_KEY"Retrieve asset types 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}/asset-types
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/schedule-items/{task_type_id}/asset-types' \
--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"Retrieve sequences 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}/sequences
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/schedule-items/{task_type_id}/sequences' \
--header "Authorization: $API_KEY"Retrieve time spents for given production
Path parameters
-
project_id
Required
GET
/data/projects/{project_id}/time-spents
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/time-spents' \
--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"Path parameters
-
project_id
Required
POST
/data/projects/{project_id}/budgets
curl \
--request POST 'http://api.example.com/data/projects/{project_id}/budgets' \
--header "Authorization: $API_KEY"Retrieve a budget for given production
Path parameters
-
project_id
Required -
budget_id
Required
GET
/data/projects/{project_id}/budgets/{budget_id}
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/budgets/{budget_id}' \
--header "Authorization: $API_KEY"Update a budget name for given production
Path parameters
-
project_id
Required -
budget_id
Required
PUT
/data/projects/{project_id}/budgets/{budget_id}
curl \
--request PUT 'http://api.example.com/data/projects/{project_id}/budgets/{budget_id}' \
--header "Authorization: $API_KEY"Delete a budget for given production
Path parameters
-
project_id
Required -
budget_id
Required
DELETE
/data/projects/{project_id}/budgets/{budget_id}
curl \
--request DELETE 'http://api.example.com/data/projects/{project_id}/budgets/{budget_id}' \
--header "Authorization: $API_KEY"Retrieve budget entries for given production
Path parameters
-
project_id
Required -
budget_id
Required
GET
/data/projects/{project_id}/budgets/{budget_id}/entries
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/budgets/{budget_id}/entries' \
--header "Authorization: $API_KEY"Retrieve a budget entry for given production and budget
Path parameters
-
project_id
Required -
budget_id
Required -
entry_id
Required
GET
/data/projects/{project_id}/budgets/{budget_id}/entries/{entry_id}
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/budgets/{budget_id}/entries/{entry_id}' \
--header "Authorization: $API_KEY"Update a budget entry for given production and budget
Path parameters
-
project_id
Required -
budget_id
Required -
entry_id
Required
PUT
/data/projects/{project_id}/budgets/{budget_id}/entries/{entry_id}
curl \
--request PUT 'http://api.example.com/data/projects/{project_id}/budgets/{budget_id}/entries/{entry_id}' \
--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"Get aggregated time spents by month for given project.
Path parameters
-
project_id
Required
GET
/data/projects/{project_id}/budgets/time-spents
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/budgets/time-spents' \
--header "Authorization: $API_KEY"
POST
/data/search
curl \
--request POST 'http://api.example.com/data/search' \
--header "Authorization: $API_KEY"
GET
/data/shots
curl \
--request GET 'http://api.example.com/data/shots' \
--header "Authorization: $API_KEY"
GET
/data/shots/all
curl \
--request GET 'http://api.example.com/data/shots/all' \
--header "Authorization: $API_KEY"Retrieve all shots, adds project name and asset type name and all related tasks.
GET
/data/shots/with-tasks
curl \
--request GET 'http://api.example.com/data/shots/with-tasks' \
--header "Authorization: $API_KEY"Path parameters
-
shot_id
Required
GET
/data/shots/{shot_id}
curl \
--request GET 'http://api.example.com/data/shots/{shot_id}' \
--header "Authorization: $API_KEY"Path parameters
-
shot_id
Required
PUT
/data/shots/{shot_id}
curl \
--request PUT 'http://api.example.com/data/shots/{shot_id}' \
--header "Authorization: $API_KEY"Path parameters
-
shot_id
Required
DELETE
/data/shots/{shot_id}
curl \
--request DELETE 'http://api.example.com/data/shots/{shot_id}' \
--header "Authorization: $API_KEY"Path parameters
-
shot_id
Required
GET
/data/shots/{shot_id}/assets
curl \
--request GET 'http://api.example.com/data/shots/{shot_id}/assets' \
--header "Authorization: $API_KEY"Retrieve all task types related to a given shot.
Path parameters
-
shot_id
Required
GET
/data/shots/{shot_id}/task-types
curl \
--request GET 'http://api.example.com/data/shots/{shot_id}/task-types' \
--header "Authorization: $API_KEY"Path parameters
-
shot_id
Required
GET
/data/shots/{shot_id}/tasks
curl \
--request GET 'http://api.example.com/data/shots/{shot_id}/tasks' \
--header "Authorization: $API_KEY"Retrieve all previews related to a given shot.
It sends them as a dict. Keys are related task type ids and values are arrays of preview for this task type.
Path parameters
-
shot_id
Required
GET
/data/shots/{shot_id}/preview-files
curl \
--request GET 'http://api.example.com/data/shots/{shot_id}/preview-files' \
--header "Authorization: $API_KEY"Path parameters
-
shot_id
Required
GET
/data/shots/{shot_id}/versions
curl \
--request GET 'http://api.example.com/data/shots/{shot_id}/versions' \
--header "Authorization: $API_KEY"
GET
/data/scenes/all
curl \
--request GET 'http://api.example.com/data/scenes/all' \
--header "Authorization: $API_KEY"Retrieve all scenes, adds project name and asset type name and all related tasks.
GET
/data/scenes/with-tasks
curl \
--request GET 'http://api.example.com/data/scenes/with-tasks' \
--header "Authorization: $API_KEY"Path parameters
-
scene_id
Required
GET
/data/scenes/{scene_id}
curl \
--request GET 'http://api.example.com/data/scenes/{scene_id}' \
--header "Authorization: $API_KEY"Path parameters
-
scene_id
Required
DELETE
/data/scenes/{scene_id}
curl \
--request DELETE 'http://api.example.com/data/scenes/{scene_id}' \
--header "Authorization: $API_KEY"Path parameters
-
scene_id
Required
GET
/data/scenes/{scene_id}/tasks
curl \
--request GET 'http://api.example.com/data/scenes/{scene_id}/tasks' \
--header "Authorization: $API_KEY"Retrieve all task types related to a given scene.
Path parameters
-
scene_id
Required
GET
/data/scenes/{scene_id}/task-types
curl \
--request GET 'http://api.example.com/data/scenes/{scene_id}/task-types' \
--header "Authorization: $API_KEY"Path parameters
-
scene_id
Required
GET
/data/scenes/{scene_id}/shots
curl \
--request GET 'http://api.example.com/data/scenes/{scene_id}/shots' \
--header "Authorization: $API_KEY"Path parameters
-
scene_id
Required
POST
/data/scenes/{scene_id}/shots
curl \
--request POST 'http://api.example.com/data/scenes/{scene_id}/shots' \
--header "Authorization: $API_KEY"Delete given shot from given scene.
DELETE
/data/scenes/{scene_id}/shots/{shot_id}
curl \
--request DELETE 'http://api.example.com/data/scenes/{scene_id}/shots/{shot_id}' \
--header "Authorization: $API_KEY"
GET
/data/episodes
curl \
--request GET 'http://api.example.com/data/episodes' \
--header "Authorization: $API_KEY"Retrieve all episodes, adds project name and asset type name and all related tasks.
GET
/data/episodes/with-tasks
curl \
--request GET 'http://api.example.com/data/episodes/with-tasks' \
--header "Authorization: $API_KEY"Path parameters
-
episode_id
Required
GET
/data/episodes/{episode_id}
curl \
--request GET 'http://api.example.com/data/episodes/{episode_id}' \
--header "Authorization: $API_KEY"Path parameters
-
episode_id
Required
DELETE
/data/episodes/{episode_id}
curl \
--request DELETE 'http://api.example.com/data/episodes/{episode_id}' \
--header "Authorization: $API_KEY"Retrieve all shots related to a given episode.
Path parameters
-
episode_id
Required
GET
/data/episodes/{episode_id}/shots
curl \
--request GET 'http://api.example.com/data/episodes/{episode_id}/shots' \
--header "Authorization: $API_KEY"Retrieve all sequence entries for a given episode.
Filters can be specified in the query string.
Path parameters
-
episode_id
Required
GET
/data/episodes/{episode_id}/sequences
curl \
--request GET 'http://api.example.com/data/episodes/{episode_id}/sequences' \
--header "Authorization: $API_KEY"Retrieve all tasks related to a given episode.
Path parameters
-
episode_id
Required
GET
/data/episodes/{episode_id}/tasks
curl \
--request GET 'http://api.example.com/data/episodes/{episode_id}/tasks' \
--header "Authorization: $API_KEY"Retrieve all task types related to a given episode.
Path parameters
-
episode_id
Required
GET
/data/episodes/{episode_id}/task-types
curl \
--request GET 'http://api.example.com/data/episodes/{episode_id}/task-types' \
--header "Authorization: $API_KEY"Retrieve all shots tasks related to a given episode.
Path parameters
-
episode_id
Required
GET
/data/episodes/{episode_id}/shot-tasks
curl \
--request GET 'http://api.example.com/data/episodes/{episode_id}/shot-tasks' \
--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"
GET
/data/sequences
curl \
--request GET 'http://api.example.com/data/sequences' \
--header "Authorization: $API_KEY"Retrieve all sequences, adds project name and asset type name and all related tasks.
GET
/data/sequences/with-tasks
curl \
--request GET 'http://api.example.com/data/sequences/with-tasks' \
--header "Authorization: $API_KEY"Path parameters
-
sequence_id
Required
GET
/data/sequences/{sequence_id}
curl \
--request GET 'http://api.example.com/data/sequences/{sequence_id}' \
--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"Retrieve all shot entries for a given sequence.
Filters can be specified in the query string.
Path parameters
-
sequence_id
Required
GET
/data/sequences/{sequence_id}/shots
curl \
--request GET 'http://api.example.com/data/sequences/{sequence_id}/shots' \
--header "Authorization: $API_KEY"Retrieve all scenes related to a given sequence.
Path parameters
-
sequence_id
Required
GET
/data/sequences/{sequence_id}/scenes
curl \
--request GET 'http://api.example.com/data/sequences/{sequence_id}/scenes' \
--header "Authorization: $API_KEY"Retrieve all tasks related to a given shot.
Path parameters
-
sequence_id
Required
GET
/data/sequences/{sequence_id}/tasks
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
GET
/data/sequences/{sequence_id}/task-types
curl \
--request GET 'http://api.example.com/data/sequences/{sequence_id}/task-types' \
--header "Authorization: $API_KEY"Retrieve all tasks related to a given sequence.
Path parameters
-
sequence_id
Required
GET
/data/sequences/{sequence_id}/shot-tasks
curl \
--request GET 'http://api.example.com/data/sequences/{sequence_id}/shot-tasks' \
--header "Authorization: $API_KEY"Retrieve all shots related to a given project.
Path parameters
-
project_id
Required
GET
/data/projects/{project_id}/shots
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/shots' \
--header "Authorization: $API_KEY"Path parameters
-
project_id
Required
POST
/data/projects/{project_id}/shots
curl \
--request POST 'http://api.example.com/data/projects/{project_id}/shots' \
--header "Authorization: $API_KEY"Retrieve all scenes related to a given project.
Path parameters
-
project_id
Required
GET
/data/projects/{project_id}/scenes
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/scenes' \
--header "Authorization: $API_KEY"Path parameters
-
project_id
Required
POST
/data/projects/{project_id}/scenes
curl \
--request POST 'http://api.example.com/data/projects/{project_id}/scenes' \
--header "Authorization: $API_KEY"Retrieve all sequences related to a given project.
Path parameters
-
project_id
Required
GET
/data/projects/{project_id}/sequences
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/sequences' \
--header "Authorization: $API_KEY"Path parameters
-
project_id
Required
POST
/data/projects/{project_id}/sequences
curl \
--request POST 'http://api.example.com/data/projects/{project_id}/sequences' \
--header "Authorization: $API_KEY"Retrieve all episodes related to a given project.
Path parameters
-
project_id
Required
GET
/data/projects/{project_id}/episodes
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/episodes' \
--header "Authorization: $API_KEY"Path parameters
-
project_id
Required
POST
/data/projects/{project_id}/episodes
curl \
--request POST 'http://api.example.com/data/projects/{project_id}/episodes' \
--header "Authorization: $API_KEY"Retrieve number of tasks by status, task_types and episodes for given project.
Path parameters
-
project_id
Required
GET
/data/projects/{project_id}/episodes/stats
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/episodes/stats' \
--header "Authorization: $API_KEY"Retrieve number of tasks by status, task_types and episodes for given project.
Path parameters
-
project_id
Required
GET
/data/projects/{project_id}/episodes/retake-stats
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/episodes/retake-stats' \
--header "Authorization: $API_KEY"Retrieve quotas statistics for shots.
Path parameters
-
project_id
Required -
task_type_id
Required
Query parameters
-
count_mode
Required
GET
/data/projects/{project_id}/quotas/{task_type_id}
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/quotas/{task_type_id}' \
--header "Authorization: $API_KEY"Retrieve quotas statistics for shots.
Path parameters
-
project_id
Required -
person_id
Required
Query parameters
-
count_mode
Required
GET
/data/projects/{project_id}/quotas/persons/{person_id}
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/quotas/persons/{person_id}' \
--header "Authorization: $API_KEY"Set frames for given shots.
POST
/actions/projects/{project_id}/task-types/{task_type_id}/set-shot-nb-frames
curl \
--request POST 'http://api.example.com/actions/projects/{project_id}/task-types/{task_type_id}/set-shot-nb-frames' \
--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
GET
/data/tasks/open-tasks
curl \
--request GET 'http://api.example.com/data/tasks/open-tasks' \
--header "Authorization: $API_KEY"Return task amount, task done amount, total estimation, total duration
by status by task type by project for open projects. It aggregates the
result at the project level.
GET
/data/tasks/open-tasks/stats
curl \
--request GET 'http://api.example.com/data/tasks/open-tasks/stats' \
--header "Authorization: $API_KEY"Path parameters
-
task_id
Required
GET
/data/tasks/{task_id}/comments
curl \
--request GET 'http://api.example.com/data/tasks/{task_id}/comments' \
--header "Authorization: $API_KEY"Get comment corresponding at given ID.
Path parameters
-
task_id
Required -
comment_id
Required
GET
/data/tasks/{task_id}/comments/{comment_id}
curl \
--request GET 'http://api.example.com/data/tasks/{task_id}/comments/{comment_id}' \
--header "Authorization: $API_KEY"Delete a comment corresponding at given ID.
Path parameters
-
task_id
Required -
comment_id
Required
DELETE
/data/tasks/{task_id}/comments/{comment_id}
curl \
--request DELETE 'http://api.example.com/data/tasks/{task_id}/comments/{comment_id}' \
--header "Authorization: $API_KEY"Path parameters
-
task_id
Required
GET
/data/tasks/{task_id}/previews
curl \
--request GET 'http://api.example.com/data/tasks/{task_id}/previews' \
--header "Authorization: $API_KEY"Return a task with many information.
Full details for assignees, full details for task type, full details for task status, etc.
Path parameters
-
task_id
Required
GET
/data/tasks/{task_id}/full
curl \
--request GET 'http://api.example.com/data/tasks/{task_id}/full' \
--header "Authorization: $API_KEY"Return task assigned to given user of which status has is_done flag sets to false.
Path parameters
-
person_id
Required
GET
/data/persons/{person_id}/tasks
curl \
--request GET 'http://api.example.com/data/persons/{person_id}/tasks' \
--header "Authorization: $API_KEY"For all entities assigned to given person (that have at least one task assigned to given person), returns all tasks for given task type.
GET
/data/persons/{person_id}/related-tasks/{task_type_id}
curl \
--request GET 'http://api.example.com/data/persons/{person_id}/related-tasks/{task_type_id}' \
--header "Authorization: $API_KEY"Return task assigned to given user of which status has is_done flag sets to true.
It return only tasks related to open projects.
Path parameters
-
person_id
Required
GET
/data/persons/{person_id}/done-tasks
curl \
--request GET 'http://api.example.com/data/persons/{person_id}/done-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
GET
/data/entities/{entity_id}/task-types/{task_type_id}/tasks
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
GET
/data/projects/{project_id}/comments
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/comments' \
--header "Authorization: $API_KEY"Retrieve all notifications to tasks related to given project.
It's mainly used for synchronisation purpose.
Path parameters
-
project_id
Required
GET
/data/projects/{project_id}/notifications
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/notifications' \
--header "Authorization: $API_KEY"Preview files related to a given project.
Path parameters
-
project_id
Required
GET
/data/projects/{project_id}/preview-files
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/preview-files' \
--header "Authorization: $API_KEY"Retrieve all subcriptions to tasks related to given project.
It's mainly used for synchronisation purpose.
Path parameters
-
project_id
Required
GET
/data/projects/{project_id}/subscriptions
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/subscriptions' \
--header "Authorization: $API_KEY"Retrieve all tasks related to given project.
It's mainly used for synchronisation purpose.
Path parameters
-
project_id
Required
GET
/data/projects/{project_id}/tasks
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/tasks' \
--header "Authorization: $API_KEY"For schedule usages, for each active person, it returns the first start
date of all tasks of assigned to this person and the last end date.
Path parameters
-
project_id
Required
GET
/data/persons/task-dates
curl \
--request GET 'http://api.example.com/data/persons/task-dates' \
--header "Authorization: $API_KEY"Delete all tasks for a given task type and project.
It's mainly used when tasks are created by mistake at the beginning of the project.
Path parameters
-
project_id
Required -
task_type_id
Required
DELETE
/actions/projects/{project_id}/task-types/{task_type_id}/delete-tasks
curl \
--request DELETE 'http://api.example.com/actions/projects/{project_id}/task-types/{task_type_id}/delete-tasks' \
--header "Authorization: $API_KEY"Delete tasks matching id list given in parameter.
See it as a way to batch delete tasks.
Path parameters
-
project_id
Required
POST
/actions/projects/{project_id}/delete-tasks
curl \
--request POST 'http://api.example.com/actions/projects/{project_id}/delete-tasks' \
--header "Authorization: $API_KEY"Path parameters
-
task_id
Required
PUT
/actions/tasks/{task_id}/assign
curl \
--request PUT 'http://api.example.com/actions/tasks/{task_id}/assign' \
--header "Authorization: $API_KEY"
PUT
/actions/tasks/clear-assignation
curl \
--request PUT 'http://api.example.com/actions/tasks/clear-assignation' \
--header "Authorization: $API_KEY"Assign given task lists to given person.
If a given task ID is wrong, it ignores it.
Path parameters
-
person_id
Required
PUT
/actions/persons/{person_id}/assign
curl \
--request PUT 'http://api.example.com/actions/persons/{person_id}/assign' \
--header "Authorization: $API_KEY"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"Path parameters
-
task_id
Required
GET
/actions/tasks/{task_id}/time-spents
curl \
--request GET 'http://api.example.com/actions/tasks/{task_id}/time-spents' \
--header "Authorization: $API_KEY"Set time spent by a person on a task for a given day.
POST
/actions/tasks/{task_id}/time-spents/{date}/persons/{person_id}
curl \
--request POST 'http://api.example.com/actions/tasks/{task_id}/time-spents/{date}/persons/{person_id}' \
--header "Authorization: $API_KEY"Delete time spent by a person on a task for a given day.
DELETE
/actions/tasks/{task_id}/time-spents/{date}/persons/{person_id}
curl \
--request DELETE 'http://api.example.com/actions/tasks/{task_id}/time-spents/{date}/persons/{person_id}' \
--header "Authorization: $API_KEY"Add given timeframe to time spent by a person on a task for a given day.
POST
/actions/tasks/{task_id}/time-spents/{date}/persons/{person_id}/add
curl \
--request POST 'http://api.example.com/actions/tasks/{task_id}/time-spents/{date}/persons/{person_id}/add' \
--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
POST
/actions/tasks/{task_id}/comments/{comment_id}/add-preview
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
POST
/actions/tasks/{task_id}/comments/{comment_id}/preview-files/{preview_file_id}
curl \
--request POST 'http://api.example.com/actions/tasks/{task_id}/comments/{comment_id}/preview-files/{preview_file_id}' \
--header "Authorization: $API_KEY"Delete preview from given comment.
Path parameters
-
task_id
Required -
comment_id
Required -
preview_file_id
Required
DELETE
/actions/tasks/{task_id}/comments/{comment_id}/preview-files/{preview_file_id}
curl \
--request DELETE 'http://api.example.com/actions/tasks/{task_id}/comments/{comment_id}/preview-files/{preview_file_id}' \
--header "Authorization: $API_KEY"Change a task status to "to review".
It creates a new preview file entry and set path from the hard disk.
Path parameters
-
task_id
Required
PUT
/actions/tasks/{task_id}/to-review
curl \
--request PUT 'http://api.example.com/actions/tasks/{task_id}/to-review' \
--header "Authorization: $API_KEY"Create a new task for given shot and task type.
Path parameters
-
project_id
Required -
task_type_id
Required
POST
/actions/projects/{project_id}/task-types/{task_type_id}/shots/create-tasks
curl \
--request POST 'http://api.example.com/actions/projects/{project_id}/task-types/{task_type_id}/shots/create-tasks' \
--header "Authorization: $API_KEY"Create a new task for given asset and task type.
Path parameters
-
project_id
Required -
task_type_id
Required
POST
/actions/projects/{project_id}/task-types/{task_type_id}/assets/create-tasks
curl \
--request POST 'http://api.example.com/actions/projects/{project_id}/task-types/{task_type_id}/assets/create-tasks' \
--header "Authorization: $API_KEY"Create a new task for given edit and task type.
Path parameters
-
project_id
Required -
task_type_id
Required
POST
/actions/projects/{project_id}/task-types/{task_type_id}/edits/create-tasks
curl \
--request POST 'http://api.example.com/actions/projects/{project_id}/task-types/{task_type_id}/edits/create-tasks' \
--header "Authorization: $API_KEY"