Returns information if the user is authenticated else it returns a 401

Log in user by creating and registering auth tokens.

POST /auth/login

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.

Responses

200

Login successful
400

Login failed
500

Database not reachable

POST /auth/login

curl \
 --request POST 'http://api.example.com/auth/login' \
 --header "Authorization: $API_KEY"

Log user out by revoking his auth tokens.

GET /auth/logout

Jwt authorization

Once logged out, current user cannot access the API anymore.

Responses

200

Logout successful
500

Access token not found

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

GET /auth/authenticated

Jwt authorization

response.

Responses

200

User authenticated
401

Person not found

GET /auth/authenticated

curl \
 --request GET 'http://api.example.com/auth/authenticated' \
 --header "Authorization: $API_KEY"

Allow a user to register himself to the service.

POST /auth/register

Jwt authorization

Responses

201

Registration successful
400

Invalid password or email

POST /auth/register

curl \
 --request POST 'http://api.example.com/auth/register' \
 --header "Authorization: $API_KEY"

Allow the user to change his password.

POST /auth/change-password

Jwt authorization

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.

Responses

200

Password changed
400

Invalid password or inactive user

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.

PUT /auth/reset-password

Jwt authorization

It uses a classic scheme: a token is sent by email to the user. Then he can change his password.

Responses

200

Password reset
400

Invalid password Wrong or expired token Inactive user

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.

POST /auth/reset-password

Jwt authorization

It uses a classic scheme: a token is sent by email to the user. Then he can change his password.

Responses

200

Reset token sent
400

Email not listed in database

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.

GET /auth/refresh-token

Jwt authorization

This route allows to make their lifetime long before they get outdated.

Responses

200

Access Token

GET /auth/refresh-token

curl \
 --request GET 'http://api.example.com/auth/refresh-token' \
 --header "Authorization: $API_KEY"

Resource to allow a user to pre-enable TOTP.

PUT /auth/totp

Jwt authorization

Responses

200

TOTP enabled
400

Invalid password Wrong or expired token Inactive user

PUT /auth/totp

curl \
 --request PUT 'http://api.example.com/auth/totp' \
 --header "Authorization: $API_KEY"

Resource to allow a user to enable TOTP.

POST /auth/totp

Jwt authorization

Responses

200

TOTP enabled
400

Invalid password Wrong or expired token Inactive user

POST /auth/totp

curl \
 --request POST 'http://api.example.com/auth/totp' \
 --header "Authorization: $API_KEY"

Resource to allow a user to disable TOTP.

DELETE /auth/totp

Jwt authorization

Responses

200

TOTP disabled
400

TOTP not enabled

DELETE /auth/totp

curl \
 --request DELETE 'http://api.example.com/auth/totp' \
 --header "Authorization: $API_KEY"

Resource to send an OTP by email to user.

GET /auth/email-otp

Jwt authorization

Responses

200

OTP by email sent
400

Invalid password Wrong or expired token Inactive user

GET /auth/email-otp

curl \
 --request GET 'http://api.example.com/auth/email-otp' \
 --header "Authorization: $API_KEY"

Resource to allow a user to pre-enable OTP by email.

PUT /auth/email-otp

Jwt authorization

Responses

200

OTP by email enabled
400

Invalid password Wrong or expired token Inactive user

PUT /auth/email-otp

curl \
 --request PUT 'http://api.example.com/auth/email-otp' \
 --header "Authorization: $API_KEY"

Resource to allow a user to enable OTP by email.

POST /auth/email-otp

Jwt authorization

Responses

200

OTP by email enabled
400

Invalid password Wrong or expired token Inactive user

POST /auth/email-otp

curl \
 --request POST 'http://api.example.com/auth/email-otp' \
 --header "Authorization: $API_KEY"

Resource to allow a user to disable OTP by email.

DELETE /auth/email-otp

Jwt authorization

Responses

200

OTP by email disabled.
400

Invalid password. Wrong or expired token. Inactive user. Wrong 2FA.

DELETE /auth/email-otp

curl \
 --request DELETE 'http://api.example.com/auth/email-otp' \
 --header "Authorization: $API_KEY"

Resource to allow a user to generate new recovery codes.

PUT /auth/recovery-codes

Jwt authorization

Responses

200

new recovery codes.
400

Invalid password Wrong or expired token Inactive user

PUT /auth/recovery-codes

curl \
 --request PUT 'http://api.example.com/auth/recovery-codes' \
 --header "Authorization: $API_KEY"

Resource to get a challenge for a FIDO device.

GET /auth/fido

Jwt authorization

Responses

200

Challenge for FIDO device.
400

Wrong parameter.

GET /auth/fido

curl \
 --request GET 'http://api.example.com/auth/fido' \
 --header "Authorization: $API_KEY"

Resource to allow a user to pre-register a FIDO device.

PUT /auth/fido

Jwt authorization

Responses

200

FIDO device pre-registered.
400

Invalid password Wrong or expired token Inactive user

PUT /auth/fido

curl \
 --request PUT 'http://api.example.com/auth/fido' \
 --header "Authorization: $API_KEY"

Resource to allow a user to register a FIDO device.

POST /auth/fido

Jwt authorization

Responses

200

FIDO device registered.
400

Invalid password Wrong or expired token Inactive user

POST /auth/fido

curl \
 --request POST 'http://api.example.com/auth/fido' \
 --header "Authorization: $API_KEY"

Resource to allow a user to unregister a FIDO device.

DELETE /auth/fido

Jwt authorization

Responses

200

FIDO device unregistered.
400

Invalid password Wrong or expired token Inactive user Wrong 2FA

DELETE /auth/fido

curl \
 --request DELETE 'http://api.example.com/auth/fido' \
 --header "Authorization: $API_KEY"

Resource to allow a user to login with SAML SSO.

POST /auth/saml/sso

Jwt authorization

Responses

302

Login successful, redirect to the home page.
400

Wrong parameter

POST /auth/saml/sso

curl \
 --request POST 'http://api.example.com/auth/saml/sso' \
 --header "Authorization: $API_KEY"

Resource to allow a user to login with SAML SSO.

GET /auth/saml/login

Jwt authorization

Responses

302

Redirect to the SAML IDP.
400

Wrong parameter.

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

Jwt authorization

Responses

200

All asset types

GET /data/asset-types

curl \
 --request GET 'http://api.example.com/data/asset-types' \
 --header "Authorization: $API_KEY"

Retrieve given asset type.

GET /data/asset-types/{asset_type_id}

Jwt authorization

Path parameters

asset_type_id Required

Responses

200

Given asset type

GET /data/asset-types/{asset_type_id}

curl \
 --request GET 'http://api.example.com/data/asset-types/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entities that are not shot, sequence, episode, or edit.

GET /data/assets

Jwt authorization

Adds project name and asset type name.

Responses

200

All assets

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.

GET /data/assets/all

Jwt authorization

Adds project name and asset type name.

Responses

200

All assets

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.

GET /data/assets/with-tasks

Jwt authorization

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.

Responses

200

All assets with tasks

GET /data/assets/with-tasks

curl \
 --request GET 'http://api.example.com/data/assets/with-tasks' \
 --header "Authorization: $API_KEY"

Retrieve given asset.

GET /data/assets/{asset_id}

Jwt authorization

Path parameters

asset_id Required

Responses

200

Given asset

GET /data/assets/{asset_id}

curl \
 --request GET 'http://api.example.com/data/assets/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete given asset.

DELETE /data/assets/{asset_id}

Jwt authorization

Path parameters

asset_id Required

Responses

204

Empty response

DELETE /data/assets/{asset_id}

curl \
 --request DELETE 'http://api.example.com/data/assets/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all assets linked to given asset.

GET /data/assets/{asset_id}/assets

Jwt authorization

Path parameters

asset_id Required

Responses

200

All assets linked to given asset

GET /data/assets/{asset_id}/assets

curl \
 --request GET 'http://api.example.com/data/assets/a24a6ea4-ce75-4665-a070-57453082c25/assets' \
 --header "Authorization: $API_KEY"

Retrieve all tasks related to given asset.

GET /data/assets/{asset_id}/tasks

Jwt authorization

Path parameters

asset_id Required

Responses

200

All tasks related to given asset

GET /data/assets/{asset_id}/tasks

curl \
 --request GET 'http://api.example.com/data/assets/a24a6ea4-ce75-4665-a070-57453082c25/tasks' \
 --header "Authorization: $API_KEY"

Retrieve all task types of tasks related to given asset.

GET /data/assets/{asset_id}/task-types

Jwt authorization

Path parameters

asset_id Required

Responses

200

All task types of tasks related to given asset

GET /data/assets/{asset_id}/task-types

curl \
 --request GET 'http://api.example.com/data/assets/a24a6ea4-ce75-4665-a070-57453082c25/task-types' \
 --header "Authorization: $API_KEY"

Retrieve the list of shots that cast given asset.

GET /data/assets/{asset_id}/cast-in

Jwt authorization

Path parameters

asset_id Required

Responses

200

List of shots that cast given asset

GET /data/assets/{asset_id}/cast-in

curl \
 --request GET 'http://api.example.com/data/assets/a24a6ea4-ce75-4665-a070-57453082c25/cast-in' \
 --header "Authorization: $API_KEY"

Retrieve the casting of a given asset.

GET /data/assets/{asset_id}/casting

Jwt authorization

Path parameters

asset_id Required

Responses

200

Casting of given asset

GET /data/assets/{asset_id}/casting

curl \
 --request GET 'http://api.example.com/data/assets/a24a6ea4-ce75-4665-a070-57453082c25/casting' \
 --header "Authorization: $API_KEY"

Modify the casting of given asset.

PUT /data/assets/{asset_id}/casting

Jwt authorization

Path parameters

asset_id Required

application/json

Body Required

object

Casting data to update

Responses

200

Modification of assets linked to given asset

PUT /data/assets/{asset_id}/casting

curl \
 --request PUT 'http://api.example.com/data/assets/a24a6ea4-ce75-4665-a070-57453082c25/casting' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json"

Request examples

{}

Retrieve all shot asset instances linked to given asset.

GET /data/assets/{asset_id}/shot-asset-instances

Jwt authorization

Path parameters

asset_id Required

Responses

200

All shot asset instances linked to given asset

GET /data/assets/{asset_id}/shot-asset-instances

curl \
 --request GET 'http://api.example.com/data/assets/a24a6ea4-ce75-4665-a070-57453082c25/shot-asset-instances' \
 --header "Authorization: $API_KEY"

Retrieve all scene asset instances linked to given asset.

GET /data/assets/{asset_id}/scene-asset-instances

Jwt authorization

Path parameters

asset_id Required

Responses

200

All scene asset instances linked to given asset

GET /data/assets/{asset_id}/scene-asset-instances

curl \
 --request GET 'http://api.example.com/data/assets/a24a6ea4-ce75-4665-a070-57453082c25/scene-asset-instances' \
 --header "Authorization: $API_KEY"

Retrieve all asset instances instantiated inside given asset.

GET /data/assets/{asset_id}/asset-asset-instances

Jwt authorization

Path parameters

asset_id Required

Responses

200

All asset instances instantiated inside given asset

GET /data/assets/{asset_id}/asset-asset-instances

curl \
 --request GET 'http://api.example.com/data/assets/a24a6ea4-ce75-4665-a070-57453082c25/asset-asset-instances' \
 --header "Authorization: $API_KEY"

Create an asset instance inside given asset.

POST /data/assets/{asset_id}/asset-asset-instances

Jwt authorization

Path parameters

asset_id Required

application/json

Body Required

asset_to_instantiate_id string(uuid) Required
description string

Responses

201

Asset instance created inside given asset

POST /data/assets/{asset_id}/asset-asset-instances

curl \
 --request POST 'http://api.example.com/data/assets/a24a6ea4-ce75-4665-a070-57453082c25/asset-asset-instances' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"asset_to_instantiate_id":"a24a6ea4-ce75-4665-a070-57453082c25","description":"Asset instance description"}'

Request examples

{
  "asset_to_instantiate_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "description": "Asset instance description"
}

Retrieve all assets for given project and asset type.

GET /data/projects/{project_id}/asset-types/{asset_type_id}/assets

Jwt authorization

Path parameters

project_id Required
asset_type_id Required

Responses

200

All assets for given project and asset type

GET /data/projects/{project_id}/asset-types/{asset_type_id}/assets

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/asset-types/a24a6ea4-ce75-4665-a070-57453082c25/assets' \
 --header "Authorization: $API_KEY"

Create new asset with given parameters.

POST /data/projects/{project_id}/asset-types/{asset_type_id}/assets/new

Jwt authorization

Path parameters

project_id Required
asset_type_id Required

application/json

Body Required

name string Required
description string Required
data string Required
is_shared boolean Required
source_id string(uuid) Required

Responses

201

New asset resource created

POST /data/projects/{project_id}/asset-types/{asset_type_id}/assets/new

curl \
 --request POST 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/asset-types/a24a6ea4-ce75-4665-a070-57453082c25/assets/new' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"name":"Character Name","description":"Main character","data":"{}","is_shared":false,"source_id":"a24a6ea4-ce75-4665-a070-57453082c25"}'

Request examples

{
  "name": "Character Name",
  "description": "Main character",
  "data": "{}",
  "is_shared": false,
  "source_id": "a24a6ea4-ce75-4665-a070-57453082c25"
}

Retrieve all asset types for given project.

GET /data/projects/{project_id}/asset-types

Jwt authorization

Path parameters

project_id Required

Responses

200

All asset types for given project

GET /data/projects/{project_id}/asset-types

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/asset-types' \
 --header "Authorization: $API_KEY"

Retrieve all asset types of assets casted in given shot.

GET /data/shots/{shot_id}/asset-types

Jwt authorization

Path parameters

shot_id Required

Responses

200

All asset types of assets casted in given shot

GET /data/shots/{shot_id}/asset-types

curl \
 --request GET 'http://api.example.com/data/shots/a24a6ea4-ce75-4665-a070-57453082c25/asset-types' \
 --header "Authorization: $API_KEY"

Retrieve all assets for given project.

GET /data/projects/{project_id}/assets

Jwt authorization

Path parameters

project_id Required

Responses

200

All assets for given project

GET /data/projects/{project_id}/assets

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/assets' \
 --header "Authorization: $API_KEY"

Share or unshare a list of assets.

POST /actions/assets/share

Jwt authorization

application/json

POST /actions/assets/share

curl \
 --request POST 'http://api.example.com/actions/assets/share' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"asset_ids":["a24a6ea4-ce75-4665-a070-57453082c25"],"is_shared":true}'

Request examples

{
  "asset_ids": [
    "a24a6ea4-ce75-4665-a070-57453082c25"
  ],
  "is_shared": true
}

Share or unshare all assets (or a list of assets) for given project.

POST /actions/projects/{project_id}/assets/share

Jwt authorization

application/json

POST /actions/projects/{project_id}/assets/share

curl \
 --request POST 'http://api.example.com/actions/projects/a24a6ea4-ce75-4665-a070-57453082c25/assets/share' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"asset_ids":["a24a6ea4-ce75-4665-a070-57453082c25"],"is_shared":true}'

Request examples

{
  "asset_ids": [
    "a24a6ea4-ce75-4665-a070-57453082c25"
  ],
  "is_shared": true
}

Share or unshare all assets for given project and asset type.

POST /actions/projects/{project_id}/asset-types/{asset_type_id}/assets/share

Jwt authorization

application/json

POST /actions/projects/{project_id}/asset-types/{asset_type_id}/assets/share

curl \
 --request POST 'http://api.example.com/actions/projects/a24a6ea4-ce75-4665-a070-57453082c25/asset-types/a24a6ea4-ce75-4665-a070-57453082c25/assets/share' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"is_shared":true}'

Request examples

{
  "is_shared": true
}

Retrieve all shared assets used in project.

GET /data/projects/{project_id}/assets/shared-used

Jwt authorization

Path parameters

project_id Required

Responses

200

All shared assets used in project

GET /data/projects/{project_id}/assets/shared-used

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/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

Jwt authorization

Path parameters

project_id Required
episode_id Required

Responses

200

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/a24a6ea4-ce75-4665-a070-57453082c25/episodes/a24a6ea4-ce75-4665-a070-57453082c25/assets/shared-used' \
 --header "Authorization: $API_KEY"

Resource to retrieve the casting of a given entity.

GET /data/projects/{project_id}/entities/{entity_id}/casting

Jwt authorization

Path parameters

project_id Required
entity_id Required

Responses

200

Casting of given entity

GET /data/projects/{project_id}/entities/{entity_id}/casting

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/entities/a24a6ea4-ce75-4665-a070-57453082c25/casting' \
 --header "Authorization: $API_KEY"

Resource to allow the modification of assets linked to an entity.

PUT /data/projects/{project_id}/entities/{entity_id}/casting

Jwt authorization

Path parameters

project_id Required
entity_id Required

Responses

200

Modification of assets linked to an entity

PUT /data/projects/{project_id}/entities/{entity_id}/casting

curl \
 --request PUT 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/entities/a24a6ea4-ce75-4665-a070-57453082c25/casting' \
 --header "Authorization: $API_KEY"

Resource to retrieve the casting of assets from given asset type.

GET /data/projects/{project_id}/asset-types/{asset_type_id}/casting

Jwt authorization

Path parameters

project_id Required
asset_type_id Required

Responses

200

Casting of assets from given asset type

GET /data/projects/{project_id}/asset-types/{asset_type_id}/casting

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/asset-types/a24a6ea4-ce75-4665-a070-57453082c25/casting' \
 --header "Authorization: $API_KEY"

Resource to retrieve the casting of episodes.

GET /data/projects/{project_id}/episodes/casting

Jwt authorization

Path parameters

project_id Required

Responses

200

Casting of episodes

GET /data/projects/{project_id}/episodes/casting

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/episodes/casting' \
 --header "Authorization: $API_KEY"

Resource to retrieve the casting of shots from given sequence.

GET /data/projects/{project_id}/sequences/{sequence_id}/casting

Jwt authorization

Path parameters

project_id Required
sequence_id Required

Responses

200

Casting of shots from given sequence

GET /data/projects/{project_id}/sequences/{sequence_id}/casting

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/sequences/a24a6ea4-ce75-4665-a070-57453082c25/casting' \
 --header "Authorization: $API_KEY"

Resource to retrieve the casting of shots from given episode.

GET /data/projects/{project_id}/episodes/{episode_id}/sequences/all/casting

Jwt authorization

Path parameters

project_id Required
episode_id Required

Responses

200

Casting for all shots from given episode.

GET /data/projects/{project_id}/episodes/{episode_id}/sequences/all/casting

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/episodes/a24a6ea4-ce75-4665-a070-57453082c25/sequences/all/casting' \
 --header "Authorization: $API_KEY"

Resource to retrieve the casting of shots from all sequences of given

GET /data/projects/{project_id}/sequences/all/casting

Jwt authorization

project.

Path parameters

project_id Required

Responses

200

Casting for all shots from given project.

GET /data/projects/{project_id}/sequences/all/casting

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/sequences/all/casting' \
 --header "Authorization: $API_KEY"

Retrieve all entity links related to given project.

GET /data/projects/{project_id}/entity-links

Jwt authorization

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

Query parameters

page
limit
cursor_created_at

Responses

200

All entity links related to given project

GET /data/projects/{project_id}/entity-links

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/entity-links' \
 --header "Authorization: $API_KEY"

Delete given entity link.

DELETE /data/projects/{project_id}/entity-links/{entity_link_id}

Jwt authorization

It's mainly used for synchronisation purpose.

Path parameters

project_id Required
entity_link_id Required

Responses

200

Entity link deleted

DELETE /data/projects/{project_id}/entity-links/{entity_link_id}

curl \
 --request DELETE 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/entity-links/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all asset instances linked to scene.

GET /data/scenes/{scene_id}/asset-instances

Jwt authorization

Path parameters

scene_id Required

Responses

200

All asset instances linked to given scene

GET /data/scenes/{scene_id}/asset-instances

curl \
 --request GET 'http://api.example.com/data/scenes/a24a6ea4-ce75-4665-a070-57453082c25/asset-instances' \
 --header "Authorization: $API_KEY"

Create an asset instance on given scene.

POST /data/scenes/{scene_id}/asset-instances

Jwt authorization

Path parameters

scene_id Required

Responses

201

Asset instances created on given scene

POST /data/scenes/{scene_id}/asset-instances

curl \
 --request POST 'http://api.example.com/data/scenes/a24a6ea4-ce75-4665-a070-57453082c25/asset-instances' \
 --header "Authorization: $API_KEY"

Retrieve all camera instances linked to scene.

GET /data/scenes/{scene_id}/camera-instances

Jwt authorization

Path parameters

scene_id Required

Responses

201

All camera instances linked to scene

GET /data/scenes/{scene_id}/camera-instances

curl \
 --request GET 'http://api.example.com/data/scenes/a24a6ea4-ce75-4665-a070-57453082c25/camera-instances' \
 --header "Authorization: $API_KEY"

Retrieve all asset instances linked to shot.

GET /data/shots/{shot_id}/asset-instances

Jwt authorization

Path parameters

shot_id Required

Responses

200

All assets linked to shot

GET /data/shots/{shot_id}/asset-instances

curl \
 --request GET 'http://api.example.com/data/shots/a24a6ea4-ce75-4665-a070-57453082c25/asset-instances' \
 --header "Authorization: $API_KEY"

Add an asset instance to given shot.

POST /data/shots/{shot_id}/asset-instances

Jwt authorization

Path parameters

shot_id Required

Responses

201

Asset instance added to given shot

POST /data/shots/{shot_id}/asset-instances

curl \
 --request POST 'http://api.example.com/data/shots/a24a6ea4-ce75-4665-a070-57453082c25/asset-instances' \
 --header "Authorization: $API_KEY"

Remove an asset instance from given shot.

DELETE /data/shots/{shot_id}/asset-instances/{asset_instance_id}

Jwt authorization

Path parameters

shot_id Required
asset_instance_id Required

Responses

204

Asset instance removed from given shot

DELETE /data/shots/{shot_id}/asset-instances/{asset_instance_id}

curl \
 --request DELETE 'http://api.example.com/data/shots/a24a6ea4-ce75-4665-a070-57453082c25/asset-instances/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Get chat details.

GET /data/entities/{entity_id}/chat

Jwt authorization

Path parameters

entity_id Required

ID of the entity related to the chat

Responses

200

Chat information

GET /data/entities/{entity_id}/chat

curl \
 --request GET 'http://api.example.com/data/entities/a24a6ea4-ce75-4665-a070-57453082c25/chat' \
 --header "Authorization: $API_KEY"

Get chat messages for an entity.

GET /data/entities/{entity_id}/chat/messages

Jwt authorization

Path parameters

entity_id Required

ID of the entity related to the chat

Responses

200

Chat messages

GET /data/entities/{entity_id}/chat/messages

curl \
 --request GET 'http://api.example.com/data/entities/a24a6ea4-ce75-4665-a070-57453082c25/chat/messages' \
 --header "Authorization: $API_KEY"

Create a new chat message.

POST /data/entities/{entity_id}/chat/messages

Jwt authorization

Path parameters

entity_id Required

ID of the entity related to the chat

Responses

201

Chat message created
400

Not participant of the chat

POST /data/entities/{entity_id}/chat/messages

curl \
 --request POST 'http://api.example.com/data/entities/a24a6ea4-ce75-4665-a070-57453082c25/chat/messages' \
 --header "Authorization: $API_KEY"

Get chat message.

GET /data/entities/{entity_id}/chat/messages/{chat_message_id}

Jwt authorization

Path parameters

entity_id Required

ID of the entity related to the chat
chat_message_id Required

ID of the chat message

Responses

200

Chat message

GET /data/entities/{entity_id}/chat/messages/{chat_message_id}

curl \
 --request GET 'http://api.example.com/data/entities/a24a6ea4-ce75-4665-a070-57453082c25/chat/messages/1' \
 --header "Authorization: $API_KEY"

Delete chat message.

DELETE /data/entities/{entity_id}/chat/messages/{chat_message_id}

Jwt authorization

Path parameters

entity_id Required

ID of the entity related to the chat
chat_message_id Required

ID of the chat message

Responses

204

Empty response

DELETE /data/entities/{entity_id}/chat/messages/{chat_message_id}

curl \
 --request DELETE 'http://api.example.com/data/entities/a24a6ea4-ce75-4665-a070-57453082c25/chat/messages/1' \
 --header "Authorization: $API_KEY"

Acknowledge given comment.

POST /data/tasks/{task_id}/comments/{comment_id}/ack

Jwt authorization

If it's already acknowledged, remove acknowledgement.

Path parameters

task_id Required
comment_id Required

Responses

200

Comment acknowledged

POST /data/tasks/{task_id}/comments/{comment_id}/ack

curl \
 --request POST 'http://api.example.com/data/tasks/a24a6ea4-ce75-4665-a070-57453082c25/comments/a24a6ea4-ce75-4665-a070-57453082c25/ack' \
 --header "Authorization: $API_KEY"

Reply to given comment.

POST /data/tasks/{task_id}/comments/{comment_id}/reply

Jwt authorization

Add comment to its replies list.

Path parameters

task_id Required
comment_id Required

Responses

200

Reply to given comment

POST /data/tasks/{task_id}/comments/{comment_id}/reply

curl \
 --request POST 'http://api.example.com/data/tasks/a24a6ea4-ce75-4665-a070-57453082c25/comments/a24a6ea4-ce75-4665-a070-57453082c25/reply' \
 --header "Authorization: $API_KEY"

Delete attachment linked to a comment matching given ID.

DELETE /data/tasks/{task_id}/comments/{comment_id}/attachments/{attachment_id}

Jwt authorization

Path parameters

task_id Required
comment_id Required
attachment_id Required

Responses

204

Empty response

DELETE /data/tasks/{task_id}/comments/{comment_id}/attachments/{attachment_id}

curl \
 --request DELETE 'http://api.example.com/data/tasks/a24a6ea4-ce75-4665-a070-57453082c25/comments/a24a6ea4-ce75-4665-a070-57453082c25/attachments/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete given comment reply.

DELETE /data/tasks/{task_id}/comments/{comment_id}/reply/{reply_id}

Jwt authorization

Path parameters

task_id Required
comment_id Required
reply_id Required

Responses

200

Given comment reply deleted

DELETE /data/tasks/{task_id}/comments/{comment_id}/reply/{reply_id}

curl \
 --request DELETE 'http://api.example.com/data/tasks/a24a6ea4-ce75-4665-a070-57453082c25/comments/a24a6ea4-ce75-4665-a070-57453082c25/reply/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Download attachment file.

GET /data/attachment-files/{attachment_file_id}/file/{file_name}

Jwt authorization

Path parameters

attachment_file_id Required
file_name Required

Responses

200

Attachment file downloaded
404

Download failed

GET /data/attachment-files/{attachment_file_id}/file/{file_name}

curl \
 --request GET 'http://api.example.com/data/attachment-files/a24a6ea4-ce75-4665-a070-57453082c25/file/filename' \
 --header "Authorization: $API_KEY"

Add given files to the comment entry as attachments.

POST /actions/tasks/{task_id}/comments/{comment_id}/add-attachment

Jwt authorization

Path parameters

task_id Required
comment_id Required

Responses

201

Given files added to the comment entry as attachments

POST /actions/tasks/{task_id}/comments/{comment_id}/add-attachment

curl \
 --request POST 'http://api.example.com/actions/tasks/a24a6ea4-ce75-4665-a070-57453082c25/comments/a24a6ea4-ce75-4665-a070-57453082c25/add-attachment' \
 --header "Authorization: $API_KEY"

Return all attachment files related to given project.

GET /data/projects/{project_id}/attachment-files

Jwt authorization

Path parameters

project_id Required

Responses

200

All attachment files related to given project

GET /data/projects/{project_id}/attachment-files

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/attachment-files' \
 --header "Authorization: $API_KEY"

Return all attachment files related to given task.

GET /data/tasks/{task_id}/attachment-files

Jwt authorization

Path parameters

task_id Required

Responses

200

All attachment files related to given task

GET /data/tasks/{task_id}/attachment-files

curl \
 --request GET 'http://api.example.com/data/tasks/a24a6ea4-ce75-4665-a070-57453082c25/attachment-files' \
 --header "Authorization: $API_KEY"

Create a new comment for given task.

POST /actions/tasks/{task_id}/comment

Jwt authorization

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

Responses

201

New comment created

POST /actions/tasks/{task_id}/comment

curl \
 --request POST 'http://api.example.com/actions/tasks/a24a6ea4-ce75-4665-a070-57453082c25/comment' \
 --header "Authorization: $API_KEY"

Create several comments at once.

POST /actions/projects/{project_id}/tasks/comment-many

Jwt authorization

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

Responses

201

Given files added to the comment entry as attachments

POST /actions/projects/{project_id}/tasks/comment-many

curl \
 --request POST 'http://api.example.com/actions/projects/a24a6ea4-ce75-4665-a070-57453082c25/tasks/comment-many' \
 --header "Authorization: $API_KEY"

Creates new comments for given task. Each comments requires a text, a

POST /actions/tasks/{task_id}/batch-comment

Jwt authorization

task_status and a person as arguments.

Path parameters

task_id Required

Responses

201

New comments created

POST /actions/tasks/{task_id}/batch-comment

curl \
 --request POST 'http://api.example.com/actions/tasks/a24a6ea4-ce75-4665-a070-57453082c25/batch-comment' \
 --header "Authorization: $API_KEY"

Creates new comments for given task. Each comments requires a task_id,

POST /actions/tasks/batch-comment

Jwt authorization

text, a task_status and a person as arguments.

Responses

201

New comments created

POST /actions/tasks/batch-comment

curl \
 --request POST 'http://api.example.com/actions/tasks/batch-comment' \
 --header "Authorization: $API_KEY"

Retrieve all concept entries.

GET /data/concepts

Jwt authorization

Filters can be specified in the query string.

Query parameters

project_id
parent_id

Responses

200

All concept entries

GET /data/concepts

curl \
 --request GET 'http://api.example.com/data/concepts' \
 --header "Authorization: $API_KEY"

Retrieve all concepts, adds project name and asset type name and all related tasks.

GET /data/concepts/with-tasks

Jwt authorization

Query parameters

project_id

Responses

200

All concepts

GET /data/concepts/with-tasks

curl \
 --request GET 'http://api.example.com/data/concepts/with-tasks' \
 --header "Authorization: $API_KEY"

Retrieve given concept.

GET /data/concepts/{concept_id}

Jwt authorization

Path parameters

concept_id Required

Responses

200

Given concept

GET /data/concepts/{concept_id}

curl \
 --request GET 'http://api.example.com/data/concepts/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete given concept.

DELETE /data/concepts/{concept_id}

Jwt authorization

Path parameters

concept_id Required

Responses

204

Given concept deleted

DELETE /data/concepts/{concept_id}

curl \
 --request DELETE 'http://api.example.com/data/concepts/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all task types related to a given concept.

GET /data/concepts/{concept_id}/task-types

Jwt authorization

Path parameters

concept_id Required

Responses

200

All task types related to given concept

GET /data/concepts/{concept_id}/task-types

curl \
 --request GET 'http://api.example.com/data/concepts/a24a6ea4-ce75-4665-a070-57453082c25/task-types' \
 --header "Authorization: $API_KEY"

Retrieve all tasks related to a given concept.

GET /data/concepts/{concept_id}/tasks

Jwt authorization

Path parameters

concept_id Required

Responses

200

All tasks related to given concept

GET /data/concepts/{concept_id}/tasks

curl \
 --request GET 'http://api.example.com/data/concepts/a24a6ea4-ce75-4665-a070-57453082c25/tasks' \
 --header "Authorization: $API_KEY"

Retrieve all previews related to a given concept.

GET /data/concepts/{concept_id}/preview-files

Jwt authorization

It sends them as a dict. Keys are related task type ids and values are arrays of preview for this task type.

Path parameters

concept_id Required

Responses

200

All previews related to given episode

GET /data/concepts/{concept_id}/preview-files

curl \
 --request GET 'http://api.example.com/data/concepts/a24a6ea4-ce75-4665-a070-57453082c25/preview-files' \
 --header "Authorization: $API_KEY"

Retrieve all concepts related to a given project.

GET /data/projects/{project_id}/concepts

Jwt authorization

Path parameters

project_id Required

Responses

200

All concepts related to given project

GET /data/projects/{project_id}/concepts

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/concepts' \
 --header "Authorization: $API_KEY"

Create a concept for given project.

POST /data/projects/{project_id}/concepts

Jwt authorization

Path parameters

project_id Required

Responses

201

Concept created for given project

POST /data/projects/{project_id}/concepts

curl \
 --request POST 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/concepts' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/persons

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

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.

POST /data/persons

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

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.

GET /data/persons/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/persons/{instance_id}

curl \
 --request GET 'http://api.example.com/data/persons/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/persons/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/persons/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/persons/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/projects

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

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.

POST /data/projects

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

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.

GET /data/projects/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/projects/{instance_id}

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/projects/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/projects/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/projects/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/projects/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/project-status

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

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.

POST /data/project-status

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

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.

GET /data/project-status/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/project-status/{instance_id}

curl \
 --request GET 'http://api.example.com/data/project-status/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/project-status/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/project-status/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/project-status/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/project-status/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/project-status/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/project-status/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/entity-types

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

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.

POST /data/entity-types

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

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.

GET /data/entity-types/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/entity-types/{instance_id}

curl \
 --request GET 'http://api.example.com/data/entity-types/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/entity-types/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/entity-types/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/entity-types/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/entity-types/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/entity-types/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/entity-types/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/entities

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

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.

POST /data/entities

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

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.

GET /data/entities/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/entities/{instance_id}

curl \
 --request GET 'http://api.example.com/data/entities/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/entities/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/entities/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/entities/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/task-types

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

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.

POST /data/task-types

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

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.

GET /data/task-types/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/task-types/{instance_id}

curl \
 --request GET 'http://api.example.com/data/task-types/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/task-types/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/task-types/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/task-types/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/task-types/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/task-types/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/task-types/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/task-status

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

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.

POST /data/task-status

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

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.

GET /data/task-status/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/task-status/{instance_id}

curl \
 --request GET 'http://api.example.com/data/task-status/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/task-status/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/task-status/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/task-status/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/task-status/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/task-status/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/task-status/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/tasks

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

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.

GET /data/tasks/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/tasks/{instance_id}

curl \
 --request GET 'http://api.example.com/data/tasks/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/tasks/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/tasks/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/tasks/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/departments

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

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.

POST /data/departments

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

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.

GET /data/departments/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/departments/{instance_id}

curl \
 --request GET 'http://api.example.com/data/departments/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/departments/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/departments/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/departments/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/departments/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/departments/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/departments/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/organisations

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

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.

POST /data/organisations

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

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.

GET /data/organisations/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/organisations/{instance_id}

curl \
 --request GET 'http://api.example.com/data/organisations/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/organisations/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/organisations/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/organisations/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/organisations/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/organisations/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/organisations/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/file-status/

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

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.

POST /data/file-status/

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

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.

GET /data/file-status/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/file-status/{instance_id}

curl \
 --request GET 'http://api.example.com/data/file-status/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/file-status/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/file-status/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/file-status/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/file-status/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/file-status/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/file-status/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/softwares

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

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.

POST /data/softwares

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

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

GET /data/softwares/{instance_id}

Jwt authorization

JSON object.

Path parameters

software_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

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.

PUT /data/softwares/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/softwares/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/softwares/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/softwares/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/softwares/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/softwares/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/hardware-items

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

GET /data/hardware-items

curl \
 --request GET 'http://api.example.com/data/hardware-items' \
 --header "Authorization: $API_KEY"

Create a model with data given in the request body.

POST /data/hardware-items

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

POST /data/hardware-items

curl \
 --request POST 'http://api.example.com/data/hardware-items' \
 --header "Authorization: $API_KEY"

Retrieve a model corresponding at given ID and return it as a JSON object.

GET /data/hardware-items/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/hardware-items/{instance_id}

curl \
 --request GET 'http://api.example.com/data/hardware-items/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/hardware-items/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/hardware-items/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/hardware-items/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/hardware-items/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/hardware-items/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/hardware-items/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/output-files

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

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.

POST /data/output-files

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

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

GET /data/output-files/{instance_id}

Jwt authorization

object.

Path parameters

output_file_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

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.

PUT /data/output-files/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/output-files/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/output-files/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/output-files/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/output-files/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/output-files/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/output-types

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

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.

POST /data/output-types

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

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

GET /data/output-types/{instance_id}

Jwt authorization

JSON object.

Path parameters

output_type_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

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.

PUT /data/output-types/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/output-types/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/output-types/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/output-types/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/output-types/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/output-types/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/preview-files

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

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.

POST /data/preview-files

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

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.

GET /data/preview-files/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/preview-files/{instance_id}

curl \
 --request GET 'http://api.example.com/data/preview-files/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/preview-files/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/preview-files/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/preview-files/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a preview file corresponding at given ID and retuns

DELETE /data/preview-files/{instance_id}

Jwt authorization

a 204 status code.

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/preview-files/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/preview-files/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/working-files

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

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.

POST /data/working-files

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

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

GET /data/working-files/{instance_id}

Jwt authorization

JSON object.

Path parameters

working_file_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

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.

PUT /data/working-files/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/working-files/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/working-files/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/working-files/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/working-files/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/working-files/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/attachment-files

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

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.

POST /data/attachment-files

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

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.

GET /data/attachment-files/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/attachment-files/{instance_id}

curl \
 --request GET 'http://api.example.com/data/attachment-files/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/attachment-files/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/attachment-files/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/attachment-files/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/attachment-files/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/attachment-files/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/attachment-files/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/comments

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

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.

POST /data/comments

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

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.

GET /data/comments/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/comments/{instance_id}

curl \
 --request GET 'http://api.example.com/data/comments/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/comments/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/comments/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/comments/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/time-spents/

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

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.

POST /data/time-spents/

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

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.

GET /data/time-spents/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/time-spents/{instance_id}

curl \
 --request GET 'http://api.example.com/data/time-spents/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/time-spents/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/time-spents/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/time-spents/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/time-spents/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/time-spents/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/time-spents/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/day-offs/

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

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.

POST /data/day-offs/

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

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.

GET /data/day-offs/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/day-offs/{instance_id}

curl \
 --request GET 'http://api.example.com/data/day-offs/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/day-offs/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/day-offs/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/day-offs/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/day-offs/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/day-offs/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/day-offs/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/custom-actions/

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

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.

POST /data/custom-actions/

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

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.

GET /data/custom-actions/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/custom-actions/{instance_id}

curl \
 --request GET 'http://api.example.com/data/custom-actions/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/custom-actions/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/custom-actions/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/custom-actions/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/custom-actions/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/custom-actions/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/custom-actions/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/status-automations/

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

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.

POST /data/status-automations/

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

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.

GET /data/status-automations/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/status-automations/{instance_id}

curl \
 --request GET 'http://api.example.com/data/status-automations/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/status-automations/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/status-automations/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/status-automations/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/asset-instances/

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

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.

POST /data/asset-instances/

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

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.

GET /data/asset-instances/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/asset-instances/{instance_id}

curl \
 --request GET 'http://api.example.com/data/asset-instances/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/asset-instances/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/asset-instances/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/asset-instances/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/asset-instances/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/asset-instances/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/asset-instances/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/playlists/

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

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.

POST /data/playlists/

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

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.

GET /data/playlists/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/playlists/{instance_id}

curl \
 --request GET 'http://api.example.com/data/playlists/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/playlists/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/playlists/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/playlists/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/playlists/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/playlists/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/playlists/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/events/

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

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.

POST /data/events/

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

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.

GET /data/events/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/events/{instance_id}

curl \
 --request GET 'http://api.example.com/data/events/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/events/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/events/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/events/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/events/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/events/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/events/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/notifications/

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

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.

POST /data/notifications/

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

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.

GET /data/notifications/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/notifications/{instance_id}

curl \
 --request GET 'http://api.example.com/data/notifications/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/notifications/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/notifications/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/notifications/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/notifications/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/notifications/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/notifications/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/search-filters/

Jwt authorization

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.

POST /data/search-filters/

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

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.

GET /data/search-filters/{instance_id}

Jwt authorization

GET /data/search-filters/{instance_id}

curl \
 --request GET 'http://api.example.com/data/search-filters/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/search-filters/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

PUT /data/search-filters/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/search-filters/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/search-filters/{instance_id}

Jwt authorization

DELETE /data/search-filters/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/search-filters/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/search-filter-groups/

Jwt authorization

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.

POST /data/search-filter-groups/

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

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.

GET /data/search-filter-groups/{instance_id}

Jwt authorization

GET /data/search-filter-groups/{instance_id}

curl \
 --request GET 'http://api.example.com/data/search-filter-groups/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/search-filter-groups/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

PUT /data/search-filter-groups/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/search-filter-groups/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/search-filter-groups/{instance_id}

Jwt authorization

DELETE /data/search-filter-groups/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/search-filter-groups/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/schedule-items/

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

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.

POST /data/schedule-items/

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

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.

GET /data/schedule-items/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/schedule-items/{instance_id}

curl \
 --request GET 'http://api.example.com/data/schedule-items/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/schedule-items/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/schedule-items/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/schedule-items/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/schedule-items/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/schedule-items/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/schedule-items/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/news/

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

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.

POST /data/news/

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

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.

GET /data/news/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/news/{instance_id}

curl \
 --request GET 'http://api.example.com/data/news/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/news/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/news/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/news/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/news/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/news/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/news/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/milestones/

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

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.

POST /data/milestones/

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

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.

GET /data/milestones/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/milestones/{instance_id}

curl \
 --request GET 'http://api.example.com/data/milestones/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/milestones/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/milestones/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/milestones/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/milestones/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/milestones/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/milestones/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/metadata-descriptors/

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

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.

POST /data/metadata-descriptors/

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

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.

GET /data/metadata-descriptors/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/metadata-descriptors/{instance_id}

curl \
 --request GET 'http://api.example.com/data/metadata-descriptors/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/metadata-descriptors/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/metadata-descriptors/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/metadata-descriptors/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/metadata-descriptors/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/metadata-descriptors/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/metadata-descriptors/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/subscriptions/

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

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.

POST /data/subscriptions/

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

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.

GET /data/subscriptions/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/subscriptions/{instance_id}

curl \
 --request GET 'http://api.example.com/data/subscriptions/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/subscriptions/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/subscriptions/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/subscriptions/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/subscriptions/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/subscriptions/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/subscriptions/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/entity-links/

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

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.

POST /data/entity-links/

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

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.

GET /data/entity-links/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/entity-links/{instance_id}

curl \
 --request GET 'http://api.example.com/data/entity-links/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/entity-links/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/entity-links/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/entity-links/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/entity-links/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/entity-links/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/entity-links/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/chats/

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

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.

POST /data/chats/

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

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.

GET /data/chats/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/chats/{instance_id}

curl \
 --request GET 'http://api.example.com/data/chats/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/chats/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/chats/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/chats/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/chats/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/chats/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/chats/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/chat-messages/

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

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.

POST /data/chat-messages/

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

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.

GET /data/chat-messages/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/chat-messages/{instance_id}

curl \
 --request GET 'http://api.example.com/data/chat-messages/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/chat-messages/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/chat-messages/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/chat-messages/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/chat-messages/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/chat-messages/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/chat-messages/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/preview-background-files

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

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.

POST /data/preview-background-files

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

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.

GET /data/preview-background-files/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/preview-background-files/{instance_id}

curl \
 --request GET 'http://api.example.com/data/preview-background-files/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/preview-background-files/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/preview-background-files/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/preview-background-files/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/preview-background-files/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/preview-background-files/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/preview-background-files/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/studios

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

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.

POST /data/studios

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

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.

GET /data/studios/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/studios/{instance_id}

curl \
 --request GET 'http://api.example.com/data/studios/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/studios/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/studios/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/studios/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/studios/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/studios/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/studios/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all salary scale entries.

GET /data/salary-scales

Jwt authorization

Retrieve all salary scale entries.

Responses

200

All salary scale entries
403

Permission denied

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.

POST /data/salary-scales

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

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.

GET /data/salary-scales/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/salary-scales/{instance_id}

curl \
 --request GET 'http://api.example.com/data/salary-scales/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/salary-scales/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/salary-scales/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/salary-scales/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/salary-scales/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/salary-scales/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/salary-scales/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve a model corresponding at given ID and return it as a JSON object.

GET /data/plugins/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/plugins/{instance_id}

curl \
 --request GET 'http://api.example.com/data/plugins/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/plugins/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/plugins/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/plugins/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/plugins/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/plugins/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/plugins/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/plugins

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

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.

POST /data/plugins

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

POST /data/plugins

curl \
 --request POST 'http://api.example.com/data/plugins' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/production-schedule-versions

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

GET /data/production-schedule-versions

curl \
 --request GET 'http://api.example.com/data/production-schedule-versions' \
 --header "Authorization: $API_KEY"

Create a model with data given in the request body.

POST /data/production-schedule-versions

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

POST /data/production-schedule-versions

curl \
 --request POST 'http://api.example.com/data/production-schedule-versions' \
 --header "Authorization: $API_KEY"

Retrieve a model corresponding at given ID and return it as a JSON object.

GET /data/production-schedule-versions/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/production-schedule-versions/{instance_id}

curl \
 --request GET 'http://api.example.com/data/production-schedule-versions/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/production-schedule-versions/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/production-schedule-versions/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/production-schedule-versions/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/production-schedule-versions/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/production-schedule-versions/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/production-schedule-versions/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve a model corresponding at given ID and return it as a JSON object.

GET /data/production-schedule-version-task-links/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Model as a JSON object
400

Statement error
404

Value error

GET /data/production-schedule-version-task-links/{instance_id}

curl \
 --request GET 'http://api.example.com/data/production-schedule-version-task-links/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/production-schedule-version-task-links/{instance_id}

Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Path parameters

instance_id Required

Responses

200

Model updated
400

Error

PUT /data/production-schedule-version-task-links/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/production-schedule-version-task-links/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/production-schedule-version-task-links/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

204

Model deleted
400

Statement or integrity error
404

Instance non-existant

DELETE /data/production-schedule-version-task-links/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/production-schedule-version-task-links/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/production-schedule-version-task-links

Jwt authorization

Filters can be specified in the query string.

Responses

200

All entries for given model
400

Format error
403

Permission denied

GET /data/production-schedule-version-task-links

curl \
 --request GET 'http://api.example.com/data/production-schedule-version-task-links' \
 --header "Authorization: $API_KEY"

Create a model with data given in the request body.

POST /data/production-schedule-version-task-links

Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

200

Model created
400

Error

POST /data/production-schedule-version-task-links

curl \
 --request POST 'http://api.example.com/data/production-schedule-version-task-links' \
 --header "Authorization: $API_KEY"

Get all software items for all departments.

GET /data/departments/software-licenses

Jwt authorization

Responses

200

A dictionary of departments with their software items

GET /data/departments/software-licenses

curl \
 --request GET 'http://api.example.com/data/departments/software-licenses' \
 --header "Authorization: $API_KEY"

Add a software item to given department.

POST /data/departments/{department_id}/software-licenses

Jwt authorization

Path parameters

department_id Required

Responses

201

User added to given department
404

Department ID or Software ID matches no department or software

POST /data/departments/{department_id}/software-licenses

curl \
 --request POST 'http://api.example.com/data/departments/a24a6ea4-ce75-4665-a070-57453082c25/software-licenses' \
 --header "Authorization: $API_KEY"

Get all software items for a given department.

GET /data/departments/{department_id}/software-licenses/{software_id}

Jwt authorization

Path parameters

department_id Required

Responses

200

Software items for given department
404

Department ID matches no department

GET /data/departments/{department_id}/software-licenses/{software_id}

curl \
 --request GET 'http://api.example.com/data/departments/a24a6ea4-ce75-4665-a070-57453082c25/software-licenses/{software_id}' \
 --header "Authorization: $API_KEY"

Remove a software item from given department.

DELETE /data/departments/{department_id}/software-licenses/{software_id}

Jwt authorization

Path parameters

software_id Required
department_id Required

Responses

204

User removed from given department
404

Department or software ID matches no department or software

DELETE /data/departments/{department_id}/software-licenses/{software_id}

curl \
 --request DELETE 'http://api.example.com/data/departments/a24a6ea4-ce75-4665-a070-57453082c25/software-licenses/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Get all hardware items for all departments.

GET /data/departments/hardware-items

Jwt authorization

Responses

200

A dictionary of departments with their hardware items

GET /data/departments/hardware-items

curl \
 --request GET 'http://api.example.com/data/departments/hardware-items' \
 --header "Authorization: $API_KEY"

Add a hardware item to given department.

POST /data/departments/{department_id}/hardware-items

Jwt authorization

Path parameters

department_id Required

Responses

201

Hardware item added to given department
404

Department ID matches no department
400

Hardware item ID matches no hardware item

POST /data/departments/{department_id}/hardware-items

curl \
 --request POST 'http://api.example.com/data/departments/a24a6ea4-ce75-4665-a070-57453082c25/hardware-items' \
 --header "Authorization: $API_KEY"

Get all hardware items for a given department.

GET /data/departments/{department_id}/hardware-items/{hardware_item_id}

Jwt authorization

Path parameters

department_id Required

Responses

200

Hardware items for given department
404

Department ID matches no department

GET /data/departments/{department_id}/hardware-items/{hardware_item_id}

curl \
 --request GET 'http://api.example.com/data/departments/a24a6ea4-ce75-4665-a070-57453082c25/hardware-items/{hardware_item_id}' \
 --header "Authorization: $API_KEY"

Remove a hardware item from given department.

DELETE /data/departments/{department_id}/hardware-items/{hardware_item_id}

Jwt authorization

Path parameters

department_id Required
hardware_item_id Required

Responses

204

User removed from given department
404

Department or software ID matches no department or software

DELETE /data/departments/{department_id}/hardware-items/{hardware_item_id}

curl \
 --request DELETE 'http://api.example.com/data/departments/a24a6ea4-ce75-4665-a070-57453082c25/hardware-items/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all edit entries.

GET /data/edits

Jwt authorization

Filters can be specified in the query string.

Query parameters

project_id
name
force

Responses

200

All edit entries

GET /data/edits

curl \
 --request GET 'http://api.example.com/data/edits' \
 --header "Authorization: $API_KEY"

Retrieve all edit entries.

GET /data/edits/all

Jwt authorization

Filters can be specified in the query string.

Query parameters

project_id
name
force

Responses

200

All edit entries

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

Jwt authorization

Query parameters

project_id
name
force

Responses

200

All edits and all related tasks.

GET /data/edits/with-tasks

curl \
 --request GET 'http://api.example.com/data/edits/with-tasks' \
 --header "Authorization: $API_KEY"

Retrieve given edit.

GET /data/edits/{edit_id}

Jwt authorization

Path parameters

edit_id Required

Responses

200

Given edit

GET /data/edits/{edit_id}

curl \
 --request GET 'http://api.example.com/data/edits/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete given edit.

DELETE /data/edits/{edit_id}

Jwt authorization

Path parameters

edit_id Required

Responses

204

Given edit deleted

DELETE /data/edits/{edit_id}

curl \
 --request DELETE 'http://api.example.com/data/edits/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all task types related to a given edit.

GET /data/edits/{edit_id}/task-types

Jwt authorization

Path parameters

edit_id Required

Responses

200

All task types related to given edit

GET /data/edits/{edit_id}/task-types

curl \
 --request GET 'http://api.example.com/data/edits/a24a6ea4-ce75-4665-a070-57453082c25/task-types' \
 --header "Authorization: $API_KEY"

Retrieve all tasks related to a given edit.

GET /data/edits/{edit_id}/tasks

Jwt authorization

Path parameters

edit_id Required

Responses

200

All tasks related to given edit

GET /data/edits/{edit_id}/tasks

curl \
 --request GET 'http://api.example.com/data/edits/a24a6ea4-ce75-4665-a070-57453082c25/tasks' \
 --header "Authorization: $API_KEY"

Retrieve all previews related to a given edit.

GET /data/edits/{edit_id}/preview-files

Jwt authorization

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

Responses

200

All previews related to given edit

GET /data/edits/{edit_id}/preview-files

curl \
 --request GET 'http://api.example.com/data/edits/a24a6ea4-ce75-4665-a070-57453082c25/preview-files' \
 --header "Authorization: $API_KEY"

Retrieve data versions of given edit.

GET /data/edits/{edit_id}/versions

Jwt authorization

Path parameters

edit_id Required

Responses

200

Data versions of given edit

GET /data/edits/{edit_id}/versions

curl \
 --request GET 'http://api.example.com/data/edits/a24a6ea4-ce75-4665-a070-57453082c25/versions' \
 --header "Authorization: $API_KEY"

Retrieve all edits related to a given episode.

GET /data/episodes/{episode_id}/edits

Jwt authorization

Path parameters

episode_id Required

Responses

200

All efits related to given episode

GET /data/episodes/{episode_id}/edits

curl \
 --request GET 'http://api.example.com/data/episodes/a24a6ea4-ce75-4665-a070-57453082c25/edits' \
 --header "Authorization: $API_KEY"

Retrieve all tasks related to a given episode.

GET /data/episodes/{episode_id}/edit-tasks

Jwt authorization

Path parameters

episode_id Required

Responses

200

All tasks related to given episode

GET /data/episodes/{episode_id}/edit-tasks

curl \
 --request GET 'http://api.example.com/data/episodes/a24a6ea4-ce75-4665-a070-57453082c25/edit-tasks' \
 --header "Authorization: $API_KEY"

Retrieve all edits related to a given project.

GET /data/projects/{project_id}/edits

Jwt authorization

Path parameters

project_id Required

Responses

200

All edits related to given project

GET /data/projects/{project_id}/edits

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/edits' \
 --header "Authorization: $API_KEY"

Create an edit for given project.

POST /data/projects/{project_id}/edits

Jwt authorization

Path parameters

project_id Required

Responses

201

Edit created for given project

POST /data/projects/{project_id}/edits

curl \
 --request POST 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/edits' \
 --header "Authorization: $API_KEY"

Retrieve all news linked to a given entity.

GET /data/entities/{entity_id}/news

Jwt authorization

Path parameters

entity_id Required

Responses

200

All news linked to given entity

GET /data/entities/{entity_id}/news

curl \
 --request GET 'http://api.example.com/data/entities/a24a6ea4-ce75-4665-a070-57453082c25/news' \
 --header "Authorization: $API_KEY"

Retrieve all preview files linked to a given entity.

GET /data/entities/{entity_id}/preview-files

Jwt authorization

Path parameters

entity_id Required

Responses

200

All preview files linked to given entity

GET /data/entities/{entity_id}/preview-files

curl \
 --request GET 'http://api.example.com/data/entities/a24a6ea4-ce75-4665-a070-57453082c25/preview-files' \
 --header "Authorization: $API_KEY"

Retrieve all time spents linked to a given entity.

GET /data/entities/{entity_id}/time-spents

Jwt authorization

Path parameters

entity_id Required

Responses

200

All time spents linked to given entity

GET /data/entities/{entity_id}/time-spents

curl \
 --request GET 'http://api.example.com/data/entities/a24a6ea4-ce75-4665-a070-57453082c25/time-spents' \
 --header "Authorization: $API_KEY"

Resource to retrieve the entities linked on a given entity.

GET /data/entities/{entity_id}/entities-linked/with-tasks

Jwt authorization

Path parameters

entity_id Required

Responses

200

Entities linked on given entity

GET /data/entities/{entity_id}/entities-linked/with-tasks

curl \
 --request GET 'http://api.example.com/data/entities/a24a6ea4-ce75-4665-a070-57453082c25/entities-linked/with-tasks' \
 --header "Authorization: $API_KEY"

Retrieve last events.

GET /data/events/last

Jwt authorization

Query parameters

after
before
only_files
limit
project_id

Responses

200

All login logs

GET /data/events/last

curl \
 --request GET 'http://api.example.com/data/events/last' \
 --header "Authorization: $API_KEY"

Retrieve all login logs.

GET /data/events/login-logs/last

Jwt authorization

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.

GET /export/csv/projects/{project_id}/assets.csv

Jwt authorization

Path parameters

project_id Required

Responses

200

Assets exported as csv

GET /export/csv/projects/{project_id}/assets.csv

curl \
 --request GET 'http://api.example.com/export/csv/projects/a24a6ea4-ce75-4665-a070-57453082c25/assets.csv' \
 --header "Authorization: $API_KEY"

Export shots linked to a given project as csv.

GET /export/csv/projects/{project_id}/shots.csv

Jwt authorization

Path parameters

project_id Required

Responses

200

Shots exported as csv

GET /export/csv/projects/{project_id}/shots.csv

curl \
 --request GET 'http://api.example.com/export/csv/projects/a24a6ea4-ce75-4665-a070-57453082c25/shots.csv' \
 --header "Authorization: $API_KEY"

Export casting linked to a given project as csv.

GET /export/csv/projects/{project_id}/casting.csv

Jwt authorization

Path parameters

project_id Required

Responses

200

Casting exported as csv

GET /export/csv/projects/{project_id}/casting.csv

curl \
 --request GET 'http://api.example.com/export/csv/projects/a24a6ea4-ce75-4665-a070-57453082c25/casting.csv' \
 --header "Authorization: $API_KEY"

Export edits linked to a given project as csv.

GET /export/csv/projects/{project_id}/edits.csv

Jwt authorization

Path parameters

project_id Required

Responses

200

Edits exported as csv

GET /export/csv/projects/{project_id}/edits.csv

curl \
 --request GET 'http://api.example.com/export/csv/projects/a24a6ea4-ce75-4665-a070-57453082c25/edits.csv' \
 --header "Authorization: $API_KEY"

Export a given playlist as csv.

GET /export/csv/playlists/{playlist_id}

Jwt authorization

Path parameters

playlist_id Required

Responses

200

Playlist exported as csv

GET /export/csv/playlists/{playlist_id}

curl \
 --request GET 'http://api.example.com/export/csv/playlists/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Export as csv.

GET /export/csv/persons.csv

Jwt authorization

Responses

200

Exported as csv

GET /export/csv/persons.csv

curl \
 --request GET 'http://api.example.com/export/csv/persons.csv' \
 --header "Authorization: $API_KEY"

Export as csv.

GET /export/csv/projects.csv

Jwt authorization

Responses

200

Exported as csv

GET /export/csv/projects.csv

curl \
 --request GET 'http://api.example.com/export/csv/projects.csv' \
 --header "Authorization: $API_KEY"

Export as csv.

GET /export/csv/tasks.csv

Jwt authorization

Responses

200

Exported as csv

GET /export/csv/tasks.csv

curl \
 --request GET 'http://api.example.com/export/csv/tasks.csv' \
 --header "Authorization: $API_KEY"

Export as csv.

GET /export/csv/time-spents.csv

Jwt authorization

Responses

200

Exported as csv

GET /export/csv/time-spents.csv

curl \
 --request GET 'http://api.example.com/export/csv/time-spents.csv' \
 --header "Authorization: $API_KEY"

Export as csv.

GET /export/csv/task-types.csv

Jwt authorization

Responses

200

Exported as csv

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

GET /data/files/{file_id}

Jwt authorization

output file.

Path parameters

file_id Required

Responses

200

Information about file

GET /data/files/{file_id}

curl \
 --request GET 'http://api.example.com/data/files/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Return last working files revision for each file name for given task.

GET /data/tasks/{task_id}/working-files

Jwt authorization

Path parameters

task_id Required

Responses

200

Last working files revision for each file name for given task

GET /data/tasks/{task_id}/working-files

curl \
 --request GET 'http://api.example.com/data/tasks/a24a6ea4-ce75-4665-a070-57453082c25/working-files' \
 --header "Authorization: $API_KEY"

Create new working file.

POST /data/tasks/{task_id}/working-files/new

Jwt authorization

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

Responses

201

New working file created
400

Given working file already exists

POST /data/tasks/{task_id}/working-files/new

curl \
 --request POST 'http://api.example.com/data/tasks/a24a6ea4-ce75-4665-a070-57453082c25/working-files/new' \
 --header "Authorization: $API_KEY"

Return last working files revision for each file name for given task.

GET /data/tasks/{task_id}/working-files/last-revisions

Jwt authorization

Path parameters

task_id Required

Responses

200

Last working files revision for each file name for given task

GET /data/tasks/{task_id}/working-files/last-revisions

curl \
 --request GET 'http://api.example.com/data/tasks/a24a6ea4-ce75-4665-a070-57453082c25/working-files/last-revisions' \
 --header "Authorization: $API_KEY"

Generate a working file path from file tree template.

POST /data/tasks/{task_id}/working-file-path

Jwt authorization

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

Responses

200

Working file path generated
400

Malformed file tree

POST /data/tasks/{task_id}/working-file-path

curl \
 --request POST 'http://api.example.com/data/tasks/a24a6ea4-ce75-4665-a070-57453082c25/working-file-path' \
 --header "Authorization: $API_KEY"

Create new output file linked to assets through an instance of this asset for a given shot.

POST /data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-files/new

Jwt authorization

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

Responses

200

New output file created
400

Given output file already exists Given person not found Given output type not found

POST /data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-files/new

curl \
 --request POST 'http://api.example.com/data/asset-instances/a24a6ea4-ce75-4665-a070-57453082c25/entities/a24a6ea4-ce75-4665-a070-57453082c25/output-files/new' \
 --header "Authorization: $API_KEY"

Get next revision for given asset instance, output type, task type and name.

POST /data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-files/next-revision

Jwt authorization

Path parameters

asset_instance_id Required
temporal_entity_id Required

Responses

200

Next revision for given asset instance, output type, task type and name

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/a24a6ea4-ce75-4665-a070-57453082c25/entities/a24a6ea4-ce75-4665-a070-57453082c25/output-files/next-revision' \
 --header "Authorization: $API_KEY"

Get last revisions of output files for given instance grouped by output type and file name.

GET /data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-files/last-revisions

Jwt authorization

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

Responses

200

Last revisions of output files for given instance grouped by output type and file name

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/a24a6ea4-ce75-4665-a070-57453082c25/entities/a24a6ea4-ce75-4665-a070-57453082c25/output-files/last-revisions?output_type_id=a24a6ea4-ce75-4665-a070-57453082c25&task_type_id=a24a6ea4-ce75-4665-a070-57453082c25&file_status_id=a24a6ea4-ce75-4665-a070-57453082c25&representation=cache' \
 --header "Authorization: $API_KEY"

Return all types of output generated for given instance.

GET /data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-types

Jwt authorization

Path parameters

asset_instance_id Required
temporal_entity_id Required

Responses

200

All types of output generated for given instance and temporal_entity

GET /data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-types

curl \
 --request GET 'http://api.example.com/data/asset-instances/a24a6ea4-ce75-4665-a070-57453082c25/entities/a24a6ea4-ce75-4665-a070-57453082c25/output-types' \
 --header "Authorization: $API_KEY"

Get all output files for given asset instance and given output type.

GET /data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-types/{output_type_id}/output-files

Jwt authorization

Path parameters

asset_instance_id Required
temporal_entity_id Required
output_type_id Required

Responses

200

All output files for given asset instance and given output type

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/a24a6ea4-ce75-4665-a070-57453082c25/entities/a24a6ea4-ce75-4665-a070-57453082c25/output-types/a24a6ea4-ce75-4665-a070-57453082c25/output-files' \
 --header "Authorization: $API_KEY"

Generate an output file path from file tree template

POST /data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-file-path

Jwt authorization

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

Responses

200

Output file path generated
400

Malformed file tree

POST /data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-file-path

curl \
 --request POST 'http://api.example.com/data/asset-instances/a24a6ea4-ce75-4665-a070-57453082c25/entities/a24a6ea4-ce75-4665-a070-57453082c25/output-file-path' \
 --header "Authorization: $API_KEY"

Get all working files for a given entity and possibly a task and a name.

GET /data/entities/{entity_id}/working-files

Jwt authorization

Path parameters

entity_id Required

Responses

200

All working files for given entity and possibly a task and a name

GET /data/entities/{entity_id}/working-files

curl \
 --request GET 'http://api.example.com/data/entities/a24a6ea4-ce75-4665-a070-57453082c25/working-files' \
 --header "Authorization: $API_KEY"

Create new output file linked to a given entity.

POST /data/entities/{entity_id}/output-files/new

Jwt authorization

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

Responses

200

New output file created
400

Given output file already exists Given person not found Given output type not found

POST /data/entities/{entity_id}/output-files/new

curl \
 --request POST 'http://api.example.com/data/entities/a24a6ea4-ce75-4665-a070-57453082c25/output-files/new' \
 --header "Authorization: $API_KEY"

Get next revision for given entity, output type, task type and name.

POST /data/entities/{entity_id}/output-files/next-revision

Jwt authorization

Path parameters

entity_id Required

Responses

200

Next revision for given entity, output type, task type and name

POST /data/entities/{entity_id}/output-files/next-revision

curl \
 --request POST 'http://api.example.com/data/entities/a24a6ea4-ce75-4665-a070-57453082c25/output-files/next-revision' \
 --header "Authorization: $API_KEY"

Get last revisions of output files for given entity grouped by output type and file name.

GET /data/entities/{entity_id}/output-files/last-revisions

Jwt authorization

Path parameters

entity_id Required

Responses

200

Last revisions of output files for given entity grouped by output type and file name

GET /data/entities/{entity_id}/output-files/last-revisions

curl \
 --request GET 'http://api.example.com/data/entities/a24a6ea4-ce75-4665-a070-57453082c25/output-files/last-revisions' \
 --header "Authorization: $API_KEY"

Return all types of output generated for given entity.

GET /data/entities/{entity_id}/output-types

Jwt authorization

Path parameters

entity_id Required

Responses

200

All types of output generated for given entity

GET /data/entities/{entity_id}/output-types

curl \
 --request GET 'http://api.example.com/data/entities/a24a6ea4-ce75-4665-a070-57453082c25/output-types' \
 --header "Authorization: $API_KEY"

Get all output files for given entity and given output type.

GET /data/entities/{entity_id}/output-types/{output_type_id}/output-files

Jwt authorization

Path parameters

entity_id Required
output_type_id Required

Responses

200

All output files for given entity and given output type

GET /data/entities/{entity_id}/output-types/{output_type_id}/output-files

curl \
 --request GET 'http://api.example.com/data/entities/a24a6ea4-ce75-4665-a070-57453082c25/output-types/a24a6ea4-ce75-4665-a070-57453082c25/output-files' \
 --header "Authorization: $API_KEY"

Get all output files for given entity.

GET /data/entities/{entity_id}/output-files

Jwt authorization

Path parameters

entity_id Required

Query parameters

output_type_id Required
task_type_id Required
file_status_id Required
representation Required

Responses

200

All output files for given entity

GET /data/entities/{entity_id}/output-files

curl \
 --request GET 'http://api.example.com/data/entities/a24a6ea4-ce75-4665-a070-57453082c25/output-files?output_type_id=a24a6ea4-ce75-4665-a070-57453082c25&task_type_id=a24a6ea4-ce75-4665-a070-57453082c25&file_status_id=a24a6ea4-ce75-4665-a070-57453082c25&representation=cache' \
 --header "Authorization: $API_KEY"

Get all output files for given poject.

GET /data/projects/{project_id}/output-files

Jwt authorization

Path parameters

project_id Required

Query parameters

output_type_id Required
task_type_id Required
file_status_id Required
representation Required

Responses

200

All output files for given project.

GET /data/projects/{project_id}/output-files

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/output-files?output_type_id=a24a6ea4-ce75-4665-a070-57453082c25&task_type_id=a24a6ea4-ce75-4665-a070-57453082c25&file_status_id=a24a6ea4-ce75-4665-a070-57453082c25&representation=cache' \
 --header "Authorization: $API_KEY"

Get all output files for given asset instance and given output type.

GET /data/asset-instances/{asset_instance_id}/output-files

Jwt authorization

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

Responses

200

All output files for given asset instance and given temporal entity (shot, sequence, etc.)

GET /data/asset-instances/{asset_instance_id}/output-files

curl \
 --request GET 'http://api.example.com/data/asset-instances/a24a6ea4-ce75-4665-a070-57453082c25/output-files?temporal_entity_id=cache&output_type_id=a24a6ea4-ce75-4665-a070-57453082c25&task_type_id=a24a6ea4-ce75-4665-a070-57453082c25&file_status_id=a24a6ea4-ce75-4665-a070-57453082c25&representation=cache' \
 --header "Authorization: $API_KEY"

Generate an output file path from file tree template

POST /data/entities/{entity_id}/output-file-path

Jwt authorization

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

Responses

200

Output file path generated
400

Malformed file tree

POST /data/entities/{entity_id}/output-file-path

curl \
 --request POST 'http://api.example.com/data/entities/a24a6ea4-ce75-4665-a070-57453082c25/output-file-path' \
 --header "Authorization: $API_KEY"

Download a working file.

GET /data/working-files/{working_file_id}/file

Jwt authorization

Path parameters

working_file_id Required

Responses

200

Working file downloaded

GET /data/working-files/{working_file_id}/file

curl \
 --request GET 'http://api.example.com/data/working-files/a24a6ea4-ce75-4665-a070-57453082c25/file' \
 --header "Authorization: $API_KEY"

Store a working file.

POST /data/working-files/{working_file_id}/file

Jwt authorization

Path parameters

working_file_id Required

Responses

201

Working file stored

POST /data/working-files/{working_file_id}/file

curl \
 --request POST 'http://api.example.com/data/working-files/a24a6ea4-ce75-4665-a070-57453082c25/file' \
 --header "Authorization: $API_KEY"

Define a template file to use for given project.

POST /actions/projects/{project_id}/set-file-tree

Jwt authorization

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

Responses

200

Template file defined
400

Selected tree not available

POST /actions/projects/{project_id}/set-file-tree

curl \
 --request POST 'http://api.example.com/actions/projects/a24a6ea4-ce75-4665-a070-57453082c25/set-file-tree' \
 --header "Authorization: $API_KEY"

Update comment on given working file.

PUT /actions/working-files/{working_file_id}/comment

Jwt authorization

Path parameters

working_file_id Required

Responses

200

Comment updated on given working file

PUT /actions/working-files/{working_file_id}/comment

curl \
 --request PUT 'http://api.example.com/actions/working-files/a24a6ea4-ce75-4665-a070-57453082c25/comment' \
 --header "Authorization: $API_KEY"

Update working file modification date with current date.

PUT /actions/working-files/{working_file_id}/modified

Jwt authorization

Path parameters

working_file_id Required

Responses

200

Working file modification date updated

PUT /actions/working-files/{working_file_id}/modified

curl \
 --request PUT 'http://api.example.com/actions/working-files/a24a6ea4-ce75-4665-a070-57453082c25/modified' \
 --header "Authorization: $API_KEY"

Import shotgun resource.

POST /import/shotgun/persons

Jwt authorization

Responses

200

Resource imported

POST /import/shotgun/persons

curl \
 --request POST 'http://api.example.com/import/shotgun/persons' \
 --header "Authorization: $API_KEY"

Import shotgun resource.

POST /import/shotgun/projects

Jwt authorization

Responses

200

Resource imported

POST /import/shotgun/projects

curl \
 --request POST 'http://api.example.com/import/shotgun/projects' \
 --header "Authorization: $API_KEY"

Import shotgun resource.

POST /import/shotgun/episodes

Jwt authorization

Responses

200

Resource imported

POST /import/shotgun/episodes

curl \
 --request POST 'http://api.example.com/import/shotgun/episodes' \
 --header "Authorization: $API_KEY"

Import shotgun resource.

POST /import/shotgun/sequences

Jwt authorization

Responses

200

Resource imported

POST /import/shotgun/sequences

curl \
 --request POST 'http://api.example.com/import/shotgun/sequences' \
 --header "Authorization: $API_KEY"

Import shotgun resource.

POST /import/shotgun/shots

Jwt authorization

Responses

200

Resource imported

POST /import/shotgun/shots

curl \
 --request POST 'http://api.example.com/import/shotgun/shots' \
 --header "Authorization: $API_KEY"

Import shotgun resource.

POST /import/shotgun/scenes

Jwt authorization

Responses

200

Resource imported

POST /import/shotgun/scenes

curl \
 --request POST 'http://api.example.com/import/shotgun/scenes' \
 --header "Authorization: $API_KEY"

Import shotgun resource.

POST /import/shotgun/assets

Jwt authorization

Responses

200

Resource imported

POST /import/shotgun/assets

curl \
 --request POST 'http://api.example.com/import/shotgun/assets' \
 --header "Authorization: $API_KEY"

Import shotgun resource.

POST /import/shotgun/steps

Jwt authorization

Responses

200

Resource imported

POST /import/shotgun/steps

curl \
 --request POST 'http://api.example.com/import/shotgun/steps' \
 --header "Authorization: $API_KEY"

Import shotgun resource.

POST /import/shotgun/status

Jwt authorization

Responses

200

Resource imported

POST /import/shotgun/status

curl \
 --request POST 'http://api.example.com/import/shotgun/status' \
 --header "Authorization: $API_KEY"

Import shotgun resource.

POST /import/shotgun/tasks

Jwt authorization

Responses

200

Resource imported

POST /import/shotgun/tasks

curl \
 --request POST 'http://api.example.com/import/shotgun/tasks' \
 --header "Authorization: $API_KEY"

Import shotgun resource.

POST /import/shotgun/versions

Jwt authorization

Responses

200

Resource imported

POST /import/shotgun/versions

curl \
 --request POST 'http://api.example.com/import/shotgun/versions' \
 --header "Authorization: $API_KEY"

Import shotgun resource.

POST /import/shotgun/notes

Jwt authorization

Responses

200

Resource imported

POST /import/shotgun/notes

curl \
 --request POST 'http://api.example.com/import/shotgun/notes' \
 --header "Authorization: $API_KEY"

Import shotgun error resource.

GET /import/shotgun/errors

Jwt authorization

Responses

200

Resource imported

GET /import/shotgun/errors

curl \
 --request GET 'http://api.example.com/import/shotgun/errors' \
 --header "Authorization: $API_KEY"

Serialize shotgun error resource.

POST /import/shotgun/errors

Jwt authorization

Responses

200

Resource serialized

POST /import/shotgun/errors

curl \
 --request POST 'http://api.example.com/import/shotgun/errors' \
 --header "Authorization: $API_KEY"

Import shotgun resource.

POST /import/shotgun/projectconnections

Jwt authorization

Responses

200

Resource imported

POST /import/shotgun/projectconnections

curl \
 --request POST 'http://api.example.com/import/shotgun/projectconnections' \
 --header "Authorization: $API_KEY"

Delete error.

DELETE /import/shotgun/errors/{error_id}

Jwt authorization

Path parameters

error_id Required

Responses

204

Error deleted
404

Error non-existant or Statement error

DELETE /import/shotgun/errors/{error_id}

curl \
 --request DELETE 'http://api.example.com/import/shotgun/errors/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Import remove instance.

POST /import/shotgun/remove/project

Jwt authorization

Responses

204

Instance removed

POST /import/shotgun/remove/project

curl \
 --request POST 'http://api.example.com/import/shotgun/remove/project' \
 --header "Authorization: $API_KEY"

Import remove instance.

POST /import/shotgun/remove/person

Jwt authorization

Responses

204

Instance removed

POST /import/shotgun/remove/person

curl \
 --request POST 'http://api.example.com/import/shotgun/remove/person' \
 --header "Authorization: $API_KEY"

Import remove instance.

POST /import/shotgun/remove/shot

Jwt authorization

Responses

204

Instance removed

POST /import/shotgun/remove/shot

curl \
 --request POST 'http://api.example.com/import/shotgun/remove/shot' \
 --header "Authorization: $API_KEY"

Import remove instance.

POST /import/shotgun/remove/scene

Jwt authorization

Responses

204

Instance removed

POST /import/shotgun/remove/scene

curl \
 --request POST 'http://api.example.com/import/shotgun/remove/scene' \
 --header "Authorization: $API_KEY"

Import remove instance.

POST /import/shotgun/remove/episode

Jwt authorization

Responses

204

Instance removed

POST /import/shotgun/remove/episode

curl \
 --request POST 'http://api.example.com/import/shotgun/remove/episode' \
 --header "Authorization: $API_KEY"

Import remove instance.

POST /import/shotgun/remove/sequence

Jwt authorization

Responses

204

Instance removed

POST /import/shotgun/remove/sequence

curl \
 --request POST 'http://api.example.com/import/shotgun/remove/sequence' \
 --header "Authorization: $API_KEY"

Import remove instance.

POST /import/shotgun/remove/asset

Jwt authorization

Responses

204

Instance removed

POST /import/shotgun/remove/asset

curl \
 --request POST 'http://api.example.com/import/shotgun/remove/asset' \
 --header "Authorization: $API_KEY"

Import remove instance.

POST /import/shotgun/remove/projectconnection

Jwt authorization

Responses

204

Instance removed

POST /import/shotgun/remove/projectconnection

curl \
 --request POST 'http://api.example.com/import/shotgun/remove/projectconnection' \
 --header "Authorization: $API_KEY"

Import remove instance.

POST /import/shotgun/remove/step

Jwt authorization

Responses

204

Instance removed

POST /import/shotgun/remove/step

curl \
 --request POST 'http://api.example.com/import/shotgun/remove/step' \
 --header "Authorization: $API_KEY"

Import remove instance.

POST /import/shotgun/remove/status

Jwt authorization

Responses

204

Instance removed

POST /import/shotgun/remove/status

curl \
 --request POST 'http://api.example.com/import/shotgun/remove/status' \
 --header "Authorization: $API_KEY"

Import remove instance.

POST /import/shotgun/remove/task

Jwt authorization

Responses

204

Instance removed

POST /import/shotgun/remove/task

curl \
 --request POST 'http://api.example.com/import/shotgun/remove/task' \
 --header "Authorization: $API_KEY"

Import remove instance.

POST /import/shotgun/remove/note

Jwt authorization

Responses

204

Instance removed

POST /import/shotgun/remove/note

curl \
 --request POST 'http://api.example.com/import/shotgun/remove/note' \
 --header "Authorization: $API_KEY"

Import remove instance.

POST /import/shotgun/remove/version

Jwt authorization

Responses

204

Instance removed

POST /import/shotgun/remove/version

curl \
 --request POST 'http://api.example.com/import/shotgun/remove/version' \
 --header "Authorization: $API_KEY"

Import persons via a .csv file.

POST /import/csv/persons

Jwt authorization

Responses

201

The lists of imported persons.
400

The .csv file is not properly formatted.

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.

POST /import/csv/projects/{project_id}/assets

Jwt authorization

Path parameters

project_id Required

Responses

201

The lists of imported assets.
400

The .csv file is not properly formatted.

POST /import/csv/projects/{project_id}/assets

curl \
 --request POST 'http://api.example.com/import/csv/projects/a24a6ea4-ce75-4665-a070-57453082c25/assets' \
 --header "Authorization: $API_KEY"

Import project shots via a .csv file.

POST /import/csv/projects/{project_id}/shots

Jwt authorization

Path parameters

project_id Required

Responses

201

The lists of imported assets.
400

The .csv file is not properly formatted.

POST /import/csv/projects/{project_id}/shots

curl \
 --request POST 'http://api.example.com/import/csv/projects/a24a6ea4-ce75-4665-a070-57453082c25/shots' \
 --header "Authorization: $API_KEY"

Import project edits.

POST /import/csv/projects/{project_id}/edits

Jwt authorization

Path parameters

project_id Required

Responses

201

Edits imported
400

Format error

POST /import/csv/projects/{project_id}/edits

curl \
 --request POST 'http://api.example.com/import/csv/projects/a24a6ea4-ce75-4665-a070-57453082c25/edits' \
 --header "Authorization: $API_KEY"

Import project casting links via a .csv file.

POST /import/csv/projects/{project_id}/casting

Jwt authorization

Path parameters

project_id Required

Responses

201

The lists of imported casting links.
400

The .csv file is not properly formatted.

POST /import/csv/projects/{project_id}/casting

curl \
 --request POST 'http://api.example.com/import/csv/projects/a24a6ea4-ce75-4665-a070-57453082c25/casting' \
 --header "Authorization: $API_KEY"

Import the estimations of task-types for given project.

POST /import/csv/projects/{project_id}/task-types/{task_type_id}/estimations

Jwt authorization

Path parameters

project_id Required
task_type_id Required

Responses

201

Estimations imported
400

Format error

POST /import/csv/projects/{project_id}/task-types/{task_type_id}/estimations

curl \
 --request POST 'http://api.example.com/import/csv/projects/a24a6ea4-ce75-4665-a070-57453082c25/task-types/a24a6ea4-ce75-4665-a070-57453082c25/estimations' \
 --header "Authorization: $API_KEY"

Import the estimations of task-types for given episode of given project.

POST /import/csv/projects/{project_id}/episodes/{episode_id}/task-types/{task_type_id}/estimations

Jwt authorization

Path parameters

project_id Required
task_type_id Required
episode_id Required

Responses

201

Estimations imported
400

Format error

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/a24a6ea4-ce75-4665-a070-57453082c25/episodes/a24a6ea4-ce75-4665-a070-57453082c25/task-types/a24a6ea4-ce75-4665-a070-57453082c25/estimations' \
 --header "Authorization: $API_KEY"

Import an OTIO file to enter frame_in / frame_out / nb_frames (it can

POST /import/otio/projects/{project_id}

Jwt authorization

be every adapter supported by OpenTimelineIO, for example: EDL, OTIO...
).

Path parameters

project_id Required

Responses

201

.
400

The .otio file is not properly formatted.

POST /import/otio/projects/{project_id}

curl \
 --request POST 'http://api.example.com/import/otio/projects/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Import an OTIO file to enter frame_in / frame_out / nb_frames (it can

POST /import/otio/projects/{project_id}/episodes/{episode_id}

Jwt authorization

be every adapter supported by OpenTimelineIO, for example: edl, otio...
).

Path parameters

project_id Required
episode_id Required

Responses

201

.
400

The .otio file is not properly formatted.

POST /import/otio/projects/{project_id}/episodes/{episode_id}

curl \
 --request POST 'http://api.example.com/import/otio/projects/a24a6ea4-ce75-4665-a070-57453082c25/episodes/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Import Kitsu resource.

POST /import/kitsu/comments

Jwt authorization

Responses

200

Resource imported

POST /import/kitsu/comments

curl \
 --request POST 'http://api.example.com/import/kitsu/comments' \
 --header "Authorization: $API_KEY"

Import Kitsu resource.

POST /import/kitsu/entities

Jwt authorization

Responses

200

Resource imported

POST /import/kitsu/entities

curl \
 --request POST 'http://api.example.com/import/kitsu/entities' \
 --header "Authorization: $API_KEY"

Import Kitsu resource.

POST /import/kitsu/entity-links

Jwt authorization

Responses

200

Resource imported

POST /import/kitsu/entity-links

curl \
 --request POST 'http://api.example.com/import/kitsu/entity-links' \
 --header "Authorization: $API_KEY"

Import Kitsu resource.

POST /import/kitsu/projects

Jwt authorization

Responses

200

Resource imported

POST /import/kitsu/projects

curl \
 --request POST 'http://api.example.com/import/kitsu/projects' \
 --header "Authorization: $API_KEY"

Import Kitsu resource.

POST /import/kitsu/tasks

Jwt authorization

Responses

200

Resource imported

POST /import/kitsu/tasks

curl \
 --request POST 'http://api.example.com/import/kitsu/tasks' \
 --header "Authorization: $API_KEY"

Get API name and version.

GET /

Jwt authorization

Responses

200

API name and version

GET /

curl \
 --request GET 'http://api.example.com/' \
 --header "Authorization: $API_KEY"

Retrieve API name, version and status.

GET /status

Jwt authorization

Responses

200

API name, version and status

GET /status

curl \
 --request GET 'http://api.example.com/status' \
 --header "Authorization: $API_KEY"

Retrieve status of database and time.

GET /status/influx

Jwt authorization

Responses

200

Status of database, key value, event stream, job queue and time

GET /status/influx

curl \
 --request GET 'http://api.example.com/status/influx' \
 --header "Authorization: $API_KEY"

Retrieve date and CPU, memory and jobs stats.

GET /status/resources

Jwt authorization

Responses

200

Date and CPU, memory and jobs stats

GET /status/resources

curl \
 --request GET 'http://api.example.com/status/resources' \
 --header "Authorization: $API_KEY"

Retrieve API name, version and status as txt.

GET /status.txt

Jwt authorization

Responses

200

API name, version and status as txt

GET /status.txt

curl \
 --request GET 'http://api.example.com/status.txt' \
 --header "Authorization: $API_KEY"

Generate a main:test event.

GET /status/test-event

Jwt authorization

Responses

200

Success flage

GET /status/test-event

curl \
 --request GET 'http://api.example.com/status/test-event' \
 --header "Authorization: $API_KEY"

Retrieve main stats.

GET /stats

Jwt authorization

Responses

403

Permission denied
200

Main stats

GET /stats

curl \
 --request GET 'http://api.example.com/stats' \
 --header "Authorization: $API_KEY"

Get basic configuration for the current instance.

GET /config

Jwt authorization

Responses

200

Configuration object including self-hosted status, Crisp token, indexer configuration, SAML status, and dark theme status.

GET /config

curl \
 --request GET 'http://api.example.com/config' \
 --header "Authorization: $API_KEY"

Retrieve all news related to a given project

GET /data/projects/news

Jwt authorization

Query parameters

project_id Required
before
after
page
limit
person_id
task_type_id
task_status_id
episode_id
only_preview

Responses

200

All news from user open projects.

GET /data/projects/news

curl \
 --request GET 'http://api.example.com/data/projects/news?project_id=a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all news related to a given project

GET /data/projects/{project_id}/news

Jwt authorization

Path parameters

project_id Required

Query parameters

before
after
page
limit
person_id
task_type_id
task_status_id
episode_id
only_preview

Responses

200

All news related to given project

GET /data/projects/{project_id}/news

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/news' \
 --header "Authorization: $API_KEY"

Retrieve a single given news related to a given project

GET /data/projects/{project_id}/news/{news_id}

Jwt authorization

Path parameters

project_id Required
news_id Required

Responses

200

Single given news related to given project

GET /data/projects/{project_id}/news/{news_id}

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/news/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve desktop login logs.

GET /data/persons/{person_id}/desktop-login-logs

Jwt authorization

Desktop login logs can only be created by current user.

GET /data/persons/{person_id}/desktop-login-logs

curl \
 --request GET 'http://api.example.com/data/persons/a24a6ea4-ce75-4665-a070-57453082c25/desktop-login-logs' \
 --header "Authorization: $API_KEY"

Create desktop login logs.

POST /data/persons/{person_id}/desktop-login-logs

Jwt authorization

Add a new log entry for desktop logins.

POST /data/persons/{person_id}/desktop-login-logs

curl \
 --request POST 'http://api.example.com/data/persons/a24a6ea4-ce75-4665-a070-57453082c25/desktop-login-logs' \
 --header "Authorization: $API_KEY"

Return a csv file containing the presence logs based on a daily basis.

GET /data/persons/presence-logs/{month_date}

Jwt authorization

Path parameters

month_date Required

Responses

200

CSV file containing the presence logs based on a daily basis

GET /data/persons/presence-logs/{month_date}

curl \
 --request GET 'http://api.example.com/data/persons/presence-logs/2022-07' \
 --header "Authorization: $API_KEY"

Get time spents for given person and date.

GET /data/persons/{person_id}/time-spents/{date}

Jwt authorization

Path parameters

person_id Required
date Required

Responses

200

Time spents for given person and date
404

Wrong date format

GET /data/persons/{person_id}/time-spents/{date}

curl \
 --request GET 'http://api.example.com/data/persons/a24a6ea4-ce75-4665-a070-57453082c25/time-spents/2022-07-12' \
 --header "Authorization: $API_KEY"

Get day off object for given person and date.

GET /data/persons/{person_id}/day-offs/{date}

Jwt authorization

Path parameters

person_id Required
date Required

Responses

200

Day off object for given person and date
404

Wrong date format

GET /data/persons/{person_id}/day-offs/{date}

curl \
 --request GET 'http://api.example.com/data/persons/a24a6ea4-ce75-4665-a070-57453082c25/day-offs/2022-07-12' \
 --header "Authorization: $API_KEY"

Get aggregated time spents for given person and year.

GET /data/persons/{person_id}/time-spents/year/{year}

Jwt authorization

Path parameters

person_id Required
year Required

Responses

200

Aggregated time spents for given person and year
404

Wrong date format

GET /data/persons/{person_id}/time-spents/year/{year}

curl \
 --request GET 'http://api.example.com/data/persons/a24a6ea4-ce75-4665-a070-57453082c25/time-spents/year/2022' \
 --header "Authorization: $API_KEY"

Get aggregated time spents for given person and month.

GET /data/persons/{person_id}/time-spents/month/{year}/{month}

Jwt authorization

Path parameters

person_id Required
year Required
month Required

Responses

200

Aggregated time spents for given person and month
404

Wrong date format

GET /data/persons/{person_id}/time-spents/month/{year}/{month}

curl \
 --request GET 'http://api.example.com/data/persons/a24a6ea4-ce75-4665-a070-57453082c25/time-spents/month/2022/7' \
 --header "Authorization: $API_KEY"

Get aggregated time spents for given person and week.

GET /data/persons/{person_id}/time-spents/week/{year}/{week}

Jwt authorization

Path parameters

person_id Required
year Required
week Required

Responses

200

Aggregated time spents for given person and week
404

Wrong date format

GET /data/persons/{person_id}/time-spents/week/{year}/{week}

curl \
 --request GET 'http://api.example.com/data/persons/a24a6ea4-ce75-4665-a070-57453082c25/time-spents/week/2022/35' \
 --header "Authorization: $API_KEY"

Get aggregated time spents for given person and day.

GET /data/persons/{person_id}/time-spents/day/{year}/{month}/{day}

Jwt authorization

Path parameters

person_id Required
year Required
month Required
day Required

Responses

200

Aggregated time spents for given person and day
404

Wrong date format

GET /data/persons/{person_id}/time-spents/day/{year}/{month}/{day}

curl \
 --request GET 'http://api.example.com/data/persons/a24a6ea4-ce75-4665-a070-57453082c25/time-spents/day/2022/7/12' \
 --header "Authorization: $API_KEY"

Get ended shots used for quota calculation of this month.

GET /data/persons/{person_id}/quota-shots/month/{year}/{month}

Jwt authorization

Path parameters

person_id Required
year Required
month Required

Query parameters

count_mode Required

Responses

200

Ended shots used for quota calculation of this month
404

Wrong date format

GET /data/persons/{person_id}/quota-shots/month/{year}/{month}

curl \
 --request GET 'http://api.example.com/data/persons/a24a6ea4-ce75-4665-a070-57453082c25/quota-shots/month/2022/7?count_mode=weighted' \
 --header "Authorization: $API_KEY"

Get ended shots used for quota calculation of this week.

GET /data/persons/{person_id}/quota-shots/week/{year}/{week}

Jwt authorization

Path parameters

person_id Required
year Required
week Required

Query parameters

count_mode Required

Responses

200

Ended shots used for quota calculation of this week
404

Wrong date format

GET /data/persons/{person_id}/quota-shots/week/{year}/{week}

curl \
 --request GET 'http://api.example.com/data/persons/a24a6ea4-ce75-4665-a070-57453082c25/quota-shots/week/2022/35?count_mode=weighted' \
 --header "Authorization: $API_KEY"

Get ended shots used for quota calculation of this day.

GET /data/persons/{person_id}/quota-shots/day/{year}/{month}/{day}

Jwt authorization

Path parameters

person_id Required
year Required
month Required
day Required

Query parameters

count_mode Required

Responses

200

Ended shots used for quota calculation of this day
404

Wrong date format

GET /data/persons/{person_id}/quota-shots/day/{year}/{month}/{day}

curl \
 --request GET 'http://api.example.com/data/persons/a24a6ea4-ce75-4665-a070-57453082c25/quota-shots/day/2022/7/12?count_mode=weighted' \
 --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/

Jwt authorization

Responses

200

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.

GET /data/persons/time-spents/month-table/{year}

Jwt authorization

Path parameters

year Required

Responses

200

Table giving time spent by user and by month for given year

GET /data/persons/time-spents/month-table/{year}

curl \
 --request GET 'http://api.example.com/data/persons/time-spents/month-table/2022' \
 --header "Authorization: $API_KEY"

Return a table giving time spent by user and by week for given year.

GET /data/persons/time-spents/week-table/{year}

Jwt authorization

Path parameters

year Required

Responses

200

Table giving time spent by user and by week for given year

GET /data/persons/time-spents/week-table/{year}

curl \
 --request GET 'http://api.example.com/data/persons/time-spents/week-table/2022' \
 --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}

Jwt authorization

Path parameters

year Required
month Required

Responses

200

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/2022/7' \
 --header "Authorization: $API_KEY"

Return all day off recorded for given month.

GET /data/persons/day-offs/{year}/{month}

Jwt authorization

Path parameters

year Required
month Required

Responses

200

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/2022/7' \
 --header "Authorization: $API_KEY"

Return all day off recorded for given week and person.

GET /data/persons/{person_id}/day-offs/week/{year}/{week}

Jwt authorization

Path parameters

person_id Required
year Required
week Required

Responses

200

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/a24a6ea4-ce75-4665-a070-57453082c25/day-offs/week/2022/35' \
 --header "Authorization: $API_KEY"

Return all day off recorded for given month and person.

GET /data/persons/{person_id}/day-offs/month/{year}/{month}

Jwt authorization

Path parameters

person_id Required
year Required
month Required

Responses

200

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/a24a6ea4-ce75-4665-a070-57453082c25/day-offs/month/2022/7' \
 --header "Authorization: $API_KEY"

Return all day off recorded for given year and person.

GET /data/persons/{person_id}/day-offs/year/{year}

Jwt authorization

Path parameters

person_id Required
year Required

Responses

200

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/a24a6ea4-ce75-4665-a070-57453082c25/day-offs/year/2022' \
 --header "Authorization: $API_KEY"

Return all day offs recorded for given and person.

GET /data/persons/{person_id}/day-offs

Jwt authorization

Path parameters

person_id Required

Responses

200

All day off recorded for given person.

GET /data/persons/{person_id}/day-offs

curl \
 --request GET 'http://api.example.com/data/persons/a24a6ea4-ce75-4665-a070-57453082c25/day-offs' \
 --header "Authorization: $API_KEY"

Sends an email to given person to invite him/her to connect to Kitsu.

GET /actions/persons/{person_id}/invite

Jwt authorization

Path parameters

person_id Required

Responses

200

Email sent

GET /actions/persons/{person_id}/invite

curl \
 --request GET 'http://api.example.com/actions/persons/a24a6ea4-ce75-4665-a070-57453082c25/invite' \
 --header "Authorization: $API_KEY"

Add a user to given department.

POST /actions/persons/{person_id}/departments/add

Jwt authorization

Path parameters

person_id Required

Responses

201

User added to given department

POST /actions/persons/{person_id}/departments/add

curl \
 --request POST 'http://api.example.com/actions/persons/a24a6ea4-ce75-4665-a070-57453082c25/departments/add' \
 --header "Authorization: $API_KEY"

Remove a user from given department.

DELETE /actions/persons/{person_id}/departments/{department_id}

Jwt authorization

Path parameters

person_id Required
department_id Required

Responses

204

User removed from given department

DELETE /actions/persons/{person_id}/departments/{department_id}

curl \
 --request DELETE 'http://api.example.com/actions/persons/a24a6ea4-ce75-4665-a070-57453082c25/departments/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Allow admin to change password for given user.

POST /actions/persons/{person_id}/change-password

Jwt authorization

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

Responses

200

Password changed
400

Invalid password or inactive user

POST /actions/persons/{person_id}/change-password

curl \
 --request POST 'http://api.example.com/actions/persons/a24a6ea4-ce75-4665-a070-57453082c25/change-password' \
 --header "Authorization: $API_KEY"

Allow admin to disable two factor authentication for given user.

DELETE /actions/persons/{person_id}/disable-two-factor-authentication

Jwt authorization

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

Responses

200

Two factor authentication disabled
400

Inactive user

DELETE /actions/persons/{person_id}/disable-two-factor-authentication

curl \
 --request DELETE 'http://api.example.com/actions/persons/a24a6ea4-ce75-4665-a070-57453082c25/disable-two-factor-authentication' \
 --header "Authorization: $API_KEY"

Retrieve all playlists related to given project.

GET /data/projects/{project_id}/playlists

Jwt authorization

Result is paginated and can be sorted.

Path parameters

project_id Required

Query parameters

page
sort_by
task_type_id

Responses

200

All playlists related to given project

GET /data/projects/{project_id}/playlists

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/playlists' \
 --header "Authorization: $API_KEY"

Retrieve all playlists related to given project.

GET /data/projects/{project_id}/playlists/all

Jwt authorization

It's mainly used for synchronisation purpose.

Path parameters

project_id Required

Responses

200

All playlists related to given project

GET /data/projects/{project_id}/playlists/all

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/playlists/all' \
 --header "Authorization: $API_KEY"

Retrieve all playlists related to given episode.

GET /data/projects/{project_id}/episodes/{episode_id}/playlists

Jwt authorization

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

Responses

200

All playlists related to given episode

GET /data/projects/{project_id}/episodes/{episode_id}/playlists

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/episodes/a24a6ea4-ce75-4665-a070-57453082c25/playlists' \
 --header "Authorization: $API_KEY"

Retrieve all playlists related to given project.

GET /data/projects/{project_id}/playlists/{playlist_id}

Jwt authorization

Path parameters

project_id Required
playlist_id Required

Responses

200

All playlists related to given project

GET /data/projects/{project_id}/playlists/{playlist_id}

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/playlists/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all previews related to a given entity.

GET /data/playlists/entities/{entity_id}/preview-files

Jwt authorization

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

Responses

200

All previews related to given entity

GET /data/playlists/entities/{entity_id}/preview-files

curl \
 --request GET 'http://api.example.com/data/playlists/entities/a24a6ea4-ce75-4665-a070-57453082c25/preview-files' \
 --header "Authorization: $API_KEY"

Retrieve build job related to given playlist.

GET /data/playlists/{playlist_id}/jobs/{build_job_id}

Jwt authorization

Path parameters

playlist_id Required
build_job_id Required

Responses

200

Build job related to given playlist

GET /data/playlists/{playlist_id}/jobs/{build_job_id}

curl \
 --request GET 'http://api.example.com/data/playlists/a24a6ea4-ce75-4665-a070-57453082c25/jobs/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Remove given build job related to given playlist.

DELETE /data/playlists/{playlist_id}/jobs/{build_job_id}

Jwt authorization

Path parameters

playlist_id Required
build_job_id Required

Responses

204

Given build job removed

DELETE /data/playlists/{playlist_id}/jobs/{build_job_id}

curl \
 --request DELETE 'http://api.example.com/data/playlists/a24a6ea4-ce75-4665-a070-57453082c25/jobs/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all build jobs related to given project.

GET /data/projects/{project_id}/build-jobs

Jwt authorization

It's mainly used for synchronisation purpose.

Path parameters

project_id Required

Responses

200

All build jobs related to given project

GET /data/projects/{project_id}/build-jobs

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/build-jobs' \
 --header "Authorization: $API_KEY"

Build given playlist as mp4 movie.

GET /data/playlists/{playlist_id}/build/mp4

Jwt authorization

Path parameters

playlist_id Required

Responses

200

Given playlist built as mp4 movie

GET /data/playlists/{playlist_id}/build/mp4

curl \
 --request GET 'http://api.example.com/data/playlists/a24a6ea4-ce75-4665-a070-57453082c25/build/mp4' \
 --header "Authorization: $API_KEY"

Download given playlist build as .mp4.

GET /data/playlists/{playlist_id}/jobs/{build_job_id}/build/mp4

Jwt authorization

Path parameters

playlist_id Required
build_job_id Required

Responses

200

Given playlist build downloaded as .mp4
400

Build not finished, need to retry later

GET /data/playlists/{playlist_id}/jobs/{build_job_id}/build/mp4

curl \
 --request GET 'http://api.example.com/data/playlists/a24a6ea4-ce75-4665-a070-57453082c25/jobs/a24a6ea4-ce75-4665-a070-57453082c25/build/mp4' \
 --header "Authorization: $API_KEY"

Download given playlist as zip.

GET /data/playlists/{playlist_id}/download/zip

Jwt authorization

Path parameters

playlist_id Required

Responses

200

Given playlist downloaded as zip

GET /data/playlists/{playlist_id}/download/zip

curl \
 --request GET 'http://api.example.com/data/playlists/a24a6ea4-ce75-4665-a070-57453082c25/download/zip' \
 --header "Authorization: $API_KEY"

Retrieve all playlists related to given project.

POST /data/projects/{project_id}/playlists/temp

Jwt authorization

It's mainly used for synchronisation purpose.

Path parameters

project_id Required

Responses

200

All playlists related to given project

POST /data/projects/{project_id}/playlists/temp

curl \
 --request POST 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/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

Jwt authorization

Responses

200

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.

POST /pictures/preview-files/{instance_id}

Jwt authorization

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

Responses

200

Preview added

POST /pictures/preview-files/{instance_id}

curl \
 --request POST 'http://api.example.com/pictures/preview-files/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Download a movie preview.

GET /movies/originals/preview-files/{instance_id}.mp4

Jwt authorization

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

Responses

200

Movie preview downloaded
403

Instance not allowed
404

File not found

GET /movies/originals/preview-files/{instance_id}.mp4

curl \
 --request GET 'http://api.example.com/movies/originals/preview-files/a24a6ea4-ce75-4665-a070-57453082c25.mp4' \
 --header "Authorization: $API_KEY"

Download a movie preview.

GET /movies/originals/preview-files/{instance_id}/download

Jwt authorization

Path parameters

instance_id Required

Responses

200

Movie preview downloaded
403

Instance not allowed
404

File not found

GET /movies/originals/preview-files/{instance_id}/download

curl \
 --request GET 'http://api.example.com/movies/originals/preview-files/a24a6ea4-ce75-4665-a070-57453082c25/download' \
 --header "Authorization: $API_KEY"

Download a lowdef movie preview.

GET /movies/low/preview-files/{instance_id}.mp4

Jwt authorization

Path parameters

instance_id Required

Responses

200

Lowdef movie preview downloaded
403

Instance not allowed
404

File not found

GET /movies/low/preview-files/{instance_id}.mp4

curl \
 --request GET 'http://api.example.com/movies/low/preview-files/a24a6ea4-ce75-4665-a070-57453082c25.mp4' \
 --header "Authorization: $API_KEY"

Download a thumbnail.

GET /pictures/thumbnails/preview-files/{instance_id}.png

Jwt authorization

Path parameters

instance_id Required

Responses

200

Thumbnail downloaded
403

Instance not allowed
404

Picture file not found

GET /pictures/thumbnails/preview-files/{instance_id}.png

curl \
 --request GET 'http://api.example.com/pictures/thumbnails/preview-files/a24a6ea4-ce75-4665-a070-57453082c25.png' \
 --header "Authorization: $API_KEY"

Download the thumbnail representing given attachment file.

GET /pictures/thumbnails/attachment-files/{attachment_file_id}.png

Jwt authorization

Path parameters

attachment_file_id Required

Responses

200

Thumbnail downloaded
403

Instance not allowed
404

Picture file not found

GET /pictures/thumbnails/attachment-files/{attachment_file_id}.png

curl \
 --request GET 'http://api.example.com/pictures/thumbnails/attachment-files/a24a6ea4-ce75-4665-a070-57453082c25.png' \
 --header "Authorization: $API_KEY"

Download a thumbnail.

GET /pictures/thumbnails-square/preview-files/{instance_id}.png

Jwt authorization

Path parameters

instance_id Required

Responses

200

Thumbnail downloaded
403

Instance not allowed
404

Picture file not found

GET /pictures/thumbnails-square/preview-files/{instance_id}.png

curl \
 --request GET 'http://api.example.com/pictures/thumbnails-square/preview-files/a24a6ea4-ce75-4665-a070-57453082c25.png' \
 --header "Authorization: $API_KEY"

Download a thumbnail.

GET /pictures/originals/preview-files/{instance_id}.png

Jwt authorization

Path parameters

instance_id Required

Responses

200

Thumbnail downloaded
403

Instance not allowed
404

Picture file not found

GET /pictures/originals/preview-files/{instance_id}.png

curl \
 --request GET 'http://api.example.com/pictures/originals/preview-files/a24a6ea4-ce75-4665-a070-57453082c25.png' \
 --header "Authorization: $API_KEY"

Download a generic file preview.

GET /pictures/originals/preview-files/{instance_id}.{extension}

Jwt authorization

Path parameters

instance_id Required
extension Required

Responses

200

Generic file preview downloaded
403

Instance not allowed
404

Non-movie file not found

GET /pictures/originals/preview-files/{instance_id}.{extension}

curl \
 --request GET 'http://api.example.com/pictures/originals/preview-files/a24a6ea4-ce75-4665-a070-57453082c25.png, pdf, jpg, jpeg, ...' \
 --header "Authorization: $API_KEY"

Download a generic file preview as attachment.

GET /pictures/originals/preview-files/{instance_id}/download

Jwt authorization

Path parameters

instance_id Required

Responses

200

Generic file preview downloaded as attachment
403

Instance not allowed
404

Standard file not found

GET /pictures/originals/preview-files/{instance_id}/download

curl \
 --request GET 'http://api.example.com/pictures/originals/preview-files/a24a6ea4-ce75-4665-a070-57453082c25/download' \
 --header "Authorization: $API_KEY"

Download a thumbnail.

GET /pictures/previews/preview-files/{instance_id}.png

Jwt authorization

Path parameters

instance_id Required

Responses

200

Thumbnail downloaded
403

Instance not allowed
404

Picture file not found

GET /pictures/previews/preview-files/{instance_id}.png

curl \
 --request GET 'http://api.example.com/pictures/previews/preview-files/a24a6ea4-ce75-4665-a070-57453082c25.png' \
 --header "Authorization: $API_KEY"

Download a thumbnail.

GET /movies/tiles/preview-files/{instance_id}.png

Jwt authorization

Path parameters

instance_id Required

Responses

200

Thumbnail downloaded
403

Instance not allowed
404

Picture file not found

GET /movies/tiles/preview-files/{instance_id}.png

curl \
 --request GET 'http://api.example.com/movies/tiles/preview-files/a24a6ea4-ce75-4665-a070-57453082c25.png' \
 --header "Authorization: $API_KEY"

Download the thumbnail linked to given object instance.

GET /pictures/thumbnails/organisations/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Thumbnail downloaded
403

Access not allowed
404

Object instance not found

GET /pictures/thumbnails/organisations/{instance_id}

curl \
 --request GET 'http://api.example.com/pictures/thumbnails/organisations/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Create a thumbnail for given object instance.

POST /pictures/thumbnails/organisations/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Thumbnail created
404

Cannot found related object.

POST /pictures/thumbnails/organisations/{instance_id}

curl \
 --request POST 'http://api.example.com/pictures/thumbnails/organisations/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Download the thumbnail linked to given object instance.

GET /pictures/thumbnails/organisations/{instance_id}.png

Jwt authorization

Path parameters

instance_id Required

Responses

200

Thumbnail downloaded
403

Access not allowed
404

Object instance not found

GET /pictures/thumbnails/organisations/{instance_id}.png

curl \
 --request GET 'http://api.example.com/pictures/thumbnails/organisations/a24a6ea4-ce75-4665-a070-57453082c25.png' \
 --header "Authorization: $API_KEY"

Create a thumbnail for given object instance.

POST /pictures/thumbnails/organisations/{instance_id}.png

Jwt authorization

Path parameters

instance_id Required

Responses

200

Thumbnail created
404

Cannot found related object.

POST /pictures/thumbnails/organisations/{instance_id}.png

curl \
 --request POST 'http://api.example.com/pictures/thumbnails/organisations/a24a6ea4-ce75-4665-a070-57453082c25.png' \
 --header "Authorization: $API_KEY"

Download the thumbnail linked to given object instance.

GET /pictures/thumbnails/persons/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Thumbnail downloaded
403

Access not allowed
404

Object instance not found

GET /pictures/thumbnails/persons/{instance_id}

curl \
 --request GET 'http://api.example.com/pictures/thumbnails/persons/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Create a thumbnail for given object instance.

POST /pictures/thumbnails/persons/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Thumbnail created
404

Cannot found related object.

POST /pictures/thumbnails/persons/{instance_id}

curl \
 --request POST 'http://api.example.com/pictures/thumbnails/persons/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Download the thumbnail linked to given object instance.

GET /pictures/thumbnails/persons/{instance_id}.png

Jwt authorization

Path parameters

instance_id Required

Responses

200

Thumbnail downloaded
403

Access not allowed
404

Object instance not found

GET /pictures/thumbnails/persons/{instance_id}.png

curl \
 --request GET 'http://api.example.com/pictures/thumbnails/persons/a24a6ea4-ce75-4665-a070-57453082c25.png' \
 --header "Authorization: $API_KEY"

Create a thumbnail for given object instance.

POST /pictures/thumbnails/persons/{instance_id}.png

Jwt authorization

Path parameters

instance_id Required

Responses

200

Thumbnail created
404

Cannot found related object.

POST /pictures/thumbnails/persons/{instance_id}.png

curl \
 --request POST 'http://api.example.com/pictures/thumbnails/persons/a24a6ea4-ce75-4665-a070-57453082c25.png' \
 --header "Authorization: $API_KEY"

Download the thumbnail linked to given object instance.

GET /pictures/thumbnails/projects/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Thumbnail downloaded
403

Access not allowed
404

Object instance not found

GET /pictures/thumbnails/projects/{instance_id}

curl \
 --request GET 'http://api.example.com/pictures/thumbnails/projects/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Create a thumbnail for given object instance.

POST /pictures/thumbnails/projects/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Thumbnail created
404

Cannot found related object.

POST /pictures/thumbnails/projects/{instance_id}

curl \
 --request POST 'http://api.example.com/pictures/thumbnails/projects/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Download the thumbnail linked to given object instance.

GET /pictures/thumbnails/projects/{instance_id}.png

Jwt authorization

Path parameters

instance_id Required

Responses

200

Thumbnail downloaded
403

Access not allowed
404

Object instance not found

GET /pictures/thumbnails/projects/{instance_id}.png

curl \
 --request GET 'http://api.example.com/pictures/thumbnails/projects/a24a6ea4-ce75-4665-a070-57453082c25.png' \
 --header "Authorization: $API_KEY"

Create a thumbnail for given object instance.

POST /pictures/thumbnails/projects/{instance_id}.png

Jwt authorization

Path parameters

instance_id Required

Responses

200

Thumbnail created
404

Cannot found related object.

POST /pictures/thumbnails/projects/{instance_id}.png

curl \
 --request POST 'http://api.example.com/pictures/thumbnails/projects/a24a6ea4-ce75-4665-a070-57453082c25.png' \
 --header "Authorization: $API_KEY"

Main resource to add a preview background file.

POST /pictures/preview-background-files/{instance_id}

Jwt authorization

Path parameters

instance_id Required

Responses

200

Preview background file added

POST /pictures/preview-background-files/{instance_id}

curl \
 --request POST 'http://api.example.com/pictures/preview-background-files/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Download the thumbnail linked to given object instance.

GET /pictures/thumbnails/preview-background-files/{instance_id}.png

Jwt authorization

Path parameters

instance_id Required

Responses

200

Thumbnail downloaded
403

Access not allowed
404

Object instance not found

GET /pictures/thumbnails/preview-background-files/{instance_id}.png

curl \
 --request GET 'http://api.example.com/pictures/thumbnails/preview-background-files/a24a6ea4-ce75-4665-a070-57453082c25.png' \
 --header "Authorization: $API_KEY"

Create a thumbnail for given object instance.

POST /pictures/thumbnails/preview-background-files/{instance_id}.png

Jwt authorization

Path parameters

instance_id Required

Responses

200

Thumbnail created
404

Cannot found related object.

POST /pictures/thumbnails/preview-background-files/{instance_id}.png

curl \
 --request POST 'http://api.example.com/pictures/thumbnails/preview-background-files/a24a6ea4-ce75-4665-a070-57453082c25.png' \
 --header "Authorization: $API_KEY"

Download a preview background file.

GET /pictures/preview-background-files/{instance_id}.{extension}

Jwt authorization

Path parameters

instance_id Required
extension Required

Responses

200

Preview background file downloaded
404

Preview background file not found

GET /pictures/preview-background-files/{instance_id}.{extension}

curl \
 --request GET 'http://api.example.com/pictures/preview-background-files/a24a6ea4-ce75-4665-a070-57453082c25.hdr' \
 --header "Authorization: $API_KEY"

Set given preview as main preview of the related entity.

PUT /actions/preview-files/{preview_file_id}/set-main-preview

Jwt authorization

This preview will be used to illustrate the entity.

Path parameters

preview_file_id Required

Responses

200

Given preview set as main preview

PUT /actions/preview-files/{preview_file_id}/set-main-preview

curl \
 --request PUT 'http://api.example.com/actions/preview-files/a24a6ea4-ce75-4665-a070-57453082c25/set-main-preview' \
 --header "Authorization: $API_KEY"

Extract a frame from a preview_file

GET /actions/preview-files/{preview_file_id}/extract-frame

Jwt authorization

Path parameters

preview_file_id Required

Responses

200

Extracted frame

GET /actions/preview-files/{preview_file_id}/extract-frame

curl \
 --request GET 'http://api.example.com/actions/preview-files/a24a6ea4-ce75-4665-a070-57453082c25/extract-frame' \
 --header "Authorization: $API_KEY"

Allow to change orders of previews for a single revision.

PUT /actions/preview-files/{preview_file_id}/update-position

Jwt authorization

This preview will be used to illustrate the entity.

Path parameters

preview_file_id Required

Responses

200

Orders of previews changed for a single revision

PUT /actions/preview-files/{preview_file_id}/update-position

curl \
 --request PUT 'http://api.example.com/actions/preview-files/a24a6ea4-ce75-4665-a070-57453082c25/update-position' \
 --header "Authorization: $API_KEY"

Allow to modify the annotations stored at the preview level.

PUT /actions/preview-files/{preview_file_id}/update-annotations

Jwt authorization

Modifications are applied via three fields:

annotations to give all the annotations that need to be added.
updates that list annotations that needs to be modified.
deletions to list the IDs of annotations that needs to be removed.

Path parameters

preview_file_id Required

Responses

200

Orders of previews changed for a single revision

PUT /actions/preview-files/{preview_file_id}/update-annotations

curl \
 --request PUT 'http://api.example.com/actions/preview-files/a24a6ea4-ce75-4665-a070-57453082c25/update-annotations' \
 --header "Authorization: $API_KEY"

Return the list of projects currently running.

GET /data/projects/open

Jwt authorization

Most of the time, past projects are not needed.

Responses

200

All running projects

GET /data/projects/open

curl \
 --request GET 'http://api.example.com/data/projects/open' \
 --header "Authorization: $API_KEY"

Return all projects listed in database.

GET /data/projects/all

Jwt authorization

Ensure that user has at least the manager level before that.

Responses

200

All projects listed in database

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.

GET /data/projects/{project_id}/team

Jwt authorization

Path parameters

project_id Required

Responses

200

People listed in a production team

GET /data/projects/{project_id}/team

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/team' \
 --header "Authorization: $API_KEY"

Add a person to a production team.

POST /data/projects/{project_id}/team

Jwt authorization

Path parameters

project_id Required

Responses

201

Person added to the production team

POST /data/projects/{project_id}/team

curl \
 --request POST 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/team' \
 --header "Authorization: $API_KEY"

Retrieve task types linked to the production

GET /data/projects/{project_id}/task-types

Jwt authorization

Path parameters

project_id Required

Responses

200

Task types linked to the production

GET /data/projects/{project_id}/task-types

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/task-types' \
 --header "Authorization: $API_KEY"

Remove people listed in a production team.

DELETE /data/projects/{project_id}/team/{person_id}

Jwt authorization

Path parameters

project_id Required
person_id Required

Responses

204

Empty response

DELETE /data/projects/{project_id}/team/{person_id}

curl \
 --request DELETE 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/team/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Add an asset type linked to a production.

POST /data/projects/{project_id}/settings/asset-types

Jwt authorization

Path parameters

project_id Required

Responses

201

Asset type added to production

POST /data/projects/{project_id}/settings/asset-types

curl \
 --request POST 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/settings/asset-types' \
 --header "Authorization: $API_KEY"

Remove an asset type from a production.

DELETE /data/projects/{project_id}/settings/asset-types/{asset_type_id}

Jwt authorization

Path parameters

project_id Required
asset_type_id Required

Responses

204

Empty response

DELETE /data/projects/{project_id}/settings/asset-types/{asset_type_id}

curl \
 --request DELETE 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/settings/asset-types/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Add a task type linked to a production.

POST /data/projects/{project_id}/settings/task-types

Jwt authorization

Path parameters

project_id Required

Responses

201

Asset type added to production

POST /data/projects/{project_id}/settings/task-types

curl \
 --request POST 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/settings/task-types' \
 --header "Authorization: $API_KEY"

Remove a task type from a production.

DELETE /data/projects/{project_id}/settings/task-types/{task_type_id}

Jwt authorization

Path parameters

project_id Required
task_type_id Required

Responses

204

Empty response

DELETE /data/projects/{project_id}/settings/task-types/{task_type_id}

curl \
 --request DELETE 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/settings/task-types/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Return task statuses linked to a production

GET /data/projects/{project_id}/settings/task-status

Jwt authorization

Path parameters

project_id Required

Responses

200

Task statuses linked to production

GET /data/projects/{project_id}/settings/task-status

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/settings/task-status' \
 --header "Authorization: $API_KEY"

Add a task type linked to a production.

POST /data/projects/{project_id}/settings/task-status

Jwt authorization

Path parameters

project_id Required

Responses

201

Task type added to production

POST /data/projects/{project_id}/settings/task-status

curl \
 --request POST 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/settings/task-status' \
 --header "Authorization: $API_KEY"

Remove a task status from a production.

DELETE /data/projects/{project_id}/settings/task-status/{task_status_id}

Jwt authorization

Path parameters

project_id Required
task_status_id Required

Responses

204

Empty response

DELETE /data/projects/{project_id}/settings/task-status/{task_status_id}

curl \
 --request DELETE 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/settings/task-status/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Get a status automation linked to a production.

GET /data/projects/{project_id}/settings/status-automations

Jwt authorization

Path parameters

project_id Required

Responses

200

Status automation linked to production

GET /data/projects/{project_id}/settings/status-automations

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/settings/status-automations' \
 --header "Authorization: $API_KEY"

Add a status automation linked to a production.

POST /data/projects/{project_id}/settings/status-automations

Jwt authorization

Path parameters

project_id Required

Responses

201

Status automation added to production

POST /data/projects/{project_id}/settings/status-automations

curl \
 --request POST 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/settings/status-automations' \
 --header "Authorization: $API_KEY"

Remove a status automation from a production.

DELETE /data/projects/{project_id}/settings/status-automations/{status_automation_id}

Jwt authorization

Path parameters

project_id Required
status_automation_id Required

Responses

204

Empty response

DELETE /data/projects/{project_id}/settings/status-automations/{status_automation_id}

curl \
 --request DELETE 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/settings/status-automations/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Remove a preview background file from a production.

DELETE /data/projects/{project_id}/settings/preview-background-files/{preview_background_file_id}

Jwt authorization

Path parameters

project_id Required
preview_background_file_id Required

Responses

204

Empty response

DELETE /data/projects/{project_id}/settings/preview-background-files/{preview_background_file_id}

curl \
 --request DELETE 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/settings/preview-background-files/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Return preview background files linked to a production

GET /data/projects/{project_id}/settings/preview-background-files

Jwt authorization

Path parameters

project_id Required

Responses

200

Preview background files linked to production

GET /data/projects/{project_id}/settings/preview-background-files

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/settings/preview-background-files' \
 --header "Authorization: $API_KEY"

Add a preview background file linked to a production.

POST /data/projects/{project_id}/settings/preview-background-files

Jwt authorization

Path parameters

project_id Required

Responses

201

Preview background file added to production

POST /data/projects/{project_id}/settings/preview-background-files

curl \
 --request POST 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/settings/preview-background-files' \
 --header "Authorization: $API_KEY"

Get all metadata descriptors

GET /data/projects/{project_id}/metadata-descriptors

Jwt authorization

It serves to describe extra fields listed in the data attribute of entities.

Path parameters

project_id Required

Responses

200

All metadata descriptors

GET /data/projects/{project_id}/metadata-descriptors

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/metadata-descriptors' \
 --header "Authorization: $API_KEY"

Create a new metadata descriptor

POST /data/projects/{project_id}/metadata-descriptors

Jwt authorization

It serves to describe extra fields listed in the data attribute of entities.

Path parameters

project_id Required

Responses

201

Create a new metadata descriptor

POST /data/projects/{project_id}/metadata-descriptors

curl \
 --request POST 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/metadata-descriptors' \
 --header "Authorization: $API_KEY"

Get a metadata descriptor.

GET /data/projects/{project_id}/metadata-descriptors/{descriptor_id}

Jwt authorization

Descriptors serve to describe extra fields listed in the data attribute of entities.

Path parameters

project_id Required
descriptor_id Required

Responses

200

Metadata descriptor

GET /data/projects/{project_id}/metadata-descriptors/{descriptor_id}

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/metadata-descriptors/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a metadata descriptor.

PUT /data/projects/{project_id}/metadata-descriptors/{descriptor_id}

Jwt authorization

Descriptors serve to describe extra fields listed in the data attribute of entities.

Path parameters

project_id Required
descriptor_id Required

Responses

200

Metadata descriptor updated

PUT /data/projects/{project_id}/metadata-descriptors/{descriptor_id}

curl \
 --request PUT 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/metadata-descriptors/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a metadata descriptor.

DELETE /data/projects/{project_id}/metadata-descriptors/{descriptor_id}

Jwt authorization

Descriptors serve to describe extra fields listed in the data attribute of entities.

Path parameters

project_id Required
descriptor_id Required

Responses

204

Empty response

DELETE /data/projects/{project_id}/metadata-descriptors/{descriptor_id}

curl \
 --request DELETE 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/metadata-descriptors/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve milestones for given production

GET /data/projects/{project_id}/milestones

Jwt authorization

Path parameters

project_id Required

Responses

200

All milestones of given production

GET /data/projects/{project_id}/milestones

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/milestones' \
 --header "Authorization: $API_KEY"

Retrieve schedule items for given production

GET /data/projects/{project_id}/schedule-items

Jwt authorization

Path parameters

project_id Required

Responses

200

All schedule items of given production

GET /data/projects/{project_id}/schedule-items

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/schedule-items' \
 --header "Authorization: $API_KEY"

Retrieve task type schedule items for given production

GET /data/projects/{project_id}/schedule-items/task-types

Jwt authorization

Path parameters

project_id Required

Responses

200

All task types schedule items of given production

GET /data/projects/{project_id}/schedule-items/task-types

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/schedule-items/task-types' \
 --header "Authorization: $API_KEY"

Retrieve asset types schedule items for given task type

GET /data/projects/{project_id}/schedule-items/{task_type_id}/asset-types

Jwt authorization

Path parameters

project_id Required
task_type_id Required

Responses

200

All asset types schedule items for given task type

GET /data/projects/{project_id}/schedule-items/{task_type_id}/asset-types

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/schedule-items/a24a6ea4-ce75-4665-a070-57453082c25/asset-types' \
 --header "Authorization: $API_KEY"

Retrieve episodes schedule items for given task type

GET /data/projects/{project_id}/schedule-items/{task_type_id}/episodes

Jwt authorization

Path parameters

project_id Required
task_type_id Required

Responses

200

All episodes schedule items for given task type

GET /data/projects/{project_id}/schedule-items/{task_type_id}/episodes

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/schedule-items/a24a6ea4-ce75-4665-a070-57453082c25/episodes' \
 --header "Authorization: $API_KEY"

Retrieve sequences schedule items for given task type

GET /data/projects/{project_id}/schedule-items/{task_type_id}/sequences

Jwt authorization

Path parameters

project_id Required
task_type_id Required

Responses

200

All sequences schedule items for given task type

GET /data/projects/{project_id}/schedule-items/{task_type_id}/sequences

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/schedule-items/a24a6ea4-ce75-4665-a070-57453082c25/sequences' \
 --header "Authorization: $API_KEY"

Retrieve time spents for given production

GET /data/projects/{project_id}/time-spents

Jwt authorization

Path parameters

project_id Required

Responses

200

All time spents of given production

GET /data/projects/{project_id}/time-spents

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/time-spents' \
 --header "Authorization: $API_KEY"

Retrieve budgets for given production

GET /data/projects/{project_id}/budgets

Jwt authorization

Path parameters

project_id Required

Responses

200

All budgets of given production

GET /data/projects/{project_id}/budgets

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/budgets' \
 --header "Authorization: $API_KEY"

Create a budget for given production.

POST /data/projects/{project_id}/budgets

Jwt authorization

Path parameters

project_id Required

Responses

201

Budget created

POST /data/projects/{project_id}/budgets

curl \
 --request POST 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/budgets' \
 --header "Authorization: $API_KEY"

Retrieve a budget for given production

GET /data/projects/{project_id}/budgets/{budget_id}

Jwt authorization

Path parameters

project_id Required
budget_id Required

Responses

200

Budget retrieved

GET /data/projects/{project_id}/budgets/{budget_id}

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/budgets/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a budget name for given production

PUT /data/projects/{project_id}/budgets/{budget_id}

Jwt authorization

Path parameters

project_id Required
budget_id Required

Responses

200

Budget updated

PUT /data/projects/{project_id}/budgets/{budget_id}

curl \
 --request PUT 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/budgets/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a budget for given production

DELETE /data/projects/{project_id}/budgets/{budget_id}

Jwt authorization

Path parameters

project_id Required
budget_id Required

Responses

204

Empty response

DELETE /data/projects/{project_id}/budgets/{budget_id}

curl \
 --request DELETE 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/budgets/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve budget entries for given production

GET /data/projects/{project_id}/budgets/{budget_id}/entries

Jwt authorization

Path parameters

project_id Required
budget_id Required

Responses

200

All budget entries of given production and budget

GET /data/projects/{project_id}/budgets/{budget_id}/entries

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/budgets/a24a6ea4-ce75-4665-a070-57453082c25/entries' \
 --header "Authorization: $API_KEY"

Retrieve a budget entry for given production and budget

GET /data/projects/{project_id}/budgets/{budget_id}/entries/{entry_id}

Jwt authorization

Path parameters

project_id Required
budget_id Required
entry_id Required

Responses

200

Budget entry retrieved

GET /data/projects/{project_id}/budgets/{budget_id}/entries/{entry_id}

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/budgets/a24a6ea4-ce75-4665-a070-57453082c25/entries/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a budget entry for given production and budget

PUT /data/projects/{project_id}/budgets/{budget_id}/entries/{entry_id}

Jwt authorization

Path parameters

project_id Required
budget_id Required
entry_id Required

Responses

200

Budget entry updated

PUT /data/projects/{project_id}/budgets/{budget_id}/entries/{entry_id}

curl \
 --request PUT 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/budgets/a24a6ea4-ce75-4665-a070-57453082c25/entries/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete a budget entry for given production and budget.

DELETE /data/projects/{project_id}/budgets/{budget_id}/entries/{entry_id}

Jwt authorization

Path parameters

project_id Required
budget_id Required
entry_id Required

Responses

204

empty response

DELETE /data/projects/{project_id}/budgets/{budget_id}/entries/{entry_id}

curl \
 --request DELETE 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/budgets/a24a6ea4-ce75-4665-a070-57453082c25/entries/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Get aggregated time spents by month for given project.

GET /data/projects/{project_id}/budgets/time-spents

Jwt authorization

Path parameters

project_id Required

Responses

200

Aggregated time spents for given person and month
400

Wrong ID format

GET /data/projects/{project_id}/budgets/time-spents

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/budgets/time-spents' \
 --header "Authorization: $API_KEY"

Get task links for given production schedule version.

GET /data/production-schedule-versions/{production_schedule_version_id}/task-links

Jwt authorization

Path parameters

production_schedule_version_id Required

Query parameters

task_type_id

Responses

200

Task links for given production schedule version.
400

Wrong ID format

GET /data/production-schedule-versions/{production_schedule_version_id}/task-links

curl \
 --request GET 'http://api.example.com/data/production-schedule-versions/a24a6ea4-ce75-4665-a070-57453082c25/task-links' \
 --header "Authorization: $API_KEY"

Set task links for given production schedule version from tasks.

POST /actions/production-schedule-versions/{production_schedule_version_id}/set-task-links-from-production

Jwt authorization

Path parameters

production_schedule_version_id Required

Responses

200

Task links created.
400

Wrong ID format

POST /actions/production-schedule-versions/{production_schedule_version_id}/set-task-links-from-production

curl \
 --request POST 'http://api.example.com/actions/production-schedule-versions/a24a6ea4-ce75-4665-a070-57453082c25/set-task-links-from-production' \
 --header "Authorization: $API_KEY"

Set task links for given production schedule version from another production schedule version.

POST /actions/production-schedule-versions/{production_schedule_version_id}/set-task-links-from-production-schedule-version

Jwt authorization

Path parameters

production_schedule_version_id Required

Responses

200

Task links created.
400

Wrong ID format

POST /actions/production-schedule-versions/{production_schedule_version_id}/set-task-links-from-production-schedule-version

curl \
 --request POST 'http://api.example.com/actions/production-schedule-versions/a24a6ea4-ce75-4665-a070-57453082c25/set-task-links-from-production-schedule-version' \
 --header "Authorization: $API_KEY"

Apply production schedule version to production.

POST /actions/production-schedule-versions/{production_schedule_version_id}/apply-to-production

Jwt authorization

Path parameters

production_schedule_version_id Required

Responses

200

Task links created.
400

Wrong ID format

POST /actions/production-schedule-versions/{production_schedule_version_id}/apply-to-production

curl \
 --request POST 'http://api.example.com/actions/production-schedule-versions/a24a6ea4-ce75-4665-a070-57453082c25/apply-to-production' \
 --header "Authorization: $API_KEY"

Search for resource

POST /data/search

Jwt authorization

application/json

Body Required

query string Required

Search query string (minimum 3 characters)
project_id string(uuid)

Filter search results by project ID
limit integer

Maximum number of results per index

Default value is 3.
offset integer

Number of results to skip

Default value is 0.
index_names array[string]

List of index names to search in

Values are assets, shots, or persons. Default value is ["assets", "shots", "persons"].

Responses

200 application/json

List of entities that contain the query
Hide response attributes Show response attributes object
- persons array[object]
  
  List of matching persons
- assets array[object]
  
  List of matching assets
- shots array[object]
  
  List of matching shots
400

Bad request
403

Insufficient permissions

POST /data/search

curl \
 --request POST 'http://api.example.com/data/search' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"query":"test will search for test","project_id":"a24a6ea4-ce75-4665-a070-57453082c25","limit":3,"offset":0,"index_names":["assets"]}'

Request examples

{
  "query": "test will search for test",
  "project_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "limit": 3,
  "offset": 0,
  "index_names": [
    "assets"
  ]
}

Response examples (200)

{
  "persons": [
    {}
  ],
  "assets": [
    {}
  ],
  "shots": [
    {}
  ]
}

Retrieve all shot entries.

GET /data/shots

Jwt authorization

Filters can be specified in the query string.

Query parameters

sequence_id
project_id
parent_id

Responses

200

All shot entries

GET /data/shots

curl \
 --request GET 'http://api.example.com/data/shots' \
 --header "Authorization: $API_KEY"

Retrieve all shot entries.

GET /data/shots/all

Jwt authorization

Filters can be specified in the query string.

Query parameters

sequence_id
project_id
parent_id

Responses

200

All shot entries

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

Jwt authorization

Query parameters

project_id

Responses

200

All shots

GET /data/shots/with-tasks

curl \
 --request GET 'http://api.example.com/data/shots/with-tasks' \
 --header "Authorization: $API_KEY"

Retrieve given shot.

GET /data/shots/{shot_id}

Jwt authorization

Path parameters

shot_id Required

Responses

200

Given shot

GET /data/shots/{shot_id}

curl \
 --request GET 'http://api.example.com/data/shots/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update given shot.

PUT /data/shots/{shot_id}

Jwt authorization

Path parameters

shot_id Required

application/json

Body Required

object

Shot data to update

Responses

200

Update given shot

PUT /data/shots/{shot_id}

curl \
 --request PUT 'http://api.example.com/data/shots/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json"

Request examples

{}

Delete given shot.

DELETE /data/shots/{shot_id}

Jwt authorization

Path parameters

shot_id Required

Responses

204

Given shot deleted

DELETE /data/shots/{shot_id}

curl \
 --request DELETE 'http://api.example.com/data/shots/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all assets for a given shot.

GET /data/shots/{shot_id}/assets

Jwt authorization

Path parameters

shot_id Required

Responses

200

All assets for given shot

GET /data/shots/{shot_id}/assets

curl \
 --request GET 'http://api.example.com/data/shots/a24a6ea4-ce75-4665-a070-57453082c25/assets' \
 --header "Authorization: $API_KEY"

Retrieve all task types related to a given shot.

GET /data/shots/{shot_id}/task-types

Jwt authorization

Path parameters

shot_id Required

Responses

200

All task types related to given shot

GET /data/shots/{shot_id}/task-types

curl \
 --request GET 'http://api.example.com/data/shots/a24a6ea4-ce75-4665-a070-57453082c25/task-types' \
 --header "Authorization: $API_KEY"

Retrieve all tasks related to a given shot.

GET /data/shots/{shot_id}/tasks

Jwt authorization

Path parameters

shot_id Required

Responses

200

All tasks related to given shot

GET /data/shots/{shot_id}/tasks

curl \
 --request GET 'http://api.example.com/data/shots/a24a6ea4-ce75-4665-a070-57453082c25/tasks' \
 --header "Authorization: $API_KEY"

Retrieve all previews related to a given shot.

GET /data/shots/{shot_id}/preview-files

Jwt authorization

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

Responses

200

All previews related to given episode

GET /data/shots/{shot_id}/preview-files

curl \
 --request GET 'http://api.example.com/data/shots/a24a6ea4-ce75-4665-a070-57453082c25/preview-files' \
 --header "Authorization: $API_KEY"

Retrieve data versions of given shot.

GET /data/shots/{shot_id}/versions

Jwt authorization

Path parameters

shot_id Required

Responses

204

Data versions of given shot

GET /data/shots/{shot_id}/versions

curl \
 --request GET 'http://api.example.com/data/shots/a24a6ea4-ce75-4665-a070-57453082c25/versions' \
 --header "Authorization: $API_KEY"

Retrieve all scene entries.

GET /data/scenes/all

Jwt authorization

Filters can be specified in the query string.

Query parameters

project_id

Responses

200

All scene entries

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

Jwt authorization

Query parameters

project_id

Responses

200

All scenes

GET /data/scenes/with-tasks

curl \
 --request GET 'http://api.example.com/data/scenes/with-tasks' \
 --header "Authorization: $API_KEY"

Retrieve given scene.

GET /data/scenes/{scene_id}

Jwt authorization

Path parameters

scene_id Required

Responses

200

Given scene

GET /data/scenes/{scene_id}

curl \
 --request GET 'http://api.example.com/data/scenes/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete given scene.

DELETE /data/scenes/{scene_id}

Jwt authorization

Path parameters

scene_id Required

Responses

204

Given scene deleted

DELETE /data/scenes/{scene_id}

curl \
 --request DELETE 'http://api.example.com/data/scenes/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all tasks related to a given scene.

GET /data/scenes/{scene_id}/tasks

Jwt authorization

Path parameters

scene_id Required

Responses

200

All tasks related to given scene

GET /data/scenes/{scene_id}/tasks

curl \
 --request GET 'http://api.example.com/data/scenes/a24a6ea4-ce75-4665-a070-57453082c25/tasks' \
 --header "Authorization: $API_KEY"

Retrieve all task types related to a given scene.

GET /data/scenes/{scene_id}/task-types

Jwt authorization

Path parameters

scene_id Required

Responses

200

All task types related to given scene

GET /data/scenes/{scene_id}/task-types

curl \
 --request GET 'http://api.example.com/data/scenes/a24a6ea4-ce75-4665-a070-57453082c25/task-types' \
 --header "Authorization: $API_KEY"

Retrieve all shots that come from given scene.

GET /data/scenes/{scene_id}/shots

Jwt authorization

Path parameters

scene_id Required

Responses

200

All shots that come from given scene

GET /data/scenes/{scene_id}/shots

curl \
 --request GET 'http://api.example.com/data/scenes/a24a6ea4-ce75-4665-a070-57453082c25/shots' \
 --header "Authorization: $API_KEY"

Mark given scene as source of given shot.

POST /data/scenes/{scene_id}/shots

Jwt authorization

Path parameters

scene_id Required

application/json

Body Required

shot_id string(uuid) Required

Responses

200

Given scene marked as source of given shot

POST /data/scenes/{scene_id}/shots

curl \
 --request POST 'http://api.example.com/data/scenes/a24a6ea4-ce75-4665-a070-57453082c25/shots' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"shot_id":"a24a6ea4-ce75-4665-a070-57453082c25"}'

Request examples

{
  "shot_id": "a24a6ea4-ce75-4665-a070-57453082c25"
}

Delete given shot from given scene.

DELETE /data/scenes/{scene_id}/shots/{shot_id}

Jwt authorization

Path parameters

scene_id Required
shot_id Required

Responses

204

Given shot deleted from given scene

DELETE /data/scenes/{scene_id}/shots/{shot_id}

curl \
 --request DELETE 'http://api.example.com/data/scenes/a24a6ea4-ce75-4665-a070-57453082c25/shots/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all episode entries.

GET /data/episodes

Jwt authorization

Filters can be specified in the query string.

Query parameters

project_id

Responses

200

All episode entries

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

Jwt authorization

Query parameters

project_id

Responses

200

All episodes

GET /data/episodes/with-tasks

curl \
 --request GET 'http://api.example.com/data/episodes/with-tasks' \
 --header "Authorization: $API_KEY"

Retrieve given episode.

GET /data/episodes/{episode_id}

Jwt authorization

Path parameters

episode_id Required

Responses

200

Given episode

GET /data/episodes/{episode_id}

curl \
 --request GET 'http://api.example.com/data/episodes/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete given episode.

DELETE /data/episodes/{episode_id}

Jwt authorization

Path parameters

episode_id Required

Responses

204

Given episode deleted

DELETE /data/episodes/{episode_id}

curl \
 --request DELETE 'http://api.example.com/data/episodes/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all shots related to a given episode.

GET /data/episodes/{episode_id}/shots

Jwt authorization

Path parameters

episode_id Required

Responses

200

All shots related to given episode

GET /data/episodes/{episode_id}/shots

curl \
 --request GET 'http://api.example.com/data/episodes/a24a6ea4-ce75-4665-a070-57453082c25/shots' \
 --header "Authorization: $API_KEY"

Retrieve all sequence entries for a given episode.

GET /data/episodes/{episode_id}/sequences

Jwt authorization

Filters can be specified in the query string.

Path parameters

episode_id Required

Query parameters

project_id

Responses

200

All sequence entries for given episode

GET /data/episodes/{episode_id}/sequences

curl \
 --request GET 'http://api.example.com/data/episodes/a24a6ea4-ce75-4665-a070-57453082c25/sequences' \
 --header "Authorization: $API_KEY"

Retrieve all tasks related to a given episode.

GET /data/episodes/{episode_id}/tasks

Jwt authorization

Path parameters

episode_id Required

Responses

200

All tasks related to given episode

GET /data/episodes/{episode_id}/tasks

curl \
 --request GET 'http://api.example.com/data/episodes/a24a6ea4-ce75-4665-a070-57453082c25/tasks' \
 --header "Authorization: $API_KEY"

Retrieve all task types related to a given episode.

GET /data/episodes/{episode_id}/task-types

Jwt authorization

Path parameters

episode_id Required

Responses

200

All task types related to given episode

GET /data/episodes/{episode_id}/task-types

curl \
 --request GET 'http://api.example.com/data/episodes/a24a6ea4-ce75-4665-a070-57453082c25/task-types' \
 --header "Authorization: $API_KEY"

Retrieve all shots tasks related to a given episode.

GET /data/episodes/{episode_id}/shot-tasks

Jwt authorization

Path parameters

episode_id Required

Responses

200

All shots tasks related to given episode

GET /data/episodes/{episode_id}/shot-tasks

curl \
 --request GET 'http://api.example.com/data/episodes/a24a6ea4-ce75-4665-a070-57453082c25/shot-tasks' \
 --header "Authorization: $API_KEY"

Retrieve all assets tasks related to a given episode.

GET /data/episodes/{episode_id}/asset-tasks

Jwt authorization

Path parameters

episode_id Required

Responses

200

All assets tasks related to given episode

GET /data/episodes/{episode_id}/asset-tasks

curl \
 --request GET 'http://api.example.com/data/episodes/a24a6ea4-ce75-4665-a070-57453082c25/asset-tasks' \
 --header "Authorization: $API_KEY"

Retrieve all sequence entries.

GET /data/sequences

Jwt authorization

Filters can be specified in the query string.

Query parameters

episode_id

Responses

200

All sequence entries

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

Jwt authorization

Query parameters

project_id

Responses

200

All sequences

GET /data/sequences/with-tasks

curl \
 --request GET 'http://api.example.com/data/sequences/with-tasks' \
 --header "Authorization: $API_KEY"

Retrieve given sequence.

GET /data/sequences/{sequence_id}

Jwt authorization

Path parameters

sequence_id Required

Responses

200

Given sequence

GET /data/sequences/{sequence_id}

curl \
 --request GET 'http://api.example.com/data/sequences/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete given sequence.

DELETE /data/sequences/{sequence_id}

Jwt authorization

Path parameters

sequence_id Required

Responses

204

Given sequence deleted

DELETE /data/sequences/{sequence_id}

curl \
 --request DELETE 'http://api.example.com/data/sequences/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve all shot entries for a given sequence.

GET /data/sequences/{sequence_id}/shots

Jwt authorization

Filters can be specified in the query string.

Path parameters

sequence_id Required

Query parameters

project_id

Responses

200

All shot entries for given sequence

GET /data/sequences/{sequence_id}/shots

curl \
 --request GET 'http://api.example.com/data/sequences/a24a6ea4-ce75-4665-a070-57453082c25/shots' \
 --header "Authorization: $API_KEY"

Retrieve all scenes related to a given sequence.

GET /data/sequences/{sequence_id}/scenes

Jwt authorization

Path parameters

sequence_id Required

Responses

200

All scenes related to given sequence

GET /data/sequences/{sequence_id}/scenes

curl \
 --request GET 'http://api.example.com/data/sequences/a24a6ea4-ce75-4665-a070-57453082c25/scenes' \
 --header "Authorization: $API_KEY"

Retrieve all tasks related to a given shot.

GET /data/sequences/{sequence_id}/tasks

Jwt authorization

Path parameters

sequence_id Required

Responses

200

All tasks related to given shot

GET /data/sequences/{sequence_id}/tasks

curl \
 --request GET 'http://api.example.com/data/sequences/a24a6ea4-ce75-4665-a070-57453082c25/tasks' \
 --header "Authorization: $API_KEY"

Retrieve all task types related to a given shot.

GET /data/sequences/{sequence_id}/task-types

Jwt authorization

Path parameters

sequence_id Required

Responses

200

All task types related to given shot

GET /data/sequences/{sequence_id}/task-types

curl \
 --request GET 'http://api.example.com/data/sequences/a24a6ea4-ce75-4665-a070-57453082c25/task-types' \
 --header "Authorization: $API_KEY"

Retrieve all tasks related to a given sequence.

GET /data/sequences/{sequence_id}/shot-tasks

Jwt authorization

Path parameters

sequence_id Required

Responses

200

All task types related to given sequence

GET /data/sequences/{sequence_id}/shot-tasks

curl \
 --request GET 'http://api.example.com/data/sequences/a24a6ea4-ce75-4665-a070-57453082c25/shot-tasks' \
 --header "Authorization: $API_KEY"

Retrieve all shots related to a given project.

GET /data/projects/{project_id}/shots

Jwt authorization

Path parameters

project_id Required

Responses

200

All shots related to given project

GET /data/projects/{project_id}/shots

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/shots' \
 --header "Authorization: $API_KEY"

Create a shot for given project.

POST /data/projects/{project_id}/shots

Jwt authorization

Path parameters

project_id Required

application/json

Body Required

name string Required
description string
sequence_id string(uuid)
nb_frames integer

Responses

201

Shot created for given project

POST /data/projects/{project_id}/shots

curl \
 --request POST 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/shots' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"name":"Name of shot","description":"Description of shot","sequence_id":"a24a6ea4-ce75-4665-a070-57453082c25","nb_frames":24}'

Request examples

{
  "name": "Name of shot",
  "description": "Description of shot",
  "sequence_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "nb_frames": 24
}

Retrieve all scenes related to a given project.

GET /data/projects/{project_id}/scenes

Jwt authorization

Path parameters

project_id Required

Responses

200

All scenes related to given project

GET /data/projects/{project_id}/scenes

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/scenes' \
 --header "Authorization: $API_KEY"

Create a scene for given project.

POST /data/projects/{project_id}/scenes

Jwt authorization

Path parameters

project_id Required

application/json

Body Required

name string Required
sequence_id string(uuid) Required

Responses

201

Scene created for given project

POST /data/projects/{project_id}/scenes

curl \
 --request POST 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/scenes' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"name":"Name of scene","sequence_id":"a24a6ea4-ce75-4665-a070-57453082c25"}'

Request examples

{
  "name": "Name of scene",
  "sequence_id": "a24a6ea4-ce75-4665-a070-57453082c25"
}

Retrieve all sequences related to a given project.

GET /data/projects/{project_id}/sequences

Jwt authorization

Path parameters

project_id Required

Responses

200

All sequences related to given project

GET /data/projects/{project_id}/sequences

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/sequences' \
 --header "Authorization: $API_KEY"

Create a sequence for given project.

POST /data/projects/{project_id}/sequences

Jwt authorization

Path parameters

project_id Required

application/json

Body Required

name string Required
episode_id string(uuid)

Responses

201

Sequence created for given project

POST /data/projects/{project_id}/sequences

curl \
 --request POST 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/sequences' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"name":"Name of sequence","episode_id":"a24a6ea4-ce75-4665-a070-57453082c25"}'

Request examples

{
  "name": "Name of sequence",
  "episode_id": "a24a6ea4-ce75-4665-a070-57453082c25"
}

Retrieve all episodes related to a given project.

GET /data/projects/{project_id}/episodes

Jwt authorization

Path parameters

project_id Required

Responses

200

All episodes related to given project

GET /data/projects/{project_id}/episodes

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/episodes' \
 --header "Authorization: $API_KEY"

Create an episode for given project.

POST /data/projects/{project_id}/episodes

Jwt authorization

Path parameters

project_id Required

application/json

Body Required

name string Required
description string Required

Responses

201

Episode created for given project

POST /data/projects/{project_id}/episodes

curl \
 --request POST 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/episodes' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"name":"Name of the episode","description":"Description of the episode"}'

Request examples

{
  "name": "Name of the episode",
  "description": "Description of the episode"
}

Retrieve number of tasks by status, task_types and episodes for given project.

GET /data/projects/{project_id}/episodes/stats

Jwt authorization

Path parameters

project_id Required

Responses

200

Number of tasks by status, task types and episodes for given project

GET /data/projects/{project_id}/episodes/stats

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/episodes/stats' \
 --header "Authorization: $API_KEY"

Retrieve number of tasks by status, task_types and episodes for given project.

GET /data/projects/{project_id}/episodes/retake-stats

Jwt authorization

Path parameters

project_id Required

Responses

200

Number of tasks by status, task types and episodes for given project

GET /data/projects/{project_id}/episodes/retake-stats

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/episodes/retake-stats' \
 --header "Authorization: $API_KEY"

Retrieve quotas statistics for shots.

GET /data/projects/{project_id}/quotas/{task_type_id}

Jwt authorization

Path parameters

project_id Required
task_type_id Required

Query parameters

count_mode Required
studio_id

Responses

200

Quotas statistics for shots

GET /data/projects/{project_id}/quotas/{task_type_id}

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/quotas/a24a6ea4-ce75-4665-a070-57453082c25?count_mode=weighted' \
 --header "Authorization: $API_KEY"

Retrieve quotas statistics for shots.

GET /data/projects/{project_id}/quotas/persons/{person_id}

Jwt authorization

Path parameters

project_id Required
person_id Required

Query parameters

count_mode Required
studio_id

Responses

200

Quotas statistics for shots

GET /data/projects/{project_id}/quotas/persons/{person_id}

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/quotas/persons/a24a6ea4-ce75-4665-a070-57453082c25?count_mode=weighted' \
 --header "Authorization: $API_KEY"

Set frames for given shots.

POST /actions/projects/{project_id}/task-types/{task_type_id}/set-shot-nb-frames

Jwt authorization

application/json

Body Required

shots array[object] Required
Hide shots attributes Show shots attributes object
- shot_id string(uuid)
- nb_frames integer

Responses

200

Frames set 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" \
 --header "Content-Type: application/json" \
 --data '{"shots":[{"shot_id":"a24a6ea4-ce75-4665-a070-57453082c25","nb_frames":24}]}'

Request examples

{
  "shots": [
    {
      "shot_id": "a24a6ea4-ce75-4665-a070-57453082c25",
      "nb_frames": 24
    }
  ]
}

Return all tasks related to open projects.

GET /data/tasks/open-tasks

Jwt authorization

Query parameters

project_id string(uuid)

Filter tasks on given project ID
task_status_id string(uuid)

Filter tasks on given task status ID
task_type_id string(uuid)

Filter tasks on given task type ID
person_id string(uuid)

Filter tasks on given person ID
start_date string(date)

Filter tasks posterior to given start date
due_date string(date)

Filter tasks anterior to given due date
priority integer

Filter tasks on given priority
page integer

Page number

Default value is 1.
limit integer

Number of tasks per page

Default value is 100.

Responses

200 application/json

List of tasks with pagination and statistics
Hide response attributes Show response attributes object
- data array[object]
  
  List of tasks
- stats object
  
  Hide stats attributes Show stats attributes object
  
  total integer
  
  Total number of tasks
  
  total_duration integer
  
  Total duration of tasks in minutes
  
  total_estimation integer
  
  Total estimation of tasks in minutes
  
  status object
  
  Number of tasks per status
- limit integer
  
  Number of tasks per page
- page integer
  
  Page number
- is_more boolean
  
  True if there are more tasks to retrieve
400

Bad request

GET /data/tasks/open-tasks

curl \
 --request GET 'http://api.example.com/data/tasks/open-tasks' \
 --header "Authorization: $API_KEY"

Response examples (200)

{
  "data": [
    {}
  ],
  "stats": {
    "total": 42,
    "total_duration": 42,
    "total_estimation": 42,
    "status": {}
  },
  "limit": 42,
  "page": 42,
  "is_more": true
}

Return task amount, task done amount, total estimation, total duration

GET /data/tasks/open-tasks/stats

Jwt authorization

by status by task type by project for open projects. It aggregates the
result at the project level.

Responses

200 application/json

A dict organized by project that contains the results for each task type and status pairs
Hide response attribute Show response attribute object
- * object Additional properties
  
  Hide * attribute Show * attribute object
  
  task_types object
  
  Hide task_types attribute Show task_types attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  total integer
  
  done integer
  
  estimation integer
  
  duration integer
400

Bad request

GET /data/tasks/open-tasks/stats

curl \
 --request GET 'http://api.example.com/data/tasks/open-tasks/stats' \
 --header "Authorization: $API_KEY"

Response examples (200)

{
  "additionalProperty1": {
    "task_types": {
      "additionalProperty1": {
        "total": 42,
        "done": 42,
        "estimation": 42,
        "duration": 42
      },
      "additionalProperty2": {
        "total": 42,
        "done": 42,
        "estimation": 42,
        "duration": 42
      }
    }
  },
  "additionalProperty2": {
    "task_types": {
      "additionalProperty1": {
        "total": 42,
        "done": 42,
        "estimation": 42,
        "duration": 42
      },
      "additionalProperty2": {
        "total": 42,
        "done": 42,
        "estimation": 42,
        "duration": 42
      }
    }
  }
}

Return comments linked to given task.

GET /data/tasks/{task_id}/comments

Jwt authorization

Path parameters

task_id string(uuid) Required

Responses

200 application/json

Comments linked to given task
404

Task not found

GET /data/tasks/{task_id}/comments

curl \
 --request GET 'http://api.example.com/data/tasks/a24a6ea4-ce75-4665-a070-57453082c25/comments' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {}
]

Get comment corresponding at given ID.

GET /data/tasks/{task_id}/comments/{comment_id}

Jwt authorization

Path parameters

task_id string(uuid) Required
comment_id string(uuid) Required

Responses

200 application/json

Comment corresponding at given ID
404

Task or comment not found

GET /data/tasks/{task_id}/comments/{comment_id}

curl \
 --request GET 'http://api.example.com/data/tasks/a24a6ea4-ce75-4665-a070-57453082c25/comments/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Response examples (200)

{}

Delete a comment corresponding at given ID.

DELETE /data/tasks/{task_id}/comments/{comment_id}

Jwt authorization

Path parameters

task_id string(uuid) Required
comment_id string(uuid) Required

Responses

204

Comment corresponding at given ID deleted
404

Task or comment not found

DELETE /data/tasks/{task_id}/comments/{comment_id}

curl \
 --request DELETE 'http://api.example.com/data/tasks/a24a6ea4-ce75-4665-a070-57453082c25/comments/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Return previews linked to given task.

GET /data/tasks/{task_id}/previews

Jwt authorization

Path parameters

task_id string(uuid) Required

Responses

200 application/json

Previews linked to given task
404

Task not found

GET /data/tasks/{task_id}/previews

curl \
 --request GET 'http://api.example.com/data/tasks/a24a6ea4-ce75-4665-a070-57453082c25/previews' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {}
]

Return a task with many information.

GET /data/tasks/{task_id}/full

Jwt authorization

Full details for assignees, full details for task type, full details for task status, etc.

Path parameters

task_id string Required

Responses

200

Task with many information

GET /data/tasks/{task_id}/full

curl \
 --request GET 'http://api.example.com/data/tasks/a24a6ea4-ce75-4665-a070-57453082c25/full' \
 --header "Authorization: $API_KEY"

Return task assigned to given user of which status has is_done flag sets to false.

GET /data/persons/{person_id}/tasks

Jwt authorization

Path parameters

person_id string(uuid) Required

Responses

200 application/json

Tasks assigned to user that are not done
404

Person not found

GET /data/persons/{person_id}/tasks

curl \
 --request GET 'http://api.example.com/data/persons/a24a6ea4-ce75-4665-a070-57453082c25/tasks' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {}
]

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}

Jwt authorization

GET /data/persons/{person_id}/related-tasks/{task_type_id}

curl \
 --request GET 'http://api.example.com/data/persons/a24a6ea4-ce75-4665-a070-57453082c25/related-tasks/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {}
]

Return task assigned to given user of which status has is_done flag sets to true.

GET /data/persons/{person_id}/done-tasks

Jwt authorization

It return only tasks related to open projects.

Path parameters

person_id string(uuid) Required

Responses

200 application/json

Tasks assigned to user that are done
404

Person not found

GET /data/persons/{person_id}/done-tasks

curl \
 --request GET 'http://api.example.com/data/persons/a24a6ea4-ce75-4665-a070-57453082c25/done-tasks' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {}
]

Return tasks related to given entity asset, episode, sequence, shot or scene.

GET /data/entities/{entity_id}/task-types/{task_type_id}/tasks

Jwt authorization

Path parameters

entity_id string Required
task_type_id string Required

Responses

200

Tasks related to given entity asset, episode, sequence, shot or scene

GET /data/entities/{entity_id}/task-types/{task_type_id}/tasks

curl \
 --request GET 'http://api.example.com/data/entities/a24a6ea4-ce75-4665-a070-57453082c25/task-types/a24a6ea4-ce75-4665-a070-57453082c25/tasks' \
 --header "Authorization: $API_KEY"

Retrieve all comments to tasks related to given project.

GET /data/projects/{project_id}/comments

Jwt authorization

It's mainly used for synchronisation purpose.

Path parameters

project_id string Required

Query parameters

limit

Responses

200

All comments to tasks related to given project

GET /data/projects/{project_id}/comments

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/comments' \
 --header "Authorization: $API_KEY"

Retrieve all notifications to tasks related to given project.

GET /data/projects/{project_id}/notifications

Jwt authorization

It's mainly used for synchronisation purpose.

Path parameters

project_id string Required

Responses

200

All notifications to tasks related to given project

GET /data/projects/{project_id}/notifications

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/notifications' \
 --header "Authorization: $API_KEY"

Preview files related to a given project.

GET /data/projects/{project_id}/preview-files

Jwt authorization

Path parameters

project_id string Required

Responses

200

Preview files related to given project

GET /data/projects/{project_id}/preview-files

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/preview-files' \
 --header "Authorization: $API_KEY"

Retrieve all subcriptions to tasks related to given project.

GET /data/projects/{project_id}/subscriptions

Jwt authorization

It's mainly used for synchronisation purpose.

Path parameters

project_id string Required

Responses

200

All subcriptions to tasks related to given project

GET /data/projects/{project_id}/subscriptions

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/subscriptions' \
 --header "Authorization: $API_KEY"

Retrieve all tasks related to given project.

GET /data/projects/{project_id}/tasks

Jwt authorization

It's mainly used for synchronisation purpose.

Path parameters

project_id string Required

Query parameters

page
task_type_id
episode_id

Responses

200

All tasks related to given project

GET /data/projects/{project_id}/tasks

curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/tasks' \
 --header "Authorization: $API_KEY"

For schedule usages, for each active person, it returns the first start

GET /data/persons/task-dates

Jwt authorization

date of all tasks of assigned to this person and the last end date.

Query parameters

project_id string(uuid)

Filter by project ID

Responses

200 application/json

For each person, the first start date of all tasks assigned to this person and the last end date
Hide response attributes Show response attributes object
- person_id string(uuid)
- first_start_date string(date)
- last_end_date string(date)
403

Admin permissions required

GET /data/persons/task-dates

curl \
 --request GET 'http://api.example.com/data/persons/task-dates' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {
    "person_id": "string",
    "first_start_date": "2025-05-04",
    "last_end_date": "2025-05-04"
  }
]

Delete all tasks for a given task type and project.

DELETE /actions/projects/{project_id}/task-types/{task_type_id}/delete-tasks

Jwt authorization

It's mainly used when tasks are created by mistake at the beginning of the project.

Path parameters

project_id string Required
task_type_id string Required

Responses

204

All tasks for given task type and project deleted

DELETE /actions/projects/{project_id}/task-types/{task_type_id}/delete-tasks

curl \
 --request DELETE 'http://api.example.com/actions/projects/a24a6ea4-ce75-4665-a070-57453082c25/task-types/a24a6ea4-ce75-4665-a070-57453082c25/delete-tasks' \
 --header "Authorization: $API_KEY"

Delete tasks matching id list given in parameter.

POST /actions/projects/{project_id}/delete-tasks

Jwt authorization

See it as a way to batch delete tasks.

Path parameters

project_id string Required

Responses

200

Tasks matching id list given in parameter deleted

POST /actions/projects/{project_id}/delete-tasks

curl \
 --request POST 'http://api.example.com/actions/projects/a24a6ea4-ce75-4665-a070-57453082c25/delete-tasks' \
 --header "Authorization: $API_KEY"

Assign given task list to given person.

PUT /actions/tasks/{task_id}/assign

Jwt authorization

Path parameters

task_id string Required

Responses

200

Given task assigned to given person
400

Assignee non-existent in database

PUT /actions/tasks/{task_id}/assign

curl \
 --request PUT 'http://api.example.com/actions/tasks/a24a6ea4-ce75-4665-a070-57453082c25/assign' \
 --header "Authorization: $API_KEY"

Remove all assignations set to given task.

PUT /actions/tasks/clear-assignation

Jwt authorization

Responses

200

All assignations removed

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.

PUT /actions/persons/{person_id}/assign

Jwt authorization

If a given task ID is wrong, it ignores it.

Path parameters

person_id string(uuid) Required

Responses

200

Given tasks lists assigned to given person

PUT /actions/persons/{person_id}/assign

curl \
 --request PUT 'http://api.example.com/actions/persons/a24a6ea4-ce75-4665-a070-57453082c25/assign' \
 --header "Authorization: $API_KEY"

Get time spent on a given task and date.

GET /actions/tasks/{task_id}/time-spents/{date}

Jwt authorization

Path parameters

task_id string Required
date string Required

Responses

200

Time spent on given task and date
404

Wrong date format

GET /actions/tasks/{task_id}/time-spents/{date}

curl \
 --request GET 'http://api.example.com/actions/tasks/a24a6ea4-ce75-4665-a070-57453082c25/time-spents/2022-07-12' \
 --header "Authorization: $API_KEY"

Get time spent on a given task.

GET /actions/tasks/{task_id}/time-spents

Jwt authorization

Path parameters

task_id string Required

Responses

200

Time spent on given task
404

Wrong date format

GET /actions/tasks/{task_id}/time-spents

curl \
 --request GET 'http://api.example.com/actions/tasks/a24a6ea4-ce75-4665-a070-57453082c25/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}

Jwt authorization

Path parameters

task_id string Required
date string Required
person_id string Required

Responses

201

Time spent by given person on given task for given day is set
404

Wrong date format

POST /actions/tasks/{task_id}/time-spents/{date}/persons/{person_id}

curl \
 --request POST 'http://api.example.com/actions/tasks/a24a6ea4-ce75-4665-a070-57453082c25/time-spents/2022-07-12/persons/a24a6ea4-ce75-4665-a070-57453082c25' \
 --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}

Jwt authorization

Path parameters

task_id string Required
date string Required
person_id string Required

Responses

201

Time spent by given person on given task for given day is removed
404

Wrong date format

DELETE /actions/tasks/{task_id}/time-spents/{date}/persons/{person_id}

curl \
 --request DELETE 'http://api.example.com/actions/tasks/a24a6ea4-ce75-4665-a070-57453082c25/time-spents/2022-07-12/persons/a24a6ea4-ce75-4665-a070-57453082c25' \
 --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

Jwt authorization

Path parameters

task_id string Required
date string Required
person_id string Required

Responses

201

Given timeframe added to time spent by given person on given task for given day
404

Wrong date format

POST /actions/tasks/{task_id}/time-spents/{date}/persons/{person_id}/add

curl \
 --request POST 'http://api.example.com/actions/tasks/a24a6ea4-ce75-4665-a070-57453082c25/time-spents/2022-07-12/persons/a24a6ea4-ce75-4665-a070-57453082c25/add' \
 --header "Authorization: $API_KEY"

Add preview metadata to given task. The preview file itself should be

POST /actions/tasks/{task_id}/comments/{comment_id}/add-preview

Jwt authorization

uploaded afterward.

Revision is automatically set: it is equal to last revision + 1. It can
be also set manually.

Path parameters

task_id string(uuid) Required
comment_id string(uuid) Required

application/json

Body Required

revision integer

Revision number for the preview

Responses

201 application/json

Preview metadata added to given task
400

Bad request
404

Task or comment not found

POST /actions/tasks/{task_id}/comments/{comment_id}/add-preview

curl \
 --request POST 'http://api.example.com/actions/tasks/a24a6ea4-ce75-4665-a070-57453082c25/comments/a24a6ea4-ce75-4665-a070-57453082c25/add-preview' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"revision":1}'

Request examples

{
  "revision": 1
}

Response examples (201)

{}

Add a preview to given comment.

POST /actions/tasks/{task_id}/comments/{comment_id}/preview-files/{preview_file_id}

Jwt authorization

Path parameters

task_id string(uuid) Required
comment_id string(uuid) Required
preview_file_id string(uuid) Required

multipart/form-data

Body Required

file string(binary)

Preview file to upload

Responses

201 application/json

Preview added to given comment
400

Bad request
404

Task, comment, or preview file not found

POST /actions/tasks/{task_id}/comments/{comment_id}/preview-files/{preview_file_id}

curl \
 --request POST 'http://api.example.com/actions/tasks/a24a6ea4-ce75-4665-a070-57453082c25/comments/a24a6ea4-ce75-4665-a070-57453082c25/preview-files/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: multipart/form-data" \
 --form "file=@file"

Response examples (201)

{}

Delete preview from given comment.

DELETE /actions/tasks/{task_id}/comments/{comment_id}/preview-files/{preview_file_id}

Jwt authorization

Path parameters

task_id string(uuid) Required
comment_id string(uuid) Required
preview_file_id string(uuid) Required

Query parameters

force boolean

Force deletion even if preview has dependencies

Default value is false.

Responses

204

Preview deleted from given comment
404

Task, comment, or preview file not found

DELETE /actions/tasks/{task_id}/comments/{comment_id}/preview-files/{preview_file_id}

curl \
 --request DELETE 'http://api.example.com/actions/tasks/a24a6ea4-ce75-4665-a070-57453082c25/comments/a24a6ea4-ce75-4665-a070-57453082c25/preview-files/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Change a task status to "to review".

PUT /actions/tasks/{task_id}/to-review

Jwt authorization

It creates a new preview file entry and set path from the hard disk.

Path parameters

task_id string Required

Responses

200

Task status changed to "to review"
400

Given person not found

PUT /actions/tasks/{task_id}/to-review

curl \
 --request PUT 'http://api.example.com/actions/tasks/a24a6ea4-ce75-4665-a070-57453082c25/to-review' \
 --header "Authorization: $API_KEY"

Create a new task for given shot and task type.

POST /actions/projects/{project_id}/task-types/{task_type_id}/shots/create-tasks

Jwt authorization

Path parameters

project_id string(uuid) Required
task_type_id string(uuid) Required

application/json

Body Required

array[string(uuid)]

List of shot IDs to create tasks for

Responses

201 application/json

New task for given shot and task type created
400

Bad request
404

Project or task type not found

POST /actions/projects/{project_id}/task-types/{task_type_id}/shots/create-tasks

curl \
 --request POST 'http://api.example.com/actions/projects/a24a6ea4-ce75-4665-a070-57453082c25/task-types/a24a6ea4-ce75-4665-a070-57453082c25/shots/create-tasks' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '["string"]'

Request examples

[
  "string"
]

Response examples (201)

[
  {}
]

Create a new task for given asset and task type.

POST /actions/projects/{project_id}/task-types/{task_type_id}/assets/create-tasks

Jwt authorization

Path parameters

project_id string Required
task_type_id string Required

Responses

201 application/json

New task for given asset and task type created
400

Bad request
404

Project or task type not found

POST /actions/projects/{project_id}/task-types/{task_type_id}/assets/create-tasks

curl \
 --request POST 'http://api.example.com/actions/projects/a24a6ea4-ce75-4665-a070-57453082c25/task-types/a24a6ea4-ce75-4665-a070-57453082c25/assets/create-tasks' \
 --header "Authorization: $API_KEY"

Response examples (201)

[
  {}
]

Create a new task for given edit and task type.

POST /actions/projects/{project_id}/task-types/{task_type_id}/edits/create-tasks

Jwt authorization

Path parameters

project_id string Required
task_type_id string Required

Responses

201 application/json

New task for given edit and task type created
400

Bad request
404

Project or task type not found

POST /actions/projects/{project_id}/task-types/{task_type_id}/edits/create-tasks

curl \
 --request POST 'http://api.example.com/actions/projects/a24a6ea4-ce75-4665-a070-57453082c25/task-types/a24a6ea4-ce75-4665-a070-57453082c25/edits/create-tasks' \
 --header "Authorization: $API_KEY"

Response examples (201)

[
  {}
]

Create a new task for given concept and task type.

POST /actions/projects/{project_id}/task-types/{task_type_id}/concepts/create-tasks

Jwt authorization

Path parameters

project_id string Required
task_type_id string Required

Responses

201 application/json

New task for given concept and task type created
400

Bad request
404

Project or task type not found

POST /actions/projects/{project_id}/task-types/{task_type_id}/concepts/create-tasks

curl \
 --request POST 'http://api.example.com/actions/projects/a24a6ea4-ce75-4665-a070-57453082c25/task-types/a24a6ea4-ce75-4665-a070-57453082c25/concepts/create-tasks' \
 --header "Authorization: $API_KEY"

Response examples (201)

[
  {}
]

Create a new task with given task type for each entity of given

POST /actions/projects/{project_id}/task-types/{task_type_id}/create-tasks/{entity_type}/

Jwt authorization

entity type.

Path parameters

project_id string Required
task_type_id string Required

Responses

201 application/json

List of created tasks
400

Bad request
404

Project, entity type, or task type not found

POST /actions/projects/{project_id}/task-types/{task_type_id}/create-tasks/{entity_type}/

curl \
 --request POST 'http://api.example.com/actions/projects/a24a6ea4-ce75-4665-a070-57453082c25/task-types/a24a6ea4-ce75-4665-a070-57453082c25/create-tasks/{entity_type}/' \
 --header "Authorization: $API_KEY"

Response examples (201)

[
  {}
]

Set last preview from given task as main preview of the related entity.

PUT /actions/tasks/{task_id}/set-main-preview

Jwt authorization

This preview will be used as thumbnail to illustrate the entity.

Path parameters

preview_file_id string Required

Responses

200

Given preview set as main preview

PUT /actions/tasks/{task_id}/set-main-preview

curl \
 --request PUT 'http://api.example.com/actions/tasks/{task_id}/set-main-preview' \
 --header "Authorization: $API_KEY"

Set `has_avatar` flag to False for current user and remove its avatar

DELETE /actions/persons/{person_id}/clear-avatar

Jwt authorization

file.

Responses

204

Avatar file deleted

DELETE /actions/persons/{person_id}/clear-avatar

curl \
 --request DELETE 'http://api.example.com/actions/persons/{person_id}/clear-avatar' \
 --header "Authorization: $API_KEY"

Return context required to properly run a full app connected to the API

GET /data/user/context

Jwt authorization

(like the Kitsu web client).

Responses

200 application/json

Context to properly run a full app connected to the API

GET /data/user/context

curl \
 --request GET 'http://api.example.com/data/user/context' \
 --header "Authorization: $API_KEY"

Response examples (200)

{}

Return tasks related to given asset for current user.

GET /data/user/assets/{asset_id}/tasks

Jwt authorization

Path parameters

asset_id string(uuid) Required

Responses

200 application/json

Tasks related to given asset for current user
404

Asset not found

GET /data/user/assets/{asset_id}/tasks

curl \
 --request GET 'http://api.example.com/data/user/assets/a24a6ea4-ce75-4665-a070-57453082c25/tasks' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {}
]

Return tasks related to given shot for current user.

GET /data/user/shots/{shot_id}/tasks

Jwt authorization

Path parameters

shot_id string(uuid) Required

Responses

200 application/json

Tasks related to given shot
404

Shot not found

GET /data/user/shots/{shot_id}/tasks

curl \
 --request GET 'http://api.example.com/data/user/shots/a24a6ea4-ce75-4665-a070-57453082c25/tasks' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {}
]

Return tasks related to given scene for current user.

GET /data/user/scenes/{scene_id}/tasks

Jwt authorization

Path parameters

scene_id string(uuid) Required

Responses

200 application/json

Tasks related to given scene
404

Scene not found

GET /data/user/scenes/{scene_id}/tasks

curl \
 --request GET 'http://api.example.com/data/user/scenes/a24a6ea4-ce75-4665-a070-57453082c25/tasks' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {}
]

Return tasks related to given sequence for current user.

GET /data/user/sequences/{sequence_id}/tasks

Jwt authorization

Path parameters

sequence_id string(uuid) Required

Responses

200 application/json

Tasks related to given sequence
404

Sequence not found

GET /data/user/sequences/{sequence_id}/tasks

curl \
 --request GET 'http://api.example.com/data/user/sequences/a24a6ea4-ce75-4665-a070-57453082c25/tasks' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {}
]

Return task types related to given asset for current user.

GET /data/user/assets/{asset_id}/task-types

Jwt authorization

Path parameters

asset_id string(uuid) Required

Responses

200 application/json

Task types related to given asset for current user
404

Asset not found

GET /data/user/assets/{asset_id}/task-types

curl \
 --request GET 'http://api.example.com/data/user/assets/a24a6ea4-ce75-4665-a070-57453082c25/task-types' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {}
]

Return tasks related to given shot for current user.

GET /data/user/shots/{shot_id}/task-types

Jwt authorization

Path parameters

shot_id string(uuid) Required

Responses

200 application/json

Tasks related to given shot for current user
404

Shot not found

GET /data/user/shots/{shot_id}/task-types

curl \
 --request GET 'http://api.example.com/data/user/shots/a24a6ea4-ce75-4665-a070-57453082c25/task-types' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {}
]

Return tasks related to given scene for current user.

GET /data/user/scenes/{scene_id}/task-types

Jwt authorization

Path parameters

scene_id string(uuid) Required

Responses

200 application/json

Tasks related to given scene for current user
404

Scene not found

GET /data/user/scenes/{scene_id}/task-types

curl \
 --request GET 'http://api.example.com/data/user/scenes/a24a6ea4-ce75-4665-a070-57453082c25/task-types' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {}
]

Return tasks related to given sequence for current user.

GET /data/user/sequences/{sequence_id}/task-types

Jwt authorization

Path parameters

sequence_id string(uuid) Required

Responses

200 application/json

Tasks related to given sequence for current user
404

Sequence not found

GET /data/user/sequences/{sequence_id}/task-types

curl \
 --request GET 'http://api.example.com/data/user/sequences/a24a6ea4-ce75-4665-a070-57453082c25/task-types' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {}
]

Return open projects for which the user has at least one task assigned.

GET /data/user/projects/open

Jwt authorization

Query parameters

name string

Filter projects by name

Responses

200 application/json

Open projects for which the user has at least one task assigned

GET /data/user/projects/open

curl \
 --request GET 'http://api.example.com/data/user/projects/open' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {}
]

Return asset types related to given project if the current user has

GET /data/user/projects/{project_id}/asset-types

Jwt authorization

access to it.

Path parameters

project_id string(uuid) Required

Responses

200 application/json

Asset types related to given project
404

Project not found

GET /data/user/projects/{project_id}/asset-types

curl \
 --request GET 'http://api.example.com/data/user/projects/a24a6ea4-ce75-4665-a070-57453082c25/asset-types' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {}
]

Return assets of which type is given asset type and are listed in given

GET /data/user/projects/{project_id}/asset-types/{asset_type_id}/assets

Jwt authorization

project if user has access to this project.

Path parameters

project_id string(uuid) Required
asset_type_id string(uuid) Required

Responses

200 application/json

Assets of which type is given asset type and are listed in given project
404

Project or asset type not found

GET /data/user/projects/{project_id}/asset-types/{asset_type_id}/assets

curl \
 --request GET 'http://api.example.com/data/user/projects/a24a6ea4-ce75-4665-a070-57453082c25/asset-types/a24a6ea4-ce75-4665-a070-57453082c25/assets' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {}
]

Return sequences related to given project if the current user has access

GET /data/user/projects/{project_id}/sequences

Jwt authorization

to it.

Path parameters

project_id string(uuid) Required

Responses

200 application/json

Sequences related to given project
404

Project not found

GET /data/user/projects/{project_id}/sequences

curl \
 --request GET 'http://api.example.com/data/user/projects/a24a6ea4-ce75-4665-a070-57453082c25/sequences' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {}
]

Return episodes related to given project if the current user has access

GET /data/user/projects/{project_id}/episodes

Jwt authorization

to it.

Path parameters

project_id string(uuid) Required

Responses

200 application/json

Episodes related to given project
404

Project not found

GET /data/user/projects/{project_id}/episodes

curl \
 --request GET 'http://api.example.com/data/user/projects/a24a6ea4-ce75-4665-a070-57453082c25/episodes' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {}
]

Return shots related to given sequence if the current user has access

GET /data/user/sequences/{sequence_id}/shots

Jwt authorization

to it.

Path parameters

sequence_id string(uuid) Required

Responses

200 application/json

Shots related to given sequence
404

Sequence not found

GET /data/user/sequences/{sequence_id}/shots

curl \
 --request GET 'http://api.example.com/data/user/sequences/a24a6ea4-ce75-4665-a070-57453082c25/shots' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {}
]

Return scenes related to given sequence if the current user has access

GET /data/user/sequences/{sequence_id}/scenes

Jwt authorization

to it.

Path parameters

sequence_id string(uuid) Required

Responses

200 application/json

Scenes related to given sequence
404

Sequence not found

GET /data/user/sequences/{sequence_id}/scenes

curl \
 --request GET 'http://api.example.com/data/user/sequences/a24a6ea4-ce75-4665-a070-57453082c25/scenes' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {}
]

Return tasks currently assigned to current user and of which status has

GET /data/user/tasks

Jwt authorization

is_done attribute set to false.

Responses

200 application/json

Unfinished tasks currently assigned to current user

GET /data/user/tasks

curl \
 --request GET 'http://api.example.com/data/user/tasks' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {}
]

Return tasks requiring feedback for current user departments.

GET /data/user/tasks-to-check

Jwt authorization

If the user is not a supervisor, it returns an empty list.

Responses

200 application/json

Tasks requiring feedback in current user departments

GET /data/user/tasks-to-check

curl \
 --request GET 'http://api.example.com/data/user/tasks-to-check' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {}
]

Return tasks currently assigned to current user and of which status has

GET /data/user/done-tasks

Jwt authorization

is_done attribute set to true. It returns only tasks of open projects.

Responses

200 application/json

Finished tasks currently assigned to current user

GET /data/user/done-tasks

curl \
 --request GET 'http://api.example.com/data/user/done-tasks' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {}
]

Allow to create and retrieve filters for current user and only for

GET /data/user/filters

Jwt authorization

open projects.

Responses

200 application/json

Filters for current user and only for open projects

GET /data/user/filters

curl \
 --request GET 'http://api.example.com/data/user/filters' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {}
]

Create filter for current user and only for open projects.

POST /data/user/filters

Jwt authorization

application/x-www-form-urlencoded

Body Required

name string Required
query string Required
list_type string Required
entity_type string
project_id string(uuid) Required
is_shared boolean

Default value is false.
search_filter_group_id string(uuid)
department_id string(uuid)

Responses

201 application/json

Filter for current user and only for open projects created
400

Bad request

POST /data/user/filters

curl \
 --request POST 'http://api.example.com/data/user/filters' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'name=Name+of+filter&query=%7B%22project_id%22%3A+%22uuid%22%7D&list_type=todo&entity_type=Asset&project_id=a24a6ea4-ce75-4665-a070-57453082c25&is_shared=false&search_filter_group_id=string&department_id=string'

Response examples (201)

{}

Update given filter if it's owned by current user.

PUT /data/user/filters/{filter_id}

Jwt authorization

Path parameters

filter_id Required

Responses

200

Given filter with updated data.

PUT /data/user/filters/{filter_id}

curl \
 --request PUT 'http://api.example.com/data/user/filters/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete given filter if it's owned by current user.

DELETE /data/user/filters/{filter_id}

Jwt authorization

Path parameters

filter_id string(uuid) Required

Responses

204

Filter deleted successfully
404

Filter not found

DELETE /data/user/filters/{filter_id}

curl \
 --request DELETE 'http://api.example.com/data/user/filters/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Retrieve filter groups for current user and only for open projects.

GET /data/user/filter-groups

Jwt authorization

Responses

200 application/json

Filter groups for current user and only for open projects

GET /data/user/filter-groups

curl \
 --request GET 'http://api.example.com/data/user/filter-groups' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {}
]

Create filter group for current user and only for open projects.

POST /data/user/filter-groups

Jwt authorization

application/x-www-form-urlencoded

Body Required

name string Required
color string Required
list_type string Required
entity_type string
is_shared boolean

Default value is false.
project_id string(uuid) Required
department_id string(uuid)

Responses

201 application/json

Filter group for the current user and only for open projects created
400

Bad request

POST /data/user/filter-groups

curl \
 --request POST 'http://api.example.com/data/user/filter-groups' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'name=Name+of+filter+group&color=string&list_type=todo&entity_type=Asset&is_shared=false&project_id=a24a6ea4-ce75-4665-a070-57453082c25&department_id=a24a6ea4-ce75-4665-a070-57453082c25'

Response examples (201)

{}

Retrieve given filter group for the current user.

GET /data/user/filter-groups/{filter_group_id}

Jwt authorization

Responses

200

Filter groups for the current user and only for open projects

GET /data/user/filter-groups/{filter_group_id}

curl \
 --request GET 'http://api.example.com/data/user/filter-groups/{filter_group_id}' \
 --header "Authorization: $API_KEY"

Update given filter group if it's owned by the current user.

PUT /data/user/filter-groups/{filter_group_id}

Jwt authorization

Path parameters

filter_id Required

Responses

200

Given filter group with updated data

PUT /data/user/filter-groups/{filter_group_id}

curl \
 --request PUT 'http://api.example.com/data/user/filter-groups/{filter_group_id}' \
 --header "Authorization: $API_KEY"

Delete given filter group if it's owned by the current user.

DELETE /data/user/filter-groups/{filter_group_id}

Jwt authorization

Path parameters

filter_id Required

Responses

204

Empty response

DELETE /data/user/filter-groups/{filter_group_id}

curl \
 --request DELETE 'http://api.example.com/data/user/filter-groups/{filter_group_id}' \
 --header "Authorization: $API_KEY"

Retrieve desktop login logs.

GET /data/user/desktop-login-logs

Jwt authorization

GET /data/user/desktop-login-logs

curl \
 --request GET 'http://api.example.com/data/user/desktop-login-logs' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {}
]

Create a desktop login log. Desktop login logs can

POST /data/user/desktop-login-logs

Jwt authorization

only be created by the current user.

application/x-www-form-urlencoded

Responses

201 application/json

Desktop login log created
400

Bad request

POST /data/user/desktop-login-logs

curl \
 --request POST 'http://api.example.com/data/user/desktop-login-logs' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'date=2022-07-12'

Response examples (201)

{}

Get all time spents for the current user.

GET /data/user/time-spents

Jwt authorization

Optionnaly can accept date range parameters.

Query parameters

start_date string(date)

Start date for filtering time spents
end_date string(date)

End date for filtering time spents

Responses

200 application/json

All time spents for the current user
400

Wrong date format

GET /data/user/time-spents

curl \
 --request GET 'http://api.example.com/data/user/time-spents' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {}
]

Get time spents on for current user and given date.

GET /data/user/time-spents/{date}

Jwt authorization

Path parameters

date string(date) Required

Date to get time spents for

Responses

200 application/json

Time spents on for current user and given date
400

Wrong date format

GET /data/user/time-spents/{date}

curl \
 --request GET 'http://api.example.com/data/user/time-spents/2022-07-12' \
 --header "Authorization: $API_KEY"

Response examples (200)

{}

Get time spents for current user and given date.

GET /data/user/tasks/{task_id}/time-spents/{date}

Jwt authorization

Path parameters

task_id string(uuid) Required
date string(date) Required

Responses

200 application/json

Time spents for current user and given date
404

Wrong date format or task not found

GET /data/user/tasks/{task_id}/time-spents/{date}

curl \
 --request GET 'http://api.example.com/data/user/tasks/a24a6ea4-ce75-4665-a070-57453082c25/time-spents/2022-07-12' \
 --header "Authorization: $API_KEY"

Response examples (200)

{}

Get day off object for current user and given date.

GET /data/user/day-offs/{date}

Jwt authorization

Path parameters

date string(date) Required

Responses

200 application/json

Day off object for current user and given date
404

Wrong date format

GET /data/user/day-offs/{date}

curl \
 --request GET 'http://api.example.com/data/user/day-offs/2022-07-12' \
 --header "Authorization: $API_KEY"

Response examples (200)

{}

Return last 100 user notifications filtered by given parameters.

GET /data/user/notifications

Jwt authorization

Query parameters

after string(date)

Filter notifications after this date
before string(date)

Filter notifications before this date
task_type_id string(uuid)

Filter by task type ID
task_status_id string(uuid)

Filter by task status ID
type string

Filter by notification type
read boolean

Filter by read status
watching boolean

Filter by watching status

Responses

200 application/json

100 last user notifications

GET /data/user/notifications

curl \
 --request GET 'http://api.example.com/data/user/notifications' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {}
]

Return notification matching given id, only if it's a notification that

GET /data/user/notifications/{notification_id}

Jwt authorization

belongs to current user.

Path parameters

notification_id string(uuid) Required

Responses

200 application/json

Notification matching given ID
404

Notification not found

GET /data/user/notifications/{notification_id}

curl \
 --request GET 'http://api.example.com/data/user/notifications/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Response examples (200)

{}

Change notification read status.

PUT /data/user/notifications/{notification_id}

Jwt authorization

Path parameters

notification_id string(uuid) Required

application/x-www-form-urlencoded

Body Required

read boolean

Mark notification as read/unread

Responses

200 application/json

Updated notification
404

Notification not found

PUT /data/user/notifications/{notification_id}

curl \
 --request PUT 'http://api.example.com/data/user/notifications/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'read=true'

Response examples (200)

{}

Return true if current user has subscribed to given task.

GET /data/user/tasks/{task_id}/subscribed

Jwt authorization

Path parameters

task_id string(uuid) Required

Responses

200 application/json

True if current user has subscribed to given task, False otherwise
404

Task not found

GET /data/user/tasks/{task_id}/subscribed

curl \
 --request GET 'http://api.example.com/data/user/tasks/a24a6ea4-ce75-4665-a070-57453082c25/subscribed' \
 --header "Authorization: $API_KEY"

Response examples (200)

true

Return chats where user is participant.

GET /data/user/chats

Jwt authorization

Responses

200 application/json

Chats where user is participant

GET /data/user/chats

curl \
 --request GET 'http://api.example.com/data/user/chats' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {}
]

Join chat for given entity (be listed as participant).

POST /actions/user/chats/{entity_id}/join

Jwt authorization

Path parameters

entity_id string(uuid) Required

Responses

201 application/json

Chat joined
404

Entity not found

POST /actions/user/chats/{entity_id}/join

curl \
 --request POST 'http://api.example.com/actions/user/chats/a24a6ea4-ce75-4665-a070-57453082c25/join' \
 --header "Authorization: $API_KEY"

Response examples (201)

{}

Leave chat for given entity (be removed from participants).

DELETE /actions/user/chats/{entity_id}/join

Jwt authorization

Path parameters

entity_id string(uuid) Required

Responses

204

Chat left successfully
404

Entity not found

DELETE /actions/user/chats/{entity_id}/join

curl \
 --request DELETE 'http://api.example.com/actions/user/chats/a24a6ea4-ce75-4665-a070-57453082c25/join' \
 --header "Authorization: $API_KEY"

Create a subscription entry for given task and current user. When a user

POST /actions/user/tasks/{task_id}/subscribe

Jwt authorization

subscribes, he gets notified everytime a comment is posted on the task.

POST /actions/user/tasks/{task_id}/subscribe

curl \
 --request POST 'http://api.example.com/actions/user/tasks/a24a6ea4-ce75-4665-a070-57453082c25/subscribe' \
 --header "Authorization: $API_KEY"

Response examples (201)

{}

Remove the subscription entry matching given task and current user.

DELETE /actions/user/tasks/{task_id}/unsubscribe

Jwt authorization

The user will no longer receive notifications for this task.

Path parameters

task_id string(uuid) Required

Responses

204

Subscription entry removed
404

Task not found

DELETE /actions/user/tasks/{task_id}/unsubscribe

curl \
 --request DELETE 'http://api.example.com/actions/user/tasks/a24a6ea4-ce75-4665-a070-57453082c25/unsubscribe' \
 --header "Authorization: $API_KEY"

Set `has_avatar` flag to False for current user and remove its avatar

DELETE /actions/user/clear-avatar

Jwt authorization

file.

Responses

204

Avatar file deleted
404

User not found

DELETE /actions/user/clear-avatar

curl \
 --request DELETE 'http://api.example.com/actions/user/clear-avatar' \
 --header "Authorization: $API_KEY"

Return true if current user has subscribed to given sequence and

GET /data/user/entities/{sequence_id}/task-types/{task_type_id}/subscribed

Jwt authorization

task type.

Path parameters

sequence_id string(uuid) Required
task_type_id string(uuid) Required

Responses

200 application/json

True if current user has subscribed to given sequence and task type, False otherwise
404

Sequence or task type not found

GET /data/user/entities/{sequence_id}/task-types/{task_type_id}/subscribed

curl \
 --request GET 'http://api.example.com/data/user/entities/a24a6ea4-ce75-4665-a070-57453082c25/task-types/a24a6ea4-ce75-4665-a070-57453082c25/subscribed' \
 --header "Authorization: $API_KEY"

Response examples (200)

true

Return the list of sequence ids to which the current user has

GET /data/user/projects/{project_id}/task-types/{task_type_id}/sequence-subscriptions

Jwt authorization

subscribed for given task type.

Path parameters

project_id string(uuid) Required
task_type_id string(uuid) Required

Responses

200 application/json

List of sequence ids to which the current user has subscribed for given task type
404

Project or task type not found

GET /data/user/projects/{project_id}/task-types/{task_type_id}/sequence-subscriptions

curl \
 --request GET 'http://api.example.com/data/user/projects/a24a6ea4-ce75-4665-a070-57453082c25/task-types/a24a6ea4-ce75-4665-a070-57453082c25/sequence-subscriptions' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  "string"
]

Create a subscription entry for given sequence,

POST /actions/user/sequences/{sequence_id}/task-types/{task_type_id}/subscribe

Jwt authorization

task type and current user.

POST /actions/user/sequences/{sequence_id}/task-types/{task_type_id}/subscribe

curl \
 --request POST 'http://api.example.com/actions/user/sequences/a24a6ea4-ce75-4665-a070-57453082c25/task-types/a24a6ea4-ce75-4665-a070-57453082c25/subscribe' \
 --header "Authorization: $API_KEY"

Response examples (201)

{}

Remove a subscription entry for given sequence, tasl type

DELETE /actions/user/sequences/{sequence_id}/task-types/{task_type_id}/unsubscribe

Jwt authorization

and current user.

Path parameters

sequence_id string(uuid) Required
task_type_id string(uuid) Required

Responses

204

Subscription entry removed
404

Sequence or task type not found

DELETE /actions/user/sequences/{sequence_id}/task-types/{task_type_id}/unsubscribe

curl \
 --request DELETE 'http://api.example.com/actions/user/sequences/a24a6ea4-ce75-4665-a070-57453082c25/task-types/a24a6ea4-ce75-4665-a070-57453082c25/unsubscribe' \
 --header "Authorization: $API_KEY"

Mark all notifications as read for the current user.

POST /actions/user/notifications/mark-all-as-read

Jwt authorization

Responses

200 application/json

All notifications marked as read
Hide response attribute Show response attribute object
- success boolean

POST /actions/user/notifications/mark-all-as-read

curl \
 --request POST 'http://api.example.com/actions/user/notifications/mark-all-as-read' \
 --header "Authorization: $API_KEY"

Response examples (200)

{
  "success": true
}

Kitsu API 0.20.73

Welcome to the Kitsu API specification

Authentication

Authentication

Jwt authorization (http_api_key)

Authentication

Log in user by creating and registering auth tokens.

Responses

Log user out by revoking his auth tokens.

Responses

Returns information if the user is authenticated else it returns a 401

Responses

Allow a user to register himself to the service.

Responses

Allow the user to change his password.

Responses

Resource to allow a user to change his password when he forgets it.

Responses

Resource to allow a user to change his password when he forgets it.

Responses

Tokens are considered as outdated every two weeks.

Responses

Resource to allow a user to pre-enable TOTP.

Responses

Resource to allow a user to enable TOTP.

Responses

Resource to allow a user to disable TOTP.

Responses

Resource to send an OTP by email to user.

Responses

Resource to allow a user to pre-enable OTP by email.

Responses

Resource to allow a user to enable OTP by email.

Responses

Resource to allow a user to disable OTP by email.

Responses

Resource to allow a user to generate new recovery codes.

Responses

Resource to get a challenge for a FIDO device.

Responses

Resource to allow a user to pre-register a FIDO device.

Responses

Resource to allow a user to register a FIDO device.

Responses

Resource to allow a user to unregister a FIDO device.

Responses

Resource to allow a user to login with SAML SSO.

Responses

Resource to allow a user to login with SAML SSO.

Responses

Assets

Retrieve all asset types (entity types that are not shot, sequence or episode).

Responses

Retrieve given asset type.

Path parameters

Responses

Retrieve all entities that are not shot, sequence, episode, or edit.

Responses

Retrieve all entities that are not shot, sequence, episode, or edit.

Responses

Retrieve all entities that are not shot, sequence, episode, or edit.

Responses

Retrieve given asset.

Path parameters

Responses

Delete given asset.

Path parameters

Responses

Retrieve all assets linked to given asset.

Path parameters

Responses

Retrieve all tasks related to given asset.

Path parameters

Responses

Retrieve all task types of tasks related to given asset.

Path parameters

Responses

Retrieve the list of shots that cast given asset.

Path parameters

Responses

Kitsu API
0.20.73