Kitsu API
0.20.83

Base URL

http://api.example.com

Welcome to the Kitsu API specification

Version: 0.20.83

The Kitsu API allows to store and manage the data of your animation/VFX production. Through it you can link all the tools of your pipeline and make sure they are all synchronized.

An easy to use Python client to access this API is available: Python Kitsu Client documentation

Authentication

Before you can use any of the endpoints outlined below, you will need to obtain a JWT token to authorize your requests.

You will find detailed information on how to retrieve authentication tokens in the [Zou documentation](https://zou.cg-wire.com/api/).

All API requests require authentication via JWT tokens passed in the Authorization header.

This is version 0.20.83 of this API documentation. Last update on Oct 31, 2025.

This API is provided under license AGPL 3.0.

Authentication

Jwt authorization (http_api_key)

Format in header: Authorization: Bearer {token}.

Value example: Bearer xxxxx.yyyyy.zzzzz

Login user

POST /auth/login

Jwt authorization

Log in user by creating and registering auth tokens. Login is based on email and password. If no user matches given email It fallbacks to a desktop ID. It is useful for desktop tools that don't know user email. It is also possible to login with TOTP, Email OTP, FIDO and recovery code.

application/json

Body Required

email string(email) Required

User email address
password string(password) Required

User password
totp string

TOTP verification code for two-factor authentication
email_otp string

Email OTP verification code for two-factor authentication
fido_authentication_response object

FIDO authentication response for WebAuth
recovery_code string

Recovery code for two-factor authentication

Responses

200

Login successful
400

Login failed

POST /auth/login

curl \
 --request POST 'http://api.example.com/auth/login' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"email":"admin@example.com","password":"mysecretpassword","totp":123456,"email_otp":123456,"fido_authentication_response":{},"recovery_code":"ABCD-EFGH-IJKL-MNOP"}'

Request examples

{
  "email": "admin@example.com",
  "password": "mysecretpassword",
  "totp": 123456,
  "email_otp": 123456,
  "fido_authentication_response": {},
  "recovery_code": "ABCD-EFGH-IJKL-MNOP"
}

Logout user

GET /auth/logout

Jwt authorization

Log user out by revoking auth tokens. Once logged out, current user cannot access the API anymore.

Responses

200

Logout successful

GET /auth/logout

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

Check authentication status

GET /auth/authenticated

Jwt authorization

Returns information if the user is authenticated. It can be used by third party tools, especially browser frontend, to know if current user is still logged in.

Responses

200

User authenticated
401

Person not found

GET /auth/authenticated

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

Register new user

POST /auth/register

Jwt authorization

Allow a user to register himself to the service.

application/json

Body Required

email string(email) Required

User email address
password string(password) Required

User password
password_2 string(password) Required

Password confirmation
first_name string Required

User first name
last_name string Required

User last name

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" \
 --header "Content-Type: application/json" \
 --data '{"email":"admin@example.com","password":"string","password_2":"string","first_name":"string","last_name":"string"}'

Request examples

{
  "email": "admin@example.com",
  "password": "string",
  "password_2": "string",
  "first_name": "string",
  "last_name": "string"
}

Change user password

POST /auth/change-password

Jwt authorization

Allow the user to change his password. Requires current password for verification and password confirmation to ensure accuracy.

application/json

Body Required

old_password string(password) Required

Current password
password string(password) Required

New password
password_2 string(password) Required

New password confirmation

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" \
 --header "Content-Type: application/json" \
 --data '{"old_password":"string","password":"string","password_2":"string"}'

Request examples

{
  "old_password": "string",
  "password": "string",
  "password_2": "string"
}

Reset password with token

PUT /auth/reset-password

Jwt authorization

Allow a user to change his password when he forgets it. It uses a token sent by email to the user to verify it is the user who requested the password reset.

application/json

Body Required

email string(email) Required

User email address
token string(JWT token) Required

Password reset token
password string(password) Required

New password
password2 string(password) Required

New password confirmation

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" \
 --header "Content-Type: application/json" \
 --data '{"email":"admin@example.com","token":"string","password":"string","password2":"string"}'

Request examples

{
  "email": "admin@example.com",
  "token": "string",
  "password": "string",
  "password2": "string"
}

Request password reset

POST /auth/reset-password

Jwt authorization

Send a password reset token by email to the user. It uses a classic scheme where a token is sent by email.

application/json

Body Required

email string(email) Required

User email address

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" \
 --header "Content-Type: application/json" \
 --data '{"email":"admin@example.com"}'

Request examples

{
  "email": "admin@example.com"
}

Refresh access token

GET /auth/refresh-token

Jwt authorization

Tokens are considered outdated every two weeks. This route allows to extend their lifetime 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"

Pre-enable TOTP

PUT /auth/totp

Jwt authorization

Prepare TOTP (Time-based One-Time Password) for enabling. It returns provisioning URI and secret for authenticator app setup.

Responses

200

TOTP pre-enabled
400

TOTP already enabled

PUT /auth/totp

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

Enable TOTP

POST /auth/totp

Jwt authorization

Enable TOTP (Time-based One-Time Password) authentication. It requires verification code from authenticator app.

application/json

Body Required

totp string Required

TOTP verification code from authenticator app

Responses

200

TOTP enabled
400

TOTP already enabled or verification failed

POST /auth/totp

curl \
 --request POST 'http://api.example.com/auth/totp' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"totp":"string"}'

Request examples

{
  "totp": "string"
}

Disable TOTP

DELETE /auth/totp

Jwt authorization

Disable TOTP (Time-based One-Time Password) authentication. It requires two-factor authentication verification.

application/json

Body Required

totp string

TOTP verification code
email_otp string

Email OTP verification code
fido_authentication_response object

FIDO authentication response
recovery_code string

Recovery code for two-factor authentication

Responses

200

TOTP disabled
400

TOTP not enabled or verification failed

DELETE /auth/totp

curl \
 --request DELETE 'http://api.example.com/auth/totp' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"totp":"string","email_otp":"string","fido_authentication_response":{},"recovery_code":"string"}'

Request examples

{
  "totp": "string",
  "email_otp": "string",
  "fido_authentication_response": {},
  "recovery_code": "string"
}

Send email OTP

GET /auth/email-otp

Jwt authorization

Send a one-time password by email to the user for authentication.

Query parameters

email Required

User email address

Responses

200

OTP by email sent
400

OTP by email not enabled

GET /auth/email-otp

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

Pre-enable email OTP

PUT /auth/email-otp

Jwt authorization

Prepare email OTP (One-Time Password) for enabling. It sets up email-based two-factor authentication.

Responses

200

Email OTP pre-enabled
400

Email OTP already enabled

PUT /auth/email-otp

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

Enable email OTP

POST /auth/email-otp

Jwt authorization

Enable email OTP (One-Time Password) authentication. It requires verification code sent to email.

application/json

Body Required

email_otp string Required

Email OTP verification code

Responses

200

Email OTP enabled
400

Email OTP already enabled or verification failed

POST /auth/email-otp

curl \
 --request POST 'http://api.example.com/auth/email-otp' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"email_otp":"string"}'

Request examples

{
  "email_otp": "string"
}

Disable email OTP

DELETE /auth/email-otp

Jwt authorization

Disable email OTP (One-Time Password) authentication. It requires two-factor authentication verification.

application/json

Body Required

totp string

TOTP verification code
email_otp string

Email OTP verification code
fido_authentication_response object

FIDO authentication response
recovery_code string

Recovery code for two-factor authentication

Responses

200

Email OTP disabled
400

Email OTP not enabled or verification failed

DELETE /auth/email-otp

curl \
 --request DELETE 'http://api.example.com/auth/email-otp' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"totp":"string","email_otp":"string","fido_authentication_response":{},"recovery_code":"string"}'

Request examples

{
  "totp": "string",
  "email_otp": "string",
  "fido_authentication_response": {},
  "recovery_code": "string"
}

Generate recovery codes

PUT /auth/recovery-codes

Jwt authorization

Generate new recovery codes for two-factor authentication. It requires two-factor authentication verification.

application/json

Body Required

totp string

TOTP verification code
email_otp string

Email OTP verification code
fido_authentication_response object

FIDO authentication response
recovery_code string

Recovery code for two-factor authentication

Responses

200

New recovery codes generated
400

No two-factor authentication enabled or verification failed

PUT /auth/recovery-codes

curl \
 --request PUT 'http://api.example.com/auth/recovery-codes' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"totp":"string","email_otp":"string","fido_authentication_response":{},"recovery_code":"string"}'

Request examples

{
  "totp": "string",
  "email_otp": "string",
  "fido_authentication_response": {},
  "recovery_code": "string"
}

Get FIDO challenge

GET /auth/fido

Jwt authorization

Get a challenge for FIDO device authentication. It is used for WebAuthn authentication flow.

Query parameters

email Required

User email address

Responses

200

FIDO challenge generated
400

FIDO not enabled

GET /auth/fido

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

Pre-register FIDO device

PUT /auth/fido

Jwt authorization

Prepare FIDO device for registration. It returns registration options for WebAuthn.

Responses

200

FIDO device pre-registered data
400

Invalid request

PUT /auth/fido

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

Register FIDO device

POST /auth/fido

Jwt authorization

Register a FIDO device for WebAuthn authentication. It requires registration response from the device.

application/json

Body Required

registration_response object Required

FIDO device registration response
device_name string Required

Name for the FIDO device

Responses

200

FIDO device registered
400

Registration failed or no preregistration

POST /auth/fido

curl \
 --request POST 'http://api.example.com/auth/fido' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"registration_response":{},"device_name":"string"}'

Request examples

{
  "registration_response": {},
  "device_name": "string"
}

Unregister FIDO device

DELETE /auth/fido

Jwt authorization

Unregister a FIDO device from WebAuthn authentication. It requires two-factor authentication verification.

application/json

Body Required

totp string

TOTP verification code
email_otp string

Email OTP verification code
fido_authentication_response object

FIDO authentication response
recovery_code string

Recovery code for two-factor authentication
device_name string Required

Name of the FIDO device to unregister

Responses

200

FIDO device unregistered
400

FIDO not enabled or verification failed

DELETE /auth/fido

curl \
 --request DELETE 'http://api.example.com/auth/fido' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"totp":"string","email_otp":"string","fido_authentication_response":{},"recovery_code":"string","device_name":"string"}'

Request examples

{
  "totp": "string",
  "email_otp": "string",
  "fido_authentication_response": {},
  "recovery_code": "string",
  "device_name": "string"
}

SAML SSO login

POST /auth/saml/sso

Jwt authorization

Handle SAML SSO login response. Processes authentication response from SAML identity provider and creates a new user if they don't exist.

Responses

302

Login successful, redirect to home page
400

SAML not enabled or wrong parameter

POST /auth/saml/sso

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

SAML SSO login redirect

GET /auth/saml/login

Jwt authorization

Initiate SAML SSO login by redirecting to SAML identity provider.

Responses

302

Redirect to SAML identity provider
400

SAML not enabled or wrong parameter

GET /auth/saml/login

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

Get asset types

GET /data/asset-types

Jwt authorization

Retrieve all available asset types (entity types that are not shot, sequence, or episode) with filtering support

Query parameters

project_id

Filter asset types by project

Responses

200 application/json

List of asset types successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Asset type unique identifier
- name string
  
  Asset type name
- created_at string(date-time)
  
  Creation timestamp
- updated_at string(date-time)
  
  Last update timestamp

GET /data/asset-types

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

Response examples (200)

[
  {
    "id": "c46c8gc6-eg97-6887-c292-79675204e47",
    "name": "Character",
    "created_at": "2023-01-01T12:00:00Z",
    "updated_at": "2023-01-01T12:30:00Z"
  }
]

Get asset type

GET /data/asset-types/{asset_type_id}

Jwt authorization

Retrieve detailed information about a specific asset type including metadata and configuration

Path parameters

asset_type_id Required

Unique identifier of the asset type

Responses

200 application/json

Given asset type
Hide response attributes Show response attributes object
- id string(uuid)
  
  Asset type unique identifier
- name string
  
  Asset type name
- created_at string(date-time)
  
  Creation timestamp
- updated_at string(date-time)
  
  Last update timestamp

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"

Response examples (200)

{
  "id": "c46c8gc6-eg97-6887-c292-79675204e47",
  "name": "Character",
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-01-01T12:30:00Z"
}

Get all assets

GET /data/assets

Jwt authorization

Retrieve all production assets with filtering and pagination. Supports advanced filtering by project, asset type, task status, and other criteria

Query parameters

project_id

Filter assets by specific project
asset_type_id

Filter assets by asset type
page

Page number for pagination
limit

Number of assets per page

Responses

200 application/json

List of assets successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Asset unique identifier
- name string
  
  Asset name
- project_id string(uuid)
  
  Project identifier
- entity_type_id string(uuid)
  
  Asset type identifier
- project_name string
  
  Project name
- asset_type_name string
  
  Asset type name

GET /data/assets

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

Response examples (200)

[
  {
    "id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "name": "Character Name",
    "project_id": "b35b7fb5-df86-5776-b181-68564193d36",
    "entity_type_id": "c46c8gc6-eg97-6887-c292-79675204e47",
    "project_name": "My Project",
    "asset_type_name": "Character"
  }
]

Get all assets

GET /data/assets/all

Jwt authorization

Retrieve all production assets with filtering and pagination. Supports advanced filtering by project, asset type, task status, and other criteria

Query parameters

project_id

Filter assets by specific project
asset_type_id

Filter assets by asset type
page

Page number for pagination
limit

Number of assets per page

Responses

200 application/json

List of assets successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Asset unique identifier
- name string
  
  Asset name
- project_id string(uuid)
  
  Project identifier
- entity_type_id string(uuid)
  
  Asset type identifier
- project_name string
  
  Project name
- asset_type_name string
  
  Asset type name

GET /data/assets/all

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

Response examples (200)

[
  {
    "id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "name": "Character Name",
    "project_id": "b35b7fb5-df86-5776-b181-68564193d36",
    "entity_type_id": "c46c8gc6-eg97-6887-c292-79675204e47",
    "project_name": "My Project",
    "asset_type_name": "Character"
  }
]

Get assets with tasks

GET /data/assets/with-tasks

Jwt authorization

Retrieve all production assets with their related tasks. Includes project name, asset type name, and all associated tasks. Supports filtering by episode

Query parameters

project_id

Filter assets by specific project
episode_id

Filter assets by episode (returns assets not linked to episode and assets linked to given episode)
asset_type_id

Filter assets by asset type

Responses

200 application/json

List of assets with tasks successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Asset unique identifier
- name string
  
  Asset name
- project_id string(uuid)
  
  Project identifier
- entity_type_id string(uuid)
  
  Asset type identifier
- project_name string
  
  Project name
- asset_type_name string
  
  Asset type name
- tasks array[object]
  
  Array of related tasks

GET /data/assets/with-tasks

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

Response examples (200)

[
  {
    "id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "name": "Character Name",
    "project_id": "b35b7fb5-df86-5776-b181-68564193d36",
    "entity_type_id": "c46c8gc6-eg97-6887-c292-79675204e47",
    "project_name": "My Project",
    "asset_type_name": "Character",
    "tasks": [
      {}
    ]
  }
]

Get asset

GET /data/assets/{asset_id}

Jwt authorization

Retrieve detailed information about a specific asset including metadata, project context, and related data

Path parameters

asset_id Required

Unique identifier of the asset

Responses

200 application/json

Asset information successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Asset unique identifier
- name string
  
  Asset name
- project_id string(uuid)
  
  Project identifier
- entity_type_id string(uuid)
  
  Asset type identifier
- created_at string(date-time)
  
  Creation timestamp
- updated_at string(date-time)
  
  Last update timestamp

GET /data/assets/{asset_id}

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

Response examples (200)

{
  "id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "name": "Character Name",
  "project_id": "b35b7fb5-df86-5776-b181-68564193d36",
  "entity_type_id": "c46c8gc6-eg97-6887-c292-79675204e47",
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-01-01T12:30:00Z"
}

Delete asset

DELETE /data/assets/{asset_id}

Jwt authorization

Permanently remove an asset from the system. Only asset creators or project managers can delete assets

Path parameters

asset_id Required

Unique identifier of the asset to delete

Query parameters

force

Force deletion bypassing validation checks

Responses

204

Asset successfully deleted

DELETE /data/assets/{asset_id}

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

Get linked assets

GET /data/assets/{asset_id}/assets

Jwt authorization

Retrieve all assets that are linked to a specific asset through casting relationships

Path parameters

asset_id Required

Unique identifier of the asset

Responses

200 application/json

List of linked assets successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Linked asset unique identifier
- name string
  
  Linked asset name
- project_id string(uuid)
  
  Project identifier
- entity_type_id string(uuid)
  
  Asset type identifier

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"

Response examples (200)

[
  {
    "id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "name": "Character Name",
    "project_id": "b35b7fb5-df86-5776-b181-68564193d36",
    "entity_type_id": "c46c8gc6-eg97-6887-c292-79675204e47"
  }
]

Get asset tasks

GET /data/assets/{asset_id}/tasks

Jwt authorization

Retrieve all tasks related to a specific asset.

Path parameters

asset_id Required

Unique identifier of the asset

Query parameters

task_type_id

Filter tasks by task type
task_status_id

Filter tasks by task status

Responses

200 application/json

List of asset tasks successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Task unique identifier
- name string
  
  Task name
- task_type_id string(uuid)
  
  Task type identifier
- task_status_id string(uuid)
  
  Task status identifier
- entity_id string(uuid)
  
  Asset identifier
- assigned_to string(uuid)
  
  Assigned user identifier
- created_at string(date-time)
  
  Creation timestamp
- updated_at string(date-time)
  
  Last update timestamp

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"

Response examples (200)

[
  {
    "id": "e68e0ie8-gi19-8009-e514-91897426g69",
    "name": "Modeling Task",
    "task_type_id": "f79f1jf9-hj20-9110-f625-02908537h70",
    "task_status_id": "g80g2kg0-ik31-0221-g736-13019648i81",
    "entity_id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "assigned_to": "h91h3lh1-jl42-1332-h847-24120759j92",
    "created_at": "2023-01-01T12:00:00Z",
    "updated_at": "2023-01-01T12:30:00Z"
  }
]

Get asset task types

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

Jwt authorization

Retrieve all task types that are used for tasks related to a specific asset.

Path parameters

asset_id Required

Unique identifier of the asset

Responses

200 application/json

List of asset task types successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Task type unique identifier
- name string
  
  Task type name
- short_name string
  
  Task type short name
- color string
  
  Task type color code
- for_entity string
  
  Entity type this task type is for

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"

Response examples (200)

[
  {
    "id": "f79f1jf9-hj20-9110-f625-02908537h70",
    "name": "Modeling",
    "short_name": "MOD",
    "color": "#FF5733",
    "for_entity": "Asset"
  }
]

Get shots casting asset

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

Jwt authorization

Retrieve all shots that cast a specific asset in their breakdown.

Path parameters

asset_id Required

Unique identifier of the asset

Responses

200 application/json

List of shots casting the asset successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Shot unique identifier
- name string
  
  Shot name
- project_id string(uuid)
  
  Project identifier
- sequence_id string(uuid)
  
  Sequence identifier
- frame_in integer
  
  Frame in
- frame_out integer
  
  Frame out
- duration integer
  
  Shot duration in frames

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"

Response examples (200)

[
  {
    "id": "d57d9hd7-fh08-7998-d403-80786315f58",
    "name": "SH001",
    "project_id": "b35b7fb5-df86-5776-b181-68564193d36",
    "sequence_id": "e68e0ie8-gi19-8009-e514-91897426g69",
    "frame_in": 100,
    "frame_out": 200,
    "duration": 100
  }
]

Get asset casting

GET /data/assets/{asset_id}/casting

Jwt authorization

Retrieve the casting information for a specific asset showing which shots or sequences use this asset

Path parameters

asset_id Required

Unique identifier of the asset

Responses

200 application/json

Asset casting information successfully retrieved
Hide response attributes Show response attributes object
- asset_id string(uuid)
  
  Asset unique identifier
- casting array[object]
  
  Hide casting attributes Show casting attributes object
  
  id string(uuid)
  
  Casting entry unique identifier
  
  entity_id string(uuid)
  
  Entity identifier (shot/sequence)
  
  entity_name string
  
  Entity name
  
  entity_type string
  
  Entity type (shot/sequence)

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"

Response examples (200)

{
  "asset_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "casting": [
    {
      "id": "b35b7fb5-df86-5776-b181-68564193d36",
      "entity_id": "d57d9hd7-fh08-7998-d403-80786315f58",
      "entity_name": "SH001",
      "entity_type": "shot"
    }
  ]
}

Update asset casting

PUT /data/assets/{asset_id}/casting

Jwt authorization

Modify the casting relationships for a specific asset by updating which shots or sequences use this asset.

Path parameters

asset_id Required

Unique identifier of the asset

application/json

Body Required

casting array[object]
Hide casting attributes Show casting attributes object
- entity_id string(uuid)
  
  Entity identifier to cast
- entity_type string
  
  Entity type (shot/sequence)

Responses

200 application/json

Asset casting successfully updated
Hide response attributes Show response attributes object
- asset_id string(uuid)
  
  Asset unique identifier
- casting array[object]
  
  Hide casting attributes Show casting attributes object
  
  id string(uuid)
  
  Casting entry unique identifier
  
  entity_id string(uuid)
  
  Entity identifier
  
  entity_name string
  
  Entity name

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" \
 --data '{"casting":[{"entity_id":"d57d9hd7-fh08-7998-d403-80786315f58","entity_type":"shot"}]}'

Request examples

{
  "casting": [
    {
      "entity_id": "d57d9hd7-fh08-7998-d403-80786315f58",
      "entity_type": "shot"
    }
  ]
}

Response examples (200)

{
  "asset_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "casting": [
    {
      "id": "b35b7fb5-df86-5776-b181-68564193d36",
      "entity_id": "d57d9hd7-fh08-7998-d403-80786315f58",
      "entity_name": "SH001"
    }
  ]
}

Get shot asset instances

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

Jwt authorization

Retrieve all shot asset instances that are linked to a specific asset.

Path parameters

asset_id Required

Unique identifier of the asset

Responses

200 application/json

List of shot asset instances successfully retrieved.
Hide response attributes Show response attributes object
- id string(uuid)
  
  Asset instance unique identifier
- asset_id string(uuid)
  
  Asset identifier
- shot_id string(uuid)
  
  Shot identifier
- number string
  
  Instance number
- description string
  
  Instance description

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"

Response examples (200)

[
  {
    "id": "f79f1jf9-hj20-9110-f625-02908537h70",
    "asset_id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "shot_id": "d57d9hd7-fh08-7998-d403-80786315f58",
    "number": "001",
    "description": "Main character instance"
  }
]

Get scene asset instances

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

Jwt authorization

Retrieve all scene asset instances that are linked to a specific asset.

Path parameters

asset_id Required

Unique identifier of the asset

Responses

200 application/json

List of scene asset instances successfully retrieved.
Hide response attributes Show response attributes object
- id string(uuid)
  
  Asset instance unique identifier
- asset_id string(uuid)
  
  Asset identifier
- scene_id string(uuid)
  
  Scene identifier
- number string
  
  Instance number
- description string
  
  Instance description

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"

Response examples (200)

[
  {
    "id": "f79f1jf9-hj20-9110-f625-02908537h70",
    "asset_id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "scene_id": "g80g2kg0-ik31-0221-g736-13019648i81",
    "number": "001",
    "description": "Main character instance"
  }
]

Get asset instances

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

Jwt authorization

Retrieve all asset instances that are instantiated inside a specific asset.

Path parameters

asset_id Required

Unique identifier of the asset

Responses

200 application/json

List of asset instances successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Asset instance unique identifier
- asset_id string(uuid)
  
  Parent asset identifier
- target_asset_id string(uuid)
  
  Target asset identifier
- number string
  
  Instance number
- description string
  
  Instance description

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"

Response examples (200)

[
  {
    "id": "f79f1jf9-hj20-9110-f625-02908537h70",
    "asset_id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "target_asset_id": "b35b7fb5-df86-5776-b181-68564193d36",
    "number": "001",
    "description": "Main character instance"
  }
]

Create asset instance

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

Jwt authorization

Create a new asset instance inside a specific asset by instantiating another asset.

Path parameters

asset_id Required

Unique identifier of the parent asset

application/json

Body Required

asset_to_instantiate_id string(uuid) Required

Unique identifier of the asset to instantiate
description string

Description for the asset instance

Responses

201 application/json

Asset instance successfully created
Hide response attributes Show response attributes object
- id string(uuid)
  
  Created asset instance unique identifier
- asset_id string(uuid)
  
  Parent asset identifier
- target_asset_id string(uuid)
  
  Target asset identifier
- number string
  
  Instance number
- description string
  
  Instance description
- created_at string(date-time)
  
  Creation timestamp

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"
}

Response examples (201)

{
  "id": "f79f1jf9-hj20-9110-f625-02908537h70",
  "asset_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "target_asset_id": "b35b7fb5-df86-5776-b181-68564193d36",
  "number": "001",
  "description": "Main character instance",
  "created_at": "2023-01-01T12:00:00Z"
}

Get project asset type assets

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

Jwt authorization

Retrieve all assets of a specific type within a project.

Path parameters

project_id Required

Unique identifier of the project
asset_type_id Required

Unique identifier of the asset type

Query parameters

page

Page number for pagination
limit

Number of assets per page

Responses

200 application/json

List of project asset type assets successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Asset unique identifier
- name string
  
  Asset name
- project_id string(uuid)
  
  Project identifier
- entity_type_id string(uuid)
  
  Asset type identifier
- project_name string
  
  Project name
- asset_type_name string
  
  Asset type name

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"

Response examples (200)

[
  {
    "id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "name": "Character Name",
    "project_id": "b35b7fb5-df86-5776-b181-68564193d36",
    "entity_type_id": "c46c8gc6-eg97-6887-c292-79675204e47",
    "project_name": "My Project",
    "asset_type_name": "Character"
  }
]

Create asset

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

Jwt authorization

Create a new asset in a specific project with the given asset type and parameters.

Path parameters

project_id Required

Unique identifier of the project
asset_type_id Required

Unique identifier of the asset type

application/json

Body Required

name string Required

Asset name
description string Required

Asset description
data object Required

Asset metadata and custom data
is_shared boolean Required

Whether the asset is shared across projects
source_id string(uuid) Required

Source asset identifier for duplication
episode_id string(uuid)

Episode identifier for episodic assets

Responses

201 application/json

Asset successfully created
Hide response attributes Show response attributes object
- id string(uuid)
  
  Created asset unique identifier
- name string
  
  Asset name
- description string
  
  Asset description
- project_id string(uuid)
  
  Project identifier
- entity_type_id string(uuid)
  
  Asset type identifier
- created_at string(date-time)
  
  Creation timestamp
- updated_at string(date-time)
  
  Last update timestamp

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":[{"atmsophere":"sunny","difficulty":"easy"}],"is_shared":false,"source_id":"a24a6ea4-ce75-4665-a070-57453082c25","episode_id":"a24a6ea4-ce75-4665-a070-57453082c25"}'

Request examples

{
  "name": "Character Name",
  "description": "Main character",
  "data": [
    {
      "atmsophere": "sunny",
      "difficulty": "easy"
    }
  ],
  "is_shared": false,
  "source_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "episode_id": "a24a6ea4-ce75-4665-a070-57453082c25"
}

Response examples (201)

{
  "id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "name": "Character Name",
  "description": "Main character",
  "project_id": "b35b7fb5-df86-5776-b181-68564193d36",
  "entity_type_id": "c46c8gc6-eg97-6887-c292-79675204e47",
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-01-01T12:30:00Z"
}

Get project asset types

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

Jwt authorization

Retrieve all asset types available for a specific project

Path parameters

project_id Required

Unique identifier of the project

Responses

200 application/json

List of project asset types successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Asset type unique identifier
- name string
  
  Asset type name
- project_id string(uuid)
  
  Project identifier

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"

Response examples (200)

[
  {
    "id": "c46c8gc6-eg97-6887-c292-79675204e47",
    "name": "Character",
    "project_id": "b35b7fb5-df86-5776-b181-68564193d36"
  }
]

Get shot asset types

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

Jwt authorization

Retrieve all asset types of assets that are casted in a specific shot

Path parameters

shot_id Required

Unique identifier of the shot

Responses

200 application/json

List of shot asset types successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Asset type unique identifier
- name string
  
  Asset type name
- shot_id string(uuid)
  
  Shot identifier

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"

Response examples (200)

[
  {
    "id": "c46c8gc6-eg97-6887-c292-79675204e47",
    "name": "Character",
    "shot_id": "d57d9hd7-fh08-7998-d403-80786315f58"
  }
]

Get project assets

GET /data/projects/{project_id}/assets

Jwt authorization

Retrieve all assets belonging to a specific project with filtering support

Path parameters

project_id Required

Unique identifier of the project

Query parameters

asset_type_id

Filter assets by asset type
page

Page number for pagination
limit

Number of assets per page

Responses

200 application/json

List of project assets successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Asset unique identifier
- name string
  
  Asset name
- project_id string(uuid)
  
  Project identifier
- entity_type_id string(uuid)
  
  Asset type identifier
- project_name string
  
  Project name
- asset_type_name string
  
  Asset type name

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"

Response examples (200)

[
  {
    "id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "name": "Character Name",
    "project_id": "b35b7fb5-df86-5776-b181-68564193d36",
    "entity_type_id": "c46c8gc6-eg97-6887-c292-79675204e47",
    "project_name": "My Project",
    "asset_type_name": "Character"
  }
]

Set assets shared

POST /actions/assets/share

Jwt authorization

Share or unshare a specific list of assets by their IDs.

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","b35b7fb5-df86-5776-b181-68564193d36"],"is_shared":true}'

Request examples

{
  "asset_ids": [
    "a24a6ea4-ce75-4665-a070-57453082c25",
    "b35b7fb5-df86-5776-b181-68564193d36"
  ],
  "is_shared": true
}

Response examples (200)

{
  "updated_count": 2,
  "asset_ids": [
    "a24a6ea4-ce75-4665-a070-57453082c25",
    "b35b7fb5-df86-5776-b181-68564193d36"
  ]
}

Set project assets shared

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

Jwt authorization

Share or unshare all assets for a specific project or a list of specific assets.

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 '{"is_shared":true,"asset_ids":["a24a6ea4-ce75-4665-a070-57453082c25","b35b7fb5-df86-5776-b181-68564193d36"]}'

Request examples

{
  "is_shared": true,
  "asset_ids": [
    "a24a6ea4-ce75-4665-a070-57453082c25",
    "b35b7fb5-df86-5776-b181-68564193d36"
  ]
}

Response examples (200)

{
  "updated_count": 5,
  "project_id": "b35b7fb5-df86-5776-b181-68564193d36"
}

Set asset type assets shared

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

Jwt authorization

Share or unshare all assets for a specific project and asset type.

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
}

Response examples (200)

{
  "updated_count": 3,
  "project_id": "b35b7fb5-df86-5776-b181-68564193d36",
  "asset_type_id": "c46c8gc6-eg97-6887-c292-79675204e47"
}

Get shared assets used in project

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

Jwt authorization

Retrieve all shared assets that are used in a specific project.

Path parameters

project_id Required

Unique identifier of the project

Responses

200 application/json

List of shared assets used in project successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Asset unique identifier
- name string
  
  Asset name
- project_id string(uuid)
  
  Original project identifier
- entity_type_id string(uuid)
  
  Asset type identifier
- is_shared boolean
  
  Whether the asset is shared

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"

Response examples (200)

[
  {
    "id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "name": "Character Name",
    "project_id": "b35b7fb5-df86-5776-b181-68564193d36",
    "entity_type_id": "c46c8gc6-eg97-6887-c292-79675204e47",
    "is_shared": true
  }
]

Get shared assets used in episode

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

Jwt authorization

Retrieve all shared assets that are used in a specific project episode.

Path parameters

project_id Required

Unique identifier of the project
episode_id Required

Unique identifier of the episode

Responses

200 application/json

List of shared assets used in episode successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Asset unique identifier
- name string
  
  Asset name
- project_id string(uuid)
  
  Original project identifier
- entity_type_id string(uuid)
  
  Asset type identifier
- is_shared boolean
  
  Whether the asset is shared
- episode_id string(uuid)
  
  Episode identifier

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"

Response examples (200)

[
  {
    "id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "name": "Character Name",
    "project_id": "b35b7fb5-df86-5776-b181-68564193d36",
    "entity_type_id": "c46c8gc6-eg97-6887-c292-79675204e47",
    "is_shared": true,
    "episode_id": "d57d9hd7-fh08-7998-d403-80786315f58"
  }
]

Get entity casting

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

Jwt authorization

Retrieve the casting information for a specific entity showing which assets are linked to it.

Path parameters

project_id Required

Unique identifier of the project
entity_id Required

Unique identifier of the entity

Responses

200 application/json

Entity casting information successfully retrieved
Hide response attributes Show response attributes object
- entity_id string(uuid)
  
  Entity unique identifier
- casting array[object]
  
  Hide casting attributes Show casting attributes object
  
  id string(uuid)
  
  Casting entry unique identifier
  
  asset_id string(uuid)
  
  Asset identifier
  
  asset_name string
  
  Asset name

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"

Response examples (200)

{
  "entity_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "casting": [
    {
      "id": "b35b7fb5-df86-5776-b181-68564193d36",
      "asset_id": "c46c8gc6-eg97-6887-c292-79675204e47",
      "asset_name": "Main Character"
    }
  ]
}

Update entity casting

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

Jwt authorization

Modify the casting relationships for a specific entity by updating which assets are linked to it.

Path parameters

project_id Required

Unique identifier of the project
entity_id Required

Unique identifier of the entity

application/json

Body Required

casting array[object]
Hide casting attributes Show casting attributes object
- asset_id string(uuid)
  
  Asset identifier to link
- asset_name string
  
  Asset name

Responses

200 application/json

Entity casting successfully updated
Hide response attributes Show response attributes object
- entity_id string(uuid)
  
  Entity unique identifier
- casting array[object]
  
  Hide casting attributes Show casting attributes object
  
  id string(uuid)
  
  Casting entry unique identifier
  
  asset_id string(uuid)
  
  Asset identifier
  
  asset_name string
  
  Asset name

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" \
 --header "Content-Type: application/json" \
 --data '{"casting":[{"asset_id":"c46c8gc6-eg97-6887-c292-79675204e47","asset_name":"Main Character"}]}'

Request examples

{
  "casting": [
    {
      "asset_id": "c46c8gc6-eg97-6887-c292-79675204e47",
      "asset_name": "Main Character"
    }
  ]
}

Response examples (200)

{
  "entity_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "casting": [
    {
      "id": "b35b7fb5-df86-5776-b181-68564193d36",
      "asset_id": "c46c8gc6-eg97-6887-c292-79675204e47",
      "asset_name": "Main Character"
    }
  ]
}

Get asset type casting

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

Jwt authorization

Retrieve the casting information for all assets of a specific asset type in a project.

Path parameters

project_id Required

Unique identifier of the project
asset_type_id Required

Unique identifier of the asset type

Responses

200 application/json

Asset type casting information successfully retrieved
Hide response attributes Show response attributes object
- asset_id string(uuid)
  
  Asset unique identifier
- asset_name string
  
  Asset name
- asset_type_id string(uuid)
  
  Asset type identifier
- casting array[object]
  
  Hide casting attributes Show casting attributes object
  
  entity_id string(uuid)
  
  Entity identifier
  
  entity_name string
  
  Entity name
  
  entity_type string
  
  Entity type (shot/sequence)

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/g80g2kg0-ik31-0221-g736-13019648i81/casting' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {
    "asset_id": "c46c8gc6-eg97-6887-c292-79675204e47",
    "asset_name": "Main Character",
    "asset_type_id": "g80g2kg0-ik31-0221-g736-13019648i81",
    "casting": [
      {
        "entity_id": "e68e0ie8-gi19-8009-e514-91897426g69",
        "entity_name": "SH001",
        "entity_type": "shot"
      }
    ]
  }
]

Get episodes casting

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

Jwt authorization

Retrieve the casting information for all episodes in a specific project.

Path parameters

project_id Required

Unique identifier of the project

Responses

200 application/json

Episodes casting information successfully retrieved
Hide response attributes Show response attributes object
- episode_id string(uuid)
  
  Episode unique identifier
- episode_name string
  
  Episode name
- casting array[object]
  
  Hide casting attributes Show casting attributes object
  
  asset_id string(uuid)
  
  Asset identifier
  
  asset_name string
  
  Asset name

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"

Response examples (200)

[
  {
    "episode_id": "d57d9hd7-fh08-7998-d403-80786315f58",
    "episode_name": "Episode 01",
    "casting": [
      {
        "asset_id": "c46c8gc6-eg97-6887-c292-79675204e47",
        "asset_name": "Main Character"
      }
    ]
  }
]

Get sequence shots casting

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

Jwt authorization

Retrieve the casting information for all shots from a specific sequence.

Path parameters

project_id Required

Unique identifier of the project
sequence_id Required

Unique identifier of the sequence

Responses

200 application/json

Sequence shots casting information successfully retrieved
Hide response attributes Show response attributes object
- shot_id string(uuid)
  
  Shot unique identifier
- shot_name string
  
  Shot name
- sequence_id string(uuid)
  
  Sequence identifier
- casting array[object]
  
  Hide casting attributes Show casting attributes object
  
  asset_id string(uuid)
  
  Asset identifier
  
  asset_name string
  
  Asset name

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

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

Response examples (200)

[
  {
    "shot_id": "e68e0ie8-gi19-8009-e514-91897426g69",
    "shot_name": "SH001",
    "sequence_id": "f79f1jf9-hj20-9110-f625-02908537h70",
    "casting": [
      {
        "asset_id": "c46c8gc6-eg97-6887-c292-79675204e47",
        "asset_name": "Main Character"
      }
    ]
  }
]

Get episode shots casting

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

Jwt authorization

Retrieve the casting information for all shots from a specific episode.

Path parameters

project_id Required

Unique identifier of the project
episode_id Required

Unique identifier of the episode

Responses

200 application/json

Episode shots casting information successfully retrieved
Hide response attributes Show response attributes object
- shot_id string(uuid)
  
  Shot unique identifier
- shot_name string
  
  Shot name
- casting array[object]
  
  Hide casting attributes Show casting attributes object
  
  asset_id string(uuid)
  
  Asset identifier
  
  asset_name string
  
  Asset name

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/d57d9hd7-fh08-7998-d403-80786315f58/sequences/all/casting' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {
    "shot_id": "e68e0ie8-gi19-8009-e514-91897426g69",
    "shot_name": "SH001",
    "casting": [
      {
        "asset_id": "c46c8gc6-eg97-6887-c292-79675204e47",
        "asset_name": "Main Character"
      }
    ]
  }
]

Get project shots casting

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

Jwt authorization

Retrieve the casting information for all shots from all sequences in a specific project.

Path parameters

project_id Required

Unique identifier of the project

Responses

200 application/json

Project shots casting information successfully retrieved
Hide response attributes Show response attributes object
- shot_id string(uuid)
  
  Shot unique identifier
- shot_name string
  
  Shot name
- sequence_id string(uuid)
  
  Sequence identifier
- sequence_name string
  
  Sequence name
- casting array[object]
  
  Hide casting attributes Show casting attributes object
  
  asset_id string(uuid)
  
  Asset identifier
  
  asset_name string
  
  Asset name

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"

Response examples (200)

[
  {
    "shot_id": "e68e0ie8-gi19-8009-e514-91897426g69",
    "shot_name": "SH001",
    "sequence_id": "f79f1jf9-hj20-9110-f625-02908537h70",
    "sequence_name": "SEQ01",
    "casting": [
      {
        "asset_id": "c46c8gc6-eg97-6887-c292-79675204e47",
        "asset_name": "Main Character"
      }
    ]
  }
]

Get project entity links

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

Jwt authorization

Retrieve all entity links related to a specific project. Results can be paginated using page and limit query parameters. If you prefer a more accurate pagination, you can use cursor_created_at to get the next page. It's mainly used for synchronisation purpose.

Path parameters

project_id Required

Unique identifier of the project

Query parameters

page

Page number for pagination
limit

Number of items per page
cursor_created_at

Cursor for pagination based on creation date

Responses

200 application/json

Project entity links successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Entity link unique identifier
- entity_in_id string(uuid)
  
  Source entity identifier
- entity_out_id string(uuid)
  
  Target entity identifier
- created_at string(date-time)
  
  Creation timestamp

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"

Response examples (200)

[
  {
    "id": "m46m8qm6-oq97-6887-m403-80786315o47",
    "entity_in_id": "c46c8gc6-eg97-6887-c292-79675204e47",
    "entity_out_id": "d57d9hd7-fh08-7998-d403-80786315f58",
    "created_at": "2020-01-01T00:00:00"
  }
]

Delete entity link

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

Jwt authorization

Delete a specific entity link. It's mainly used for synchronisation purpose.

Path parameters

project_id Required

Unique identifier of the project
entity_link_id Required

Unique identifier of the entity link

Responses

200

Entity link successfully 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/m46m8qm6-oq97-6887-m403-80786315o47' \
 --header "Authorization: $API_KEY"

Get scene asset instances

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

Jwt authorization

Retrieve all asset instances that are linked to a specific scene.

Path parameters

scene_id Required

Unique identifier of the scene

Responses

200 application/json

Scene asset instances successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Asset instance unique identifier
- asset_id string(uuid)
  
  Asset identifier
- scene_id string(uuid)
  
  Scene identifier
- number string
  
  Instance number
- description string
  
  Instance description

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

curl \
 --request GET 'http://api.example.com/data/scenes/i02i4mi2-km53-2443-i958-35231870k03/asset-instances' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {
    "id": "j13j5nj3-ln64-3554-j069-46342981l14",
    "asset_id": "c46c8gc6-eg97-6887-c292-79675204e47",
    "scene_id": "i02i4mi2-km53-2443-i958-35231870k03",
    "number": "001",
    "description": "Main character instance"
  }
]

Create scene asset instance

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

Jwt authorization

Create an asset instance on a specific scene.

Path parameters

scene_id Required

Unique identifier of the scene

application/json

Body Required

asset_id string(uuid) Required

Asset identifier to create instance from
description string

Instance description

Responses

201 application/json

Asset instance successfully created on scene
Hide response attributes Show response attributes object
- id string(uuid)
  
  Asset instance unique identifier
- asset_id string(uuid)
  
  Asset identifier
- scene_id string(uuid)
  
  Scene identifier
- number string
  
  Instance number
- description string
  
  Instance description

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

curl \
 --request POST 'http://api.example.com/data/scenes/i02i4mi2-km53-2443-i958-35231870k03/asset-instances' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"asset_id":"c46c8gc6-eg97-6887-c292-79675204e47","description":"Main character instance"}'

Request examples

{
  "asset_id": "c46c8gc6-eg97-6887-c292-79675204e47",
  "description": "Main character instance"
}

Response examples (201)

{
  "id": "j13j5nj3-ln64-3554-j069-46342981l14",
  "asset_id": "c46c8gc6-eg97-6887-c292-79675204e47",
  "scene_id": "i02i4mi2-km53-2443-i958-35231870k03",
  "number": "001",
  "description": "Main character instance"
}

Get scene camera instances

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

Jwt authorization

Retrieve all camera instances that are linked to a specific scene.

Path parameters

scene_id Required

Unique identifier of the scene

Responses

200 application/json

Scene camera instances successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Camera instance unique identifier
- camera_id string(uuid)
  
  Camera identifier
- scene_id string(uuid)
  
  Scene identifier
- number string
  
  Instance number
- description string
  
  Instance description

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

curl \
 --request GET 'http://api.example.com/data/scenes/i02i4mi2-km53-2443-i958-35231870k03/camera-instances' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {
    "id": "k24k6ok4-mo75-4665-k180-57453082m25",
    "camera_id": "l35l7pl5-np86-5776-l291-68564193n36",
    "scene_id": "i02i4mi2-km53-2443-i958-35231870k03",
    "number": "001",
    "description": "Main camera instance"
  }
]

Get shot asset instances

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

Jwt authorization

Retrieve all asset instances that are linked to a specific shot.

Path parameters

shot_id Required

Unique identifier of the shot

Responses

200 application/json

Shot asset instances successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Asset instance unique identifier
- asset_id string(uuid)
  
  Asset identifier
- shot_id string(uuid)
  
  Shot identifier
- number string
  
  Instance number
- description string
  
  Instance description

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

curl \
 --request GET 'http://api.example.com/data/shots/e68e0ie8-gi19-8009-e514-91897426g69/asset-instances' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {
    "id": "h91h3lh1-jl42-1332-h847-24120759j92",
    "asset_id": "c46c8gc6-eg97-6887-c292-79675204e47",
    "shot_id": "e68e0ie8-gi19-8009-e514-91897426g69",
    "number": "001",
    "description": "Main character instance"
  }
]

Add shot asset instance

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

Jwt authorization

Add an asset instance to a specific shot.

Path parameters

shot_id Required

Unique identifier of the shot

application/json

Body Required

asset_instance_id string(uuid) Required

Asset instance identifier to add

Responses

201 application/json

Asset instance successfully added to shot
Hide response attributes Show response attributes object
- id string(uuid)
  
  Shot unique identifier
- name string
  
  Shot name
- asset_instances array[object]
  
  Hide asset_instances attributes Show asset_instances attributes object
  
  id string(uuid)
  
  Asset instance unique identifier
  
  asset_id string(uuid)
  
  Asset identifier

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

curl \
 --request POST 'http://api.example.com/data/shots/e68e0ie8-gi19-8009-e514-91897426g69/asset-instances' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"asset_instance_id":"h91h3lh1-jl42-1332-h847-24120759j92"}'

Request examples

{
  "asset_instance_id": "h91h3lh1-jl42-1332-h847-24120759j92"
}

Response examples (201)

{
  "id": "e68e0ie8-gi19-8009-e514-91897426g69",
  "name": "SH001",
  "asset_instances": [
    {
      "id": "h91h3lh1-jl42-1332-h847-24120759j92",
      "asset_id": "c46c8gc6-eg97-6887-c292-79675204e47"
    }
  ]
}

Remove shot asset instance

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

Jwt authorization

Remove an asset instance from a specific shot.

Path parameters

shot_id Required

Unique identifier of the shot
asset_instance_id Required

Unique identifier of the asset instance

Responses

204

Asset instance successfully removed from shot

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

curl \
 --request DELETE 'http://api.example.com/data/shots/e68e0ie8-gi19-8009-e514-91897426g69/asset-instances/h91h3lh1-jl42-1332-h847-24120759j92' \
 --header "Authorization: $API_KEY"

Get chat details

GET /data/entities/{entity_id}/chat

Jwt authorization

Retrieve chat information and messages for a specific entity. Returns chat metadata including participants and all associated messages.

Path parameters

entity_id Required

ID of the entity related to the chat

Responses

200 application/json

Chat information successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Chat unique identifier
- entity_id string(uuid)
  
  Entity ID this chat is associated with
- participants array[string(uuid)]
  
  List of participant user IDs
- messages array[object]
  
  Array of chat messages

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"

Response examples (200)

{
  "id": "string",
  "entity_id": "string",
  "participants": [
    "string"
  ],
  "messages": [
    {}
  ]
}

Get chat messages

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

Jwt authorization

Retrieve all chat messages for a specific entity. Returns a list of messages with sender information and timestamps.

Path parameters

entity_id Required

ID of the entity related to the chat

Responses

200 application/json

Chat messages successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Message unique identifier
- message string
  
  Message content
- person_id string(uuid)
  
  ID of the message sender
- created_at string(date-time)
  
  Message creation timestamp
- attachments array[object]
  
  Array of file attachments

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"

Response examples (200)

[
  {
    "id": "string",
    "message": "string",
    "person_id": "string",
    "created_at": "2025-05-04T09:42:00Z",
    "attachments": [
      {}
    ]
  }
]

Create chat message

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

Jwt authorization

Create a new chat message for a specific entity. Supports both JSON and form data with optional file attachments. Only chat participants can send messages.

Path parameters

entity_id Required

ID of the entity related to the chat

Body Required

message string Required

Message content to send

Responses

201 application/json

Chat message successfully created
Hide response attributes Show response attributes object
- id string(uuid)
  
  Created message unique identifier
- message string
  
  Message content
- person_id string(uuid)
  
  ID of the message sender
- created_at string(date-time)
  
  Message creation timestamp
- attachments array[object]
  
  Array of attached files

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" \
 --header "Content-Type: application/json" \
 --data '{"message":"Hello, world!"}'

curl \
 --request POST 'http://api.example.com/data/entities/a24a6ea4-ce75-4665-a070-57453082c25/chat/messages' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: multipart/form-data" \
 --form "message=Hello, world!" \
 --form "files[]=@file"

Request examples

{
  "message": "Hello, world!"
}

Response examples (201)

{
  "id": "string",
  "message": "string",
  "person_id": "string",
  "created_at": "2025-05-04T09:42:00Z",
  "attachments": [
    {}
  ]
}

Get chat message

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

Jwt authorization

Retrieve a specific chat message by its ID. Returns detailed message information including content and metadata.

Path parameters

entity_id Required

ID of the entity related to the chat
chat_message_id Required

ID of the chat message

Responses

200 application/json

Chat message successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Message unique identifier
- message string
  
  Message content
- person_id string(uuid)
  
  ID of the message sender
- created_at string(date-time)
  
  Message creation timestamp
- updated_at string(date-time)
  
  Message last update timestamp
- attachments array[object]
  
  Array of file attachments

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

Response examples (200)

{
  "id": "string",
  "message": "string",
  "person_id": "string",
  "created_at": "2025-05-04T09:42:00Z",
  "updated_at": "2025-05-04T09:42:00Z",
  "attachments": [
    {}
  ]
}

Delete chat message

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

Jwt authorization

Delete a specific chat message. Only the message author or administrators can delete messages.

Path parameters

entity_id Required

ID of the entity related to the chat
chat_message_id Required

ID of the chat message to delete

Responses

204

Chat message successfully deleted

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

Acknowledge comment

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

Jwt authorization

Acknowledge a specific comment. If it's already acknowledged, remove the acknowledgement.

Path parameters

task_id Required

Unique identifier of the task
comment_id Required

Unique identifier of the comment

Responses

200 application/json

Comment acknowledgement status successfully updated
Hide response attributes Show response attributes object
- id string(uuid)
  
  Comment unique identifier
- acknowledged boolean
  
  Whether the comment is 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/b35b7fb5-df86-5776-b181-68564193d36/ack' \
 --header "Authorization: $API_KEY"

Response examples (200)

{
  "id": "b35b7fb5-df86-5776-b181-68564193d36",
  "acknowledged": true
}

Reply to comment

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

Jwt authorization

Add a reply to a specific comment. The reply will be added to the comment's replies list.

Path parameters

task_id Required

Unique identifier of the task
comment_id Required

Unique identifier of the comment

Responses

200 application/json

Reply successfully added to comment
Hide response attributes Show response attributes object
- id string(uuid)
  
  Reply unique identifier
- comment_id string(uuid)
  
  Parent comment identifier
- text string
  
  Reply text content
- person_id string(uuid)
  
  Person identifier who made the reply
- created_at string(date-time)
  
  Creation timestamp

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

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

Response examples (200)

{
  "id": "c46c8gc6-eg97-6887-c292-79675204e47",
  "comment_id": "b35b7fb5-df86-5776-b181-68564193d36",
  "text": "Thanks for the feedback!",
  "person_id": "d57d9hd7-fh08-7998-d403-80786315f58",
  "created_at": "2023-01-01T12:00:00Z"
}

Delete comment attachment

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

Jwt authorization

Delete a specific attachment file linked to a comment. Only the comment author or project managers can delete attachments.

Path parameters

task_id Required

Unique identifier of the task
comment_id Required

Unique identifier of the comment
attachment_id Required

Unique identifier of the attachment

Responses

204

Attachment successfully deleted

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/b35b7fb5-df86-5776-b181-68564193d36/attachments/c46c8gc6-eg97-6887-c292-79675204e47' \
 --header "Authorization: $API_KEY"

Delete comment reply

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

Jwt authorization

Delete a specific reply from a comment. Only the reply author or administrators can delete replies.

Path parameters

task_id Required

Unique identifier of the task
comment_id Required

Unique identifier of the comment
reply_id Required

Unique identifier of the reply

Responses

200

Reply successfully 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/b35b7fb5-df86-5776-b181-68564193d36/reply/c46c8gc6-eg97-6887-c292-79675204e47' \
 --header "Authorization: $API_KEY"

Download attachment file

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

Jwt authorization

Download a specific attachment file from a comment or chat message. Supports various file types including images and documents.

Path parameters

attachment_file_id Required

Unique identifier of the attachment file
file_name Required

Name of the file to download

Responses

200 application/octet-stream

Attachment file successfully downloaded

File content

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

Add comment attachments

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

Jwt authorization

Add one or more files as attachments to a specific comment. Supports various file types including images and documents.

Path parameters

task_id Required

Unique identifier of the task
comment_id Required

Unique identifier of the comment

Responses

201 application/json

Files successfully added as attachments
Hide response attributes Show response attributes object
- id string(uuid)
  
  Attachment file unique identifier
- name string
  
  File name
- mimetype string
  
  File MIME type
- size integer
  
  File size in bytes
- comment_id string(uuid)
  
  Comment identifier

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/b35b7fb5-df86-5776-b181-68564193d36/add-attachment' \
 --header "Authorization: $API_KEY"

Response examples (201)

[
  {
    "id": "d57d9hd7-fh08-7998-d403-80786315f58",
    "name": "document.pdf",
    "mimetype": "application/pdf",
    "size": 1024000,
    "comment_id": "b35b7fb5-df86-5776-b181-68564193d36"
  }
]

Get project attachment files

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

Jwt authorization

Retrieve all attachment files related to a specific project. Requires administrator permissions.

Path parameters

project_id Required

Unique identifier of the project

Responses

200 application/json

Project attachment files successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Attachment file unique identifier
- name string
  
  File name
- mimetype string
  
  File MIME type
- size integer
  
  File size in bytes
- comment_id string(uuid)
  
  Comment identifier
- project_id string(uuid)
  
  Project identifier

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"

Response examples (200)

[
  {
    "id": "d57d9hd7-fh08-7998-d403-80786315f58",
    "name": "document.pdf",
    "mimetype": "application/pdf",
    "size": 1024000,
    "comment_id": "b35b7fb5-df86-5776-b181-68564193d36",
    "project_id": "a24a6ea4-ce75-4665-a070-57453082c25"
  }
]

Get task attachment files

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

Jwt authorization

Retrieve all attachment files related to a specific task. Requires administrator permissions.

Path parameters

task_id Required

Unique identifier of the task

Responses

200 application/json

Task attachment files successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Attachment file unique identifier
- name string
  
  File name
- mimetype string
  
  File MIME type
- size integer
  
  File size in bytes
- comment_id string(uuid)
  
  Comment identifier
- task_id string(uuid)
  
  Task identifier
- reply_id string(uuid)
  
  Reply identifier if attached to a reply

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"

Response examples (200)

[
  {
    "id": "d57d9hd7-fh08-7998-d403-80786315f58",
    "name": "document.pdf",
    "mimetype": "application/pdf",
    "size": 1024000,
    "comment_id": "b35b7fb5-df86-5776-b181-68564193d36",
    "task_id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "reply_id": "c46c8gc6-eg97-6887-c292-79675204e47"
  }
]

Create task comment

POST /actions/tasks/{task_id}/comment

Jwt authorization

Create a new comment for a specific task. It requires a text, a task_status and a person as arguments. This way, comments keep history of status changes. When the comment is created, it updates the task status with the given task status.

Path parameters

task_id Required

Unique identifier of the task

application/json

Body Required

task_status_id string(uuid) Required

Task status identifier
comment string

Comment text content
person_id string(uuid)

Person identifier (optional, defaults to current user)
created_at string(date-time)

Creation timestamp (optional, defaults to current time)
checklist object

Checklist items for the comment
links array[string]

List of related links

Responses

201 application/json

Comment successfully created
Hide response attributes Show response attributes object
- id string(uuid)
  
  Comment unique identifier
- task_id string(uuid)
  
  Task identifier
- person_id string(uuid)
  
  Person identifier
- comment string
  
  Comment text content
- task_status_id string(uuid)
  
  Task status identifier
- created_at string(date-time)
  
  Creation timestamp

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" \
 --header "Content-Type: application/json" \
 --data '{"task_status_id":"c46c8gc6-eg97-6887-c292-79675204e47","comment":"This looks great! Ready for review.","person_id":"d57d9hd7-fh08-7998-d403-80786315f58","created_at":"2023-01-01T12:00:00Z","checklist":{"item1":"Check lighting","item2":"Verify textures"},"links":["https://example.com/reference1","https://example.com/reference2"]}'

Request examples

{
  "task_status_id": "c46c8gc6-eg97-6887-c292-79675204e47",
  "comment": "This looks great! Ready for review.",
  "person_id": "d57d9hd7-fh08-7998-d403-80786315f58",
  "created_at": "2023-01-01T12:00:00Z",
  "checklist": {
    "item1": "Check lighting",
    "item2": "Verify textures"
  },
  "links": [
    "https://example.com/reference1",
    "https://example.com/reference2"
  ]
}

Response examples (201)

{
  "id": "b35b7fb5-df86-5776-b181-68564193d36",
  "task_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "person_id": "d57d9hd7-fh08-7998-d403-80786315f58",
  "comment": "This looks great! Ready for review.",
  "task_status_id": "c46c8gc6-eg97-6887-c292-79675204e47",
  "created_at": "2023-01-01T12:00:00Z"
}

Create multiple comments

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

Jwt authorization

Create several comments at once for a specific project. 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 the given task status.

Path parameters

project_id Required

Unique identifier of the project

application/json

Body Required

task_status_id string(uuid) Required

Task status identifier
comment string

Comment text content
person_id string(uuid)

Person identifier (optional, defaults to current user)
object_id string(uuid) Required

Task identifier
created_at string(date-time)

Creation timestamp (optional, defaults to current time)
checklist object

Checklist items for the comment
links array[string]

List of related links

Responses

201 application/json

Comments successfully created
Hide response attributes Show response attributes object
- id string(uuid)
  
  Comment unique identifier
- task_id string(uuid)
  
  Task identifier
- person_id string(uuid)
  
  Person identifier
- comment string
  
  Comment text content
- task_status_id string(uuid)
  
  Task status identifier
- created_at string(date-time)
  
  Creation timestamp

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" \
 --header "Content-Type: application/json" \
 --data '[{"task_status_id":"c46c8gc6-eg97-6887-c292-79675204e47","comment":"This looks great! Ready for review.","person_id":"d57d9hd7-fh08-7998-d403-80786315f58","object_id":"e68e0ie8-gi19-8009-e514-91897426g69","created_at":"2023-01-01T12:00:00Z","checklist":{"item1":"Check lighting","item2":"Verify textures"},"links":["https://example.com/reference1","https://example.com/reference2"]}]'

Request examples

[
  {
    "task_status_id": "c46c8gc6-eg97-6887-c292-79675204e47",
    "comment": "This looks great! Ready for review.",
    "person_id": "d57d9hd7-fh08-7998-d403-80786315f58",
    "object_id": "e68e0ie8-gi19-8009-e514-91897426g69",
    "created_at": "2023-01-01T12:00:00Z",
    "checklist": {
      "item1": "Check lighting",
      "item2": "Verify textures"
    },
    "links": [
      "https://example.com/reference1",
      "https://example.com/reference2"
    ]
  }
]

Response examples (201)

[
  {
    "id": "b35b7fb5-df86-5776-b181-68564193d36",
    "task_id": "e68e0ie8-gi19-8009-e514-91897426g69",
    "person_id": "d57d9hd7-fh08-7998-d403-80786315f58",
    "comment": "This looks great! Ready for review.",
    "task_status_id": "c46c8gc6-eg97-6887-c292-79675204e47",
    "created_at": "2023-01-01T12:00:00Z"
  }
]

Add task batch comments

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

Jwt authorization

Creates new comments for given task. Each comment requires a text, a task_status and a person as arguments. Can include preview files and attachments.

Path parameters

task_id string(uuid) Required

Task unique identifier

multipart/form-data

Body Required

comments string Required

JSON string containing array of comments

Responses

201 application/json

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" \
 --header "Content-Type: multipart/form-data" \
 --form "comments=[{"text": "Good work", "task_status_id": "uuid"}]"

Response examples (201)

[
  {}
]

Add tasks batch comments

POST /actions/tasks/batch-comment

Jwt authorization

Creates new comments for given tasks. Each comment requires a task_id, text, a task_status and a person as arguments. Can include preview files and attachments.

multipart/form-data

Body Required

comments string Required

JSON string containing array of comments

Responses

201 application/json

New comments created

POST /actions/tasks/batch-comment

curl \
 --request POST 'http://api.example.com/actions/tasks/batch-comment' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: multipart/form-data" \
 --form "comments=[{"task_id": "uuid", "text": "Good work", "task_status_id": "uuid"}]"

Response examples (201)

[
  {}
]

Get all concepts

GET /data/concepts

Jwt authorization

Retrieve all concept entries with filtering support. Filters can be specified in the query string to narrow down results by project or parent concept.

Query parameters

project_id

Filter concepts by specific project
parent_id

Filter concepts by parent concept

Responses

200 application/json

List of concepts successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Concept unique identifier
- name string
  
  Concept name
- description string
  
  Concept description
- project_id string(uuid)
  
  Project identifier
- parent_id string(uuid)
  
  Parent concept identifier
- created_at string(date-time)
  
  Creation timestamp
- updated_at string(date-time)
  
  Last update timestamp

GET /data/concepts

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

Response examples (200)

[
  {
    "id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "name": "Character Design",
    "description": "Main character concept art",
    "project_id": "b35b7fb5-df86-5776-b181-68564193d36",
    "parent_id": "c46c8gc6-eg97-6887-c292-79675204e47",
    "created_at": "2023-01-01T12:00:00Z",
    "updated_at": "2023-01-01T12:30:00Z"
  }
]

Get concepts and tasks

GET /data/concepts/with-tasks

Jwt authorization

Retrieve all concepts and all related tasks included in the response.

Query parameters

project_id

Filter concepts by specific project

Responses

200 application/json

Concepts with tasks successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Concept unique identifier
- name string
  
  Concept name
- description string
  
  Concept description
- project_id string(uuid)
  
  Project identifier
- project_name string
  
  Project name
- asset_type_name string
  
  Asset type name
- tasks array[object]
  
  Hide tasks attributes Show tasks attributes object
  
  id string(uuid)
  
  Task unique identifier
  
  name string
  
  Task name
  
  task_type_id string(uuid)
  
  Task type identifier
- created_at string(date-time)
  
  Creation timestamp
- updated_at string(date-time)
  
  Last update timestamp

GET /data/concepts/with-tasks

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

Response examples (200)

[
  {
    "id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "name": "Character Design",
    "description": "Main character concept art",
    "project_id": "b35b7fb5-df86-5776-b181-68564193d36",
    "project_name": "My Animation Project",
    "asset_type_name": "Character",
    "tasks": [
      {
        "id": "c46c8gc6-eg97-6887-c292-79675204e47",
        "name": "Character Design Task",
        "task_type_id": "d57d9hd7-fh08-7998-d403-80786315f58"
      }
    ],
    "created_at": "2023-01-01T12:00:00Z",
    "updated_at": "2023-01-01T12:30:00Z"
  }
]

Get concept

GET /data/concepts/{concept_id}

Jwt authorization

Retrieve detailed information about a specific concept including metadata, project context, and related data.

Path parameters

concept_id Required

Unique identifier of the concept

Responses

200 application/json

Concept information successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Concept unique identifier
- name string
  
  Concept name
- description string
  
  Concept description
- project_id string(uuid)
  
  Project identifier
- created_at string(date-time)
  
  Creation timestamp
- updated_at string(date-time)
  
  Last update timestamp

GET /data/concepts/{concept_id}

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

Response examples (200)

{
  "id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "name": "Character Design",
  "description": "Main character concept art",
  "project_id": "b35b7fb5-df86-5776-b181-68564193d36",
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-01-01T12:30:00Z"
}

Delete concept

DELETE /data/concepts/{concept_id}

Jwt authorization

Permanently remove a concept from the system. Only concept creators or project managers can delete concepts.

Path parameters

concept_id Required

Unique identifier of the concept to delete

Query parameters

force

Force deletion bypassing validation checks

Responses

204

Concept successfully deleted

DELETE /data/concepts/{concept_id}

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

Get concept task types

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

Jwt authorization

Retrieve all task types that are related to a specific concept.

Path parameters

concept_id Required

Unique identifier of the concept

Responses

200 application/json

List of concept task types successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Task type unique identifier
- name string
  
  Task type name
- short_name string
  
  Task type short name
- color string
  
  Task type color code
- for_entity string
  
  Entity type this task type is for

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"

Response examples (200)

[
  {
    "id": "b35b7fb5-df86-5776-b181-68564193d36",
    "name": "Concept Art",
    "short_name": "CON",
    "color": "#FF5733",
    "for_entity": "Concept"
  }
]

Get concept tasks

GET /data/concepts/{concept_id}/tasks

Jwt authorization

Retrieve all tasks that are related to a specific concept.

Path parameters

concept_id Required

Unique identifier of the concept

Query parameters

relations

Include related entity information

Responses

200 application/json

List of concept tasks successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Task unique identifier
- name string
  
  Task name
- task_type_id string(uuid)
  
  Task type identifier
- task_status_id string(uuid)
  
  Task status identifier
- entity_id string(uuid)
  
  Entity identifier
- assigned_to string(uuid)
  
  Assigned person identifier
- created_at string(date-time)
  
  Creation timestamp
- updated_at string(date-time)
  
  Last update timestamp

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"

Response examples (200)

[
  {
    "id": "b35b7fb5-df86-5776-b181-68564193d36",
    "name": "Character Design Task",
    "task_type_id": "c46c8gc6-eg97-6887-c292-79675204e47",
    "task_status_id": "d57d9hd7-fh08-7998-d403-80786315f58",
    "entity_id": "e68e0ie8-gi19-8009-e514-91897426g69",
    "assigned_to": "f79f1jf9-hj20-9010-f625-02998537h80",
    "created_at": "2023-01-01T12:00:00Z",
    "updated_at": "2023-01-01T12:30:00Z"
  }
]

Get concept previews

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

Jwt authorization

Retrieve all preview files related to a specific concept. Returns them as a dictionary where keys are related task type IDs and values are arrays of previews for that task type.

Path parameters

concept_id Required

Unique identifier of the concept

Responses

200 application/json

Concept previews successfully retrieved
Hide response attribute Show response attribute object
- * array[object] Additional properties
  
  Hide * attributes Show * attributes object
  
  id string(uuid)
  
  Preview unique identifier
  
  name string
  
  Preview name
  
  original_name string
  
  Original file name
  
  file_path string
  
  File path
  
  task_type_id string(uuid)
  
  Task type identifier
  
  created_at string(date-time)
  
  Creation timestamp

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"

Response examples (200)

{
  "additionalProperty1": [
    {
      "id": "b35b7fb5-df86-5776-b181-68564193d36",
      "name": "concept_preview_01",
      "original_name": "character_concept.jpg",
      "file_path": "/previews/concept/concept_preview_01.jpg",
      "task_type_id": "c46c8gc6-eg97-6887-c292-79675204e47",
      "created_at": "2023-01-01T12:00:00Z"
    }
  ],
  "additionalProperty2": [
    {
      "id": "b35b7fb5-df86-5776-b181-68564193d36",
      "name": "concept_preview_01",
      "original_name": "character_concept.jpg",
      "file_path": "/previews/concept/concept_preview_01.jpg",
      "task_type_id": "c46c8gc6-eg97-6887-c292-79675204e47",
      "created_at": "2023-01-01T12:00:00Z"
    }
  ]
}

Get project concepts

GET /data/projects/{project_id}/concepts

Jwt authorization

Retrieve all concepts that are related to a specific project.

Path parameters

project_id Required

Unique identifier of the project

Responses

200 application/json

List of project concepts successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Concept unique identifier
- name string
  
  Concept name
- description string
  
  Concept description
- project_id string(uuid)
  
  Project identifier
- created_at string(date-time)
  
  Creation timestamp
- updated_at string(date-time)
  
  Last update timestamp

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"

Response examples (200)

[
  {
    "id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "name": "Character Design",
    "description": "Main character concept art",
    "project_id": "b35b7fb5-df86-5776-b181-68564193d36",
    "created_at": "2023-01-01T12:00:00Z",
    "updated_at": "2023-01-01T12:30:00Z"
  }
]

Create concept

POST /data/projects/{project_id}/concepts

Jwt authorization

Create a new concept for a specific project with name, description, and optional entity concept links.

Path parameters

project_id Required

Unique identifier of the project

application/json

Body Required

name string Required

Concept name
description string

Concept description
data object

Additional concept data
entity_concept_links array[string(uuid)]

List of entity concept link identifiers

Responses

201 application/json

Concept successfully created
Hide response attributes Show response attributes object
- id string(uuid)
  
  Concept unique identifier
- name string
  
  Concept name
- description string
  
  Concept description
- project_id string(uuid)
  
  Project identifier
- data object
  
  Additional concept data
- created_by string(uuid)
  
  Creator person identifier
- created_at string(date-time)
  
  Creation timestamp
- updated_at string(date-time)
  
  Last update timestamp

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" \
 --header "Content-Type: application/json" \
 --data '{"name":"Character Design","description":"Main character concept art","data":{"mood":"heroic","style":"realistic"},"entity_concept_links":["b35b7fb5-df86-5776-b181-68564193d36","c46c8gc6-eg97-6887-c292-79675204e47"]}'

Request examples

{
  "name": "Character Design",
  "description": "Main character concept art",
  "data": {
    "mood": "heroic",
    "style": "realistic"
  },
  "entity_concept_links": [
    "b35b7fb5-df86-5776-b181-68564193d36",
    "c46c8gc6-eg97-6887-c292-79675204e47"
  ]
}

Response examples (201)

{
  "id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "name": "Character Design",
  "description": "Main character concept art",
  "project_id": "b35b7fb5-df86-5776-b181-68564193d36",
  "data": {
    "mood": "heroic",
    "style": "realistic"
  },
  "created_by": "d57d9hd7-fh08-7998-d403-80786315f58",
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-01-01T12:00:00Z"
}

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 department software licenses

GET /data/departments/software-licenses

Jwt authorization

Retrieve all software licenses organized by department. Returns a dictionary where each department contains its associated software licenses.

Responses

200 application/json

Department software licenses successfully retrieved
Hide response attribute Show response attribute object
- * array[object] Additional properties
  
  Hide * attributes Show * attributes object
  
  id string(uuid)
  
  Software license unique identifier
  
  name string
  
  Software license name
  
  short_name string
  
  Software license short name
  
  file_extension string
  
  Default file extension for the software license
  
  department_id string(uuid)
  
  Department identifier
  
  created_at string(date-time)
  
  Creation timestamp
  
  updated_at string(date-time)
  
  Last update timestamp

GET /data/departments/software-licenses

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

Response examples (200)

{
  "additionalProperty1": [
    {
      "id": "a24a6ea4-ce75-4665-a070-57453082c25",
      "name": "Maya",
      "short_name": "MAYA",
      "file_extension": ".ma",
      "department_id": "b35b7fb5-df86-5776-b181-68564193d36",
      "created_at": "2023-01-01T12:00:00Z",
      "updated_at": "2023-01-01T12:30:00Z"
    }
  ],
  "additionalProperty2": [
    {
      "id": "a24a6ea4-ce75-4665-a070-57453082c25",
      "name": "Maya",
      "short_name": "MAYA",
      "file_extension": ".ma",
      "department_id": "b35b7fb5-df86-5776-b181-68564193d36",
      "created_at": "2023-01-01T12:00:00Z",
      "updated_at": "2023-01-01T12:30:00Z"
    }
  ]
}

Add software license to department

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

Jwt authorization

Associate a software license with a specific department. This allows the department to use the specified software in budget forecasting.

Path parameters

department_id Required

Unique identifier of the department

application/json

Body Required

software_id string(uuid) Required

Software identifier to add to department

Responses

201 application/json

Software license successfully added to department
Hide response attributes Show response attributes object
- id string(uuid)
  
  Software license department link unique identifier
- department_id string(uuid)
  
  Department identifier
- software_id string(uuid)
  
  Software license identifier
- created_at string(date-time)
  
  Creation timestamp

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" \
 --header "Content-Type: application/json" \
 --data '{"software_id":"b35b7fb5-df86-5776-b181-68564193d36"}'

Request examples

{
  "software_id": "b35b7fb5-df86-5776-b181-68564193d36"
}

Response examples (201)

{
  "id": "c46c8gc6-eg97-6887-c292-79675204e47",
  "department_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "software_id": "b35b7fb5-df86-5776-b181-68564193d36",
  "created_at": "2023-01-01T12:00:00Z"
}

Get department software licenses

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

Jwt authorization

Retrieve all software items that are associated with a specific department.

Path parameters

department_id Required

Unique identifier of the department

Responses

200 application/json

Department software licenses successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Software license unique identifier
- name string
  
  Software license name
- short_name string
  
  Software license short name
- file_extension string
  
  Default file extension for the software license
- department_id string(uuid)
  
  Department identifier
- created_at string(date-time)
  
  Creation timestamp
- updated_at string(date-time)
  
  Last update timestamp

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"

Response examples (200)

[
  {
    "id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "name": "Maya",
    "short_name": "MAYA",
    "file_extension": ".ma",
    "department_id": "b35b7fb5-df86-5776-b181-68564193d36",
    "created_at": "2023-01-01T12:00:00Z",
    "updated_at": "2023-01-01T12:30:00Z"
  }
]

Remove software license from department

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

Jwt authorization

Remove a software license from a specific department. This disassociates the software license from the department.

Path parameters

department_id Required

Unique identifier of the department
software_id Required

Unique identifier of the software license to remove

Responses

204

Software license successfully removed from department

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/b35b7fb5-df86-5776-b181-68564193d36' \
 --header "Authorization: $API_KEY"

Get all department hardware items

GET /data/departments/hardware-items

Jwt authorization

Retrieve all hardware items organized by department. Returns a dictionary where each department contains its associated hardware items.

Responses

200 application/json

Department hardware items successfully retrieved
Hide response attribute Show response attribute object
- * array[object] Additional properties
  
  Hide * attributes Show * attributes object
  
  id string(uuid)
  
  Hardware item unique identifier
  
  name string
  
  Hardware item name
  
  description string
  
  Hardware item description
  
  department_id string(uuid)
  
  Department identifier
  
  created_at string(date-time)
  
  Creation timestamp
  
  updated_at string(date-time)
  
  Last update timestamp

GET /data/departments/hardware-items

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

Response examples (200)

{
  "additionalProperty1": [
    {
      "id": "a24a6ea4-ce75-4665-a070-57453082c25",
      "name": "Workstation",
      "description": "High-performance workstation",
      "department_id": "b35b7fb5-df86-5776-b181-68564193d36",
      "created_at": "2023-01-01T12:00:00Z",
      "updated_at": "2023-01-01T12:30:00Z"
    }
  ],
  "additionalProperty2": [
    {
      "id": "a24a6ea4-ce75-4665-a070-57453082c25",
      "name": "Workstation",
      "description": "High-performance workstation",
      "department_id": "b35b7fb5-df86-5776-b181-68564193d36",
      "created_at": "2023-01-01T12:00:00Z",
      "updated_at": "2023-01-01T12:30:00Z"
    }
  ]
}

Add hardware item to department

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

Jwt authorization

Associate a hardware item with a specific department. This allows the department to use the specified hardware in budget forecasting.

Path parameters

department_id Required

Unique identifier of the department

application/json

Body Required

hardware_item_id string(uuid) Required

Hardware item identifier to add to department

Responses

201 application/json

Hardware item successfully added to department
Hide response attributes Show response attributes object
- id string(uuid)
  
  Hardware department link unique identifier
- department_id string(uuid)
  
  Department identifier
- hardware_item_id string(uuid)
  
  Hardware item identifier
- created_at string(date-time)
  
  Creation timestamp

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" \
 --header "Content-Type: application/json" \
 --data '{"hardware_item_id":"b35b7fb5-df86-5776-b181-68564193d36"}'

Request examples

{
  "hardware_item_id": "b35b7fb5-df86-5776-b181-68564193d36"
}

Response examples (201)

{
  "id": "c46c8gc6-eg97-6887-c292-79675204e47",
  "department_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "hardware_item_id": "b35b7fb5-df86-5776-b181-68564193d36",
  "created_at": "2023-01-01T12:00:00Z"
}

Get department hardware items

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

Jwt authorization

Retrieve all hardware items that are associated with a specific department.

Path parameters

department_id Required

Unique identifier of the department

Responses

200 application/json

Department hardware items successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Hardware item unique identifier
- name string
  
  Hardware item name
- description string
  
  Hardware item description
- department_id string(uuid)
  
  Department identifier
- created_at string(date-time)
  
  Creation timestamp
- updated_at string(date-time)
  
  Last update timestamp

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"

Response examples (200)

[
  {
    "id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "name": "Workstation",
    "description": "High-performance workstation",
    "department_id": "b35b7fb5-df86-5776-b181-68564193d36",
    "created_at": "2023-01-01T12:00:00Z",
    "updated_at": "2023-01-01T12:30:00Z"
  }
]

Remove hardware item from department

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

Jwt authorization

Remove a hardware item from a specific department. This disassociates the hardware from the department.

Path parameters

department_id Required

Unique identifier of the department
hardware_item_id Required

Unique identifier of the hardware item to remove

Responses

204

Hardware item successfully removed from department

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/b35b7fb5-df86-5776-b181-68564193d36' \
 --header "Authorization: $API_KEY"

Get all edits

GET /data/edits

Jwt authorization

Retrieve all edit entries with filtering support. Filters can be specified in the query string.

Query parameters

project_id

Filter edits by specific project
name

Filter edits by name
force

Force parameter for additional filtering

Responses

200 application/json

List of all edits successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Edit unique identifier
- name string
  
  Edit name
- description string
  
  Edit description
- project_id string(uuid)
  
  Project identifier
- episode_id string(uuid)
  
  Episode identifier
- created_at string(date-time)
  
  Creation timestamp
- updated_at string(date-time)
  
  Last update timestamp

GET /data/edits

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

Response examples (200)

[
  {
    "id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "name": "Opening Sequence",
    "description": "Main opening sequence edit",
    "project_id": "b35b7fb5-df86-5776-b181-68564193d36",
    "episode_id": "c46c8gc6-eg97-6887-c292-79675204e47",
    "created_at": "2023-01-01T12:00:00Z",
    "updated_at": "2023-01-01T12:30:00Z"
  }
]

Get edits

GET /data/edits/all

Jwt authorization

Retrieve all edit entries with filtering support. Filters can be specified in the query string.

Query parameters

project_id

Filter edits by specific project
name

Filter edits by name
force

Force parameter for additional filtering

Responses

200 application/json

List of edits successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Edit unique identifier
- name string
  
  Edit name
- description string
  
  Edit description
- project_id string(uuid)
  
  Project identifier
- episode_id string(uuid)
  
  Episode identifier
- created_at string(date-time)
  
  Creation timestamp
- updated_at string(date-time)
  
  Last update timestamp

GET /data/edits/all

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

Response examples (200)

[
  {
    "id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "name": "Opening Sequence",
    "description": "Main opening sequence edit",
    "project_id": "b35b7fb5-df86-5776-b181-68564193d36",
    "episode_id": "c46c8gc6-eg97-6887-c292-79675204e47",
    "created_at": "2023-01-01T12:00:00Z",
    "updated_at": "2023-01-01T12:30:00Z"
  }
]

Get edits and tasks

GET /data/edits/with-tasks

Jwt authorization

Retrieve all edits with project name and all related tasks.

Query parameters

project_id

Filter edits by specific project
name

Filter edits by name
force

Force parameter for additional filtering

Responses

200 application/json

Edits with tasks successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Edit unique identifier
- name string
  
  Edit name
- description string
  
  Edit description
- project_id string(uuid)
  
  Project identifier
- project_name string
  
  Project name
- episode_id string(uuid)
  
  Episode identifier
- tasks array[object]
  
  Hide tasks attributes Show tasks attributes object
  
  id string(uuid)
  
  Task unique identifier
  
  name string
  
  Task name
  
  task_type_id string(uuid)
  
  Task type identifier
- created_at string(date-time)
  
  Creation timestamp
- updated_at string(date-time)
  
  Last update timestamp

GET /data/edits/with-tasks

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

Response examples (200)

[
  {
    "id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "name": "Opening Sequence",
    "description": "Main opening sequence edit",
    "project_id": "b35b7fb5-df86-5776-b181-68564193d36",
    "project_name": "My Animation Project",
    "episode_id": "c46c8gc6-eg97-6887-c292-79675204e47",
    "tasks": [
      {
        "id": "d57d9hd7-fh08-7998-d403-80786315f58",
        "name": "Edit Task",
        "task_type_id": "e68e0ie8-gi19-8009-e514-91897426g69"
      }
    ],
    "created_at": "2023-01-01T12:00:00Z",
    "updated_at": "2023-01-01T12:30:00Z"
  }
]

Get edit

GET /data/edits/{edit_id}

Jwt authorization

Retrieve detailed information about a specific edit.

Path parameters

edit_id Required

Unique identifier of the edit

Responses

200 application/json

Edit information successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Edit unique identifier
- name string
  
  Edit name
- description string
  
  Edit description
- project_id string(uuid)
  
  Project identifier
- episode_id string(uuid)
  
  Episode identifier
- created_at string(date-time)
  
  Creation timestamp
- updated_at string(date-time)
  
  Last update timestamp

GET /data/edits/{edit_id}

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

Response examples (200)

{
  "id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "name": "Opening Sequence",
  "description": "Main opening sequence edit",
  "project_id": "b35b7fb5-df86-5776-b181-68564193d36",
  "episode_id": "c46c8gc6-eg97-6887-c292-79675204e47",
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-01-01T12:30:00Z"
}

Delete edit

DELETE /data/edits/{edit_id}

Jwt authorization

Permanently remove an edit from the system. Only edit creators or project managers can delete edits.

Path parameters

edit_id Required

Unique identifier of the edit to delete

Query parameters

force

Force deletion bypassing validation checks

Responses

204

Edit successfully deleted

DELETE /data/edits/{edit_id}

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

Get edit task types

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

Jwt authorization

Retrieve all task types that are related to a specific edit.

Path parameters

edit_id Required

Unique identifier of the edit

Responses

200 application/json

List of edit task types successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Task type unique identifier
- name string
  
  Task type name
- short_name string
  
  Task type short name
- color string
  
  Task type color code
- for_entity string
  
  Entity type this task type is for

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"

Response examples (200)

[
  {
    "id": "b35b7fb5-df86-5776-b181-68564193d36",
    "name": "Edit",
    "short_name": "EDT",
    "color": "#FF5733",
    "for_entity": "Edit"
  }
]

Get edit tasks

GET /data/edits/{edit_id}/tasks

Jwt authorization

Retrieve all tasks that are related to a specific edit.

Path parameters

edit_id Required

Unique identifier of the edit

Query parameters

relations

Include related entity information

Responses

200 application/json

List of edit tasks successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Task unique identifier
- name string
  
  Task name
- task_type_id string(uuid)
  
  Task type identifier
- task_status_id string(uuid)
  
  Task status identifier
- entity_id string(uuid)
  
  Entity identifier
- assigned_to string(uuid)
  
  Assigned person identifier
- created_at string(date-time)
  
  Creation timestamp
- updated_at string(date-time)
  
  Last update timestamp

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"

Response examples (200)

[
  {
    "id": "b35b7fb5-df86-5776-b181-68564193d36",
    "name": "Edit Task",
    "task_type_id": "c46c8gc6-eg97-6887-c292-79675204e47",
    "task_status_id": "d57d9hd7-fh08-7998-d403-80786315f58",
    "entity_id": "e68e0ie8-gi19-8009-e514-91897426g69",
    "assigned_to": "f79f1jf9-hj20-9010-f625-02998537h80",
    "created_at": "2023-01-01T12:00:00Z",
    "updated_at": "2023-01-01T12:30:00Z"
  }
]

Get edit previews

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

Jwt authorization

Retrieve all preview files related to a specific edit. Returns them as a dictionary where keys are related task type IDs and values are arrays of previews for that task type.

Path parameters

edit_id Required

Unique identifier of the edit

Responses

200 application/json

Edit previews successfully retrieved
Hide response attribute Show response attribute object
- * array[object] Additional properties
  
  Hide * attributes Show * attributes object
  
  id string(uuid)
  
  Preview unique identifier
  
  name string
  
  Preview name
  
  original_name string
  
  Original file name
  
  file_path string
  
  File path
  
  task_type_id string(uuid)
  
  Task type identifier
  
  created_at string(date-time)
  
  Creation timestamp

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"

Response examples (200)

{
  "additionalProperty1": [
    {
      "id": "b35b7fb5-df86-5776-b181-68564193d36",
      "name": "edit_preview_01",
      "original_name": "edit_sequence.mov",
      "file_path": "/previews/edit/edit_preview_01.mov",
      "task_type_id": "c46c8gc6-eg97-6887-c292-79675204e47",
      "created_at": "2023-01-01T12:00:00Z"
    }
  ],
  "additionalProperty2": [
    {
      "id": "b35b7fb5-df86-5776-b181-68564193d36",
      "name": "edit_preview_01",
      "original_name": "edit_sequence.mov",
      "file_path": "/previews/edit/edit_preview_01.mov",
      "task_type_id": "c46c8gc6-eg97-6887-c292-79675204e47",
      "created_at": "2023-01-01T12:00:00Z"
    }
  ]
}

Get edit versions

GET /data/edits/{edit_id}/versions

Jwt authorization

Retrieve all data versions of a specific edit. This includes historical versions and metadata about changes over time.

Path parameters

edit_id Required

Unique identifier of the edit

Responses

200 application/json

Edit versions successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Version unique identifier
- edit_id string(uuid)
  
  Edit identifier
- version_number integer
  
  Version number
- data object
  
  Version data content
- created_at string(date-time)
  
  Creation timestamp
- created_by string(uuid)
  
  Creator person identifier

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"

Response examples (200)

[
  {
    "id": "b35b7fb5-df86-5776-b181-68564193d36",
    "edit_id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "version_number": 1,
    "data": {
      "fps": 24,
      "changes": "Added transitions",
      "duration": 120
    },
    "created_at": "2023-01-01T12:00:00Z",
    "created_by": "c46c8gc6-eg97-6887-c292-79675204e47"
  }
]

Get episode edits

GET /data/episodes/{episode_id}/edits

Jwt authorization

Retrieve all edits that are related to a specific episode.

Path parameters

episode_id Required

Unique identifier of the episode

Query parameters

relations

Include related entity information

Responses

200 application/json

List of episode edits successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Edit unique identifier
- name string
  
  Edit name
- description string
  
  Edit description
- project_id string(uuid)
  
  Project identifier
- episode_id string(uuid)
  
  Episode identifier
- created_at string(date-time)
  
  Creation timestamp
- updated_at string(date-time)
  
  Last update timestamp

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"

Response examples (200)

[
  {
    "id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "name": "Episode Edit",
    "description": "Main episode edit",
    "project_id": "b35b7fb5-df86-5776-b181-68564193d36",
    "episode_id": "c46c8gc6-eg97-6887-c292-79675204e47",
    "created_at": "2023-01-01T12:00:00Z",
    "updated_at": "2023-01-01T12:30:00Z"
  }
]

Get episode edit tasks

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

Jwt authorization

Retrieve all tasks that are related to a specific episode.

Path parameters

episode_id Required

Unique identifier of the episode

Query parameters

relations

Include related entity information

Responses

200 application/json

List of episode edit tasks successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Task unique identifier
- name string
  
  Task name
- task_type_id string(uuid)
  
  Task type identifier
- task_status_id string(uuid)
  
  Task status identifier
- entity_id string(uuid)
  
  Entity identifier
- assigned_to string(uuid)
  
  Assigned person identifier
- created_at string(date-time)
  
  Creation timestamp
- updated_at string(date-time)
  
  Last update timestamp

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"

Response examples (200)

[
  {
    "id": "b35b7fb5-df86-5776-b181-68564193d36",
    "name": "Episode Edit Task",
    "task_type_id": "c46c8gc6-eg97-6887-c292-79675204e47",
    "task_status_id": "d57d9hd7-fh08-7998-d403-80786315f58",
    "entity_id": "e68e0ie8-gi19-8009-e514-91897426g69",
    "assigned_to": "f79f1jf9-hj20-9010-f625-02998537h80",
    "created_at": "2023-01-01T12:00:00Z",
    "updated_at": "2023-01-01T12:30:00Z"
  }
]

Get project edits

GET /data/projects/{project_id}/edits

Jwt authorization

Retrieve all edits that are related to a specific project.

Path parameters

project_id Required

Unique identifier of the project

Responses

200 application/json

List of project edits successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Edit unique identifier
- name string
  
  Edit name
- description string
  
  Edit description
- project_id string(uuid)
  
  Project identifier
- episode_id string(uuid)
  
  Episode identifier
- created_at string(date-time)
  
  Creation timestamp
- updated_at string(date-time)
  
  Last update timestamp

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"

Response examples (200)

[
  {
    "id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "name": "Opening Sequence",
    "description": "Main opening sequence edit",
    "project_id": "b35b7fb5-df86-5776-b181-68564193d36",
    "episode_id": "c46c8gc6-eg97-6887-c292-79675204e47",
    "created_at": "2023-01-01T12:00:00Z",
    "updated_at": "2023-01-01T12:30:00Z"
  }
]

Create edit

POST /data/projects/{project_id}/edits

Jwt authorization

Create a new edit for a specific project with name, description, and optional episode association.

Path parameters

project_id Required

Unique identifier of the project

application/json

Body Required

name string Required

Edit name
description string

Edit description
data object

Additional edit data
episode_id string(uuid)

Episode identifier (optional)

Responses

201 application/json

Edit successfully created
Hide response attributes Show response attributes object
- id string(uuid)
  
  Edit unique identifier
- name string
  
  Edit name
- description string
  
  Edit description
- project_id string(uuid)
  
  Project identifier
- episode_id string(uuid)
  
  Episode identifier
- data object
  
  Additional edit data
- created_by string(uuid)
  
  Creator person identifier
- created_at string(date-time)
  
  Creation timestamp
- updated_at string(date-time)
  
  Last update timestamp

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" \
 --header "Content-Type: application/json" \
 --data '{"name":"Opening Sequence","description":"Main opening sequence edit","data":{"fps":24,"duration":120},"episode_id":"b35b7fb5-df86-5776-b181-68564193d36"}'

Request examples

{
  "name": "Opening Sequence",
  "description": "Main opening sequence edit",
  "data": {
    "fps": 24,
    "duration": 120
  },
  "episode_id": "b35b7fb5-df86-5776-b181-68564193d36"
}

Response examples (201)

{
  "id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "name": "Opening Sequence",
  "description": "Main opening sequence edit",
  "project_id": "b35b7fb5-df86-5776-b181-68564193d36",
  "episode_id": "c46c8gc6-eg97-6887-c292-79675204e47",
  "data": {
    "fps": 24,
    "duration": 120
  },
  "created_by": "d57d9hd7-fh08-7998-d403-80786315f58",
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-01-01T12:00:00Z"
}

Get entity news

GET /data/entities/{entity_id}/news

Jwt authorization

Retrieve all news entries that are linked to a specific entity.

Path parameters

entity_id Required

Unique identifier of the entity

Responses

200 application/json

List of entity news successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  News unique identifier
- change boolean
  
  Whether this news represents a change
- author_id string(uuid)
  
  Author person identifier
- comment_id string(uuid)
  
  Comment identifier
- task_id string(uuid)
  
  Task identifier
- preview_file_id string(uuid)
  
  Preview file identifier
- created_at string(date-time)
  
  Creation timestamp
- updated_at string(date-time)
  
  Last update timestamp

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"

Response examples (200)

[
  {
    "id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "change": true,
    "author_id": "b35b7fb5-df86-5776-b181-68564193d36",
    "comment_id": "c46c8gc6-eg97-6887-c292-79675204e47",
    "task_id": "d57d9hd7-fh08-7998-d403-80786315f58",
    "preview_file_id": "e68e0ie8-gi19-8009-e514-91897426g69",
    "created_at": "2023-01-01T12:00:00Z",
    "updated_at": "2023-01-01T12:30:00Z"
  }
]

Get entity preview files

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

Jwt authorization

Retrieve all preview files that are linked to a specific entity. This includes images, videos, and other preview media associated with the entity.

Path parameters

entity_id Required

Unique identifier of the entity

Responses

200 application/json

List of entity preview files successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Preview file unique identifier
- name string
  
  Preview file name
- path string
  
  File path
- revision integer
  
  File revision number
- created_at string(date-time)
  
  Creation timestamp
- entity_id string(uuid)
  
  Entity identifier
- task_id string(uuid)
  
  Task identifier

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"

Response examples (200)

[
  {
    "id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "name": "preview_001.jpg",
    "path": "/previews/entity/preview_001.jpg",
    "revision": 1,
    "created_at": "2023-01-01T12:00:00Z",
    "entity_id": "b35b7fb5-df86-5776-b181-68564193d36",
    "task_id": "c46c8gc6-eg97-6887-c292-79675204e47"
  }
]

Get entity time spent

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

Jwt authorization

Retrieve all time spent entries that are linked to a specific entity.

Path parameters

entity_id Required

Unique identifier of the entity

Responses

200 application/json

List of entity time spent entries successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Time spent unique identifier
- duration number(float)
  
  Time duration in hours
- date string(date)
  
  Date when time was spent
- created_at string(date-time)
  
  Creation timestamp
- person_id string(uuid)
  
  Person identifier who spent the time
- entity_id string(uuid)
  
  Entity identifier

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"

Response examples (200)

[
  {
    "id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "duration": 2.5,
    "date": "2023-12-07",
    "created_at": "2023-01-01T12:00:00Z",
    "person_id": "b35b7fb5-df86-5776-b181-68564193d36",
    "entity_id": "c46c8gc6-eg97-6887-c292-79675204e47"
  }
]

Get linked entities

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

Jwt authorization

Retrieve all entities that are linked to a specific entity along with their associated tasks. This includes related entities, dependencies, and hierarchical relationships.

Path parameters

entity_id Required

Unique identifier of the entity

Responses

200 application/json

List of linked entities successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Entity unique identifier
- name string
  
  Entity name
- entity_type_id string(uuid)
  
  Entity type identifier
- project_id string(uuid)
  
  Project identifier
- parent_id string(uuid)
  
  Parent entity identifier
- tasks array[object]
  
  Hide tasks attributes Show tasks attributes object
  
  id string(uuid)
  
  Task unique identifier
  
  name string
  
  Task name
  
  task_type_id string(uuid)
  
  Task type identifier

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"

Response examples (200)

[
  {
    "id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "name": "Character Model",
    "entity_type_id": "b35b7fb5-df86-5776-b181-68564193d36",
    "project_id": "c46c8gc6-eg97-6887-c292-79675204e47",
    "parent_id": "d57d9hd7-fh08-7998-d403-80786315f58",
    "tasks": [
      {
        "id": "e68e0ie8-gi19-8009-e514-91897426g69",
        "name": "Modeling Task",
        "task_type_id": "f79f1jf9-hj20-9010-f625-02998537h80"
      }
    ]
  }
]

Get events

GET /data/events/last

Jwt authorization

Retrieve last events with filtering support. Filters can be specified in the query string to narrow down results by date range, project, or other criteria.

Query parameters

after

Filter events after this date
before

Filter events before this date
only_files

Return only file-related events
limit

Maximum number of events to return
project_id

Filter events by specific project
name

Filter events by event name

Responses

200 application/json

List of events successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Event unique identifier
- name string
  
  Event name
- data object
  
  Event data content
- project_id string(uuid)
  
  Project identifier
- created_at string(date-time)
  
  Event timestamp
- user_id string(uuid)
  
  User identifier who triggered the event

GET /data/events/last

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

Response examples (200)

[
  {
    "id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "name": "user_login",
    "data": {
      "user_id": "b35b7fb5-df86-5776-b181-68564193d36"
    },
    "project_id": "c46c8gc6-eg97-6887-c292-79675204e47",
    "created_at": "2023-01-01T12:00:00Z",
    "user_id": "d57d9hd7-fh08-7998-d403-80786315f58"
  }
]

Get login logs

GET /data/events/login-logs/last

Jwt authorization

Retrieve all login logs with filtering support. Filters can be specified in the query string to narrow down results by date range and limit.

Responses

200 application/json

List of login logs successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Login log unique identifier
- user_id string(uuid)
  
  User identifier
- ip_address string
  
  IP address of the login
- user_agent string
  
  User agent string
- success boolean
  
  Whether the login was successful
- created_at string(date-time)
  
  Login timestamp

GET /data/events/login-logs/last

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

Response examples (200)

[
  {
    "id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "user_id": "b35b7fb5-df86-5776-b181-68564193d36",
    "ip_address": "192.168.1.100",
    "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64)",
    "success": true,
    "created_at": "2023-01-01T12:00:00Z"
  }
]

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 file information

GET /data/files/{file_id}

Jwt authorization

Retrieve information about a file that could be either a working file or an output file. Returns detailed file metadata and properties.

Path parameters

file_id string(uuid) Required

File unique identifier

Responses

200 application/json

File information retrieved successfully
Hide response attributes Show response attributes object
- id string(uuid)
  
  File unique identifier
- name string
  
  File name
- path string
  
  File path
- revision integer
  
  File revision
- updated_at string(date-time)
  
  Last update timestamp
- task_id string(uuid)
  
  Task identifier (for working files)
- entity_id string(uuid)
  
  Entity identifier (for output files)

GET /data/files/{file_id}

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

Response examples (200)

{
  "id": "b35b7fb5-df86-5776-b181-68564193d36",
  "name": "main",
  "path": "/project/asset/working/main_v001.blend",
  "revision": 1,
  "updated_at": "2023-01-01T12:00:00Z",
  "task_id": "c46c8gc6-eg97-6887-c292-79675204e47",
  "entity_id": "d57d9hd7-fh08-7998-d403-80786315f58"
}

Get task working files

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

Jwt authorization

Retrieve all working file revisions for a given task. Returns complete list of working files with their revisions.

Path parameters

task_id string(uuid) Required

Task unique identifier

Responses

200 application/json

All working file revisions for given task
Hide response attributes Show response attributes object
- id string(uuid)
  
  Working file unique identifier
- name string
  
  Working file name
- revision integer
  
  Working file revision
- updated_at string(date-time)
  
  Last update timestamp
- task_id string(uuid)
  
  Task identifier

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"

Response examples (200)

[
  {
    "id": "b35b7fb5-df86-5776-b181-68564193d36",
    "name": "main",
    "revision": 1,
    "updated_at": "2023-01-01T12:00:00Z",
    "task_id": "c46c8gc6-eg97-6887-c292-79675204e47"
  }
]

Create new working file

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

Jwt authorization

Create a new working file for a task. Working files are versioned files used by artists to produce output files. Each file requires a comment and generates a path based on file tree template.

Path parameters

task_id string(uuid) Required

Task unique identifier

application/json

Body Required

name string Required

Working file name
mode string

Working file mode

Default value is working.
description string

Working file description
comment string

Working file comment
person_id string(uuid)

Person identifier
software_id string(uuid)

Software identifier
revision integer

Working file revision
sep string

Path separator

Default value is /.

Responses

201 application/json

New working file created successfully
Hide response attributes Show response attributes object
- id string(uuid)
  
  Working file unique identifier
- name string
  
  Working file name
- path string
  
  Working file path
- revision integer
  
  Working file revision
- task_id string(uuid)
  
  Task identifier
- created_at string(date-time)
  
  Creation timestamp
- updated_at string(date-time)
  
  Last update timestamp

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" \
 --header "Content-Type: application/json" \
 --data '{"name":"main","mode":"working","description":"Main character model","comment":"Updated lighting and materials","person_id":"a24a6ea4-ce75-4665-a070-57453082c25","software_id":"a24a6ea4-ce75-4665-a070-57453082c25","revision":1,"sep":"/"}'

Request examples

{
  "name": "main",
  "mode": "working",
  "description": "Main character model",
  "comment": "Updated lighting and materials",
  "person_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "software_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "revision": 1,
  "sep": "/"
}

Response examples (201)

{
  "id": "b35b7fb5-df86-5776-b181-68564193d36",
  "name": "main",
  "path": "/project/asset/working/main_v001.blend",
  "revision": 1,
  "task_id": "c46c8gc6-eg97-6887-c292-79675204e47",
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-01-01T12:30:00Z"
}

Get last working files

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

Jwt authorization

Retrieve the last working file revisions for each file name for a given task. Returns the most recent version of each working file.

Path parameters

task_id string(uuid) Required

Task unique identifier

Responses

200 application/json

Last working file revisions for each file name
Hide response attribute Show response attribute object
- * object Additional properties
  
  Hide * attributes Show * attributes object
  
  id string(uuid)
  
  Working file unique identifier
  
  name string
  
  Working file name
  
  revision integer
  
  Working file revision
  
  updated_at string(date-time)
  
  Last update timestamp

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"

Response examples (200)

{
  "additionalProperty1": {
    "id": "b35b7fb5-df86-5776-b181-68564193d36",
    "name": "main",
    "revision": 3,
    "updated_at": "2023-01-01T12:00:00Z"
  },
  "additionalProperty2": {
    "id": "b35b7fb5-df86-5776-b181-68564193d36",
    "name": "main",
    "revision": 3,
    "updated_at": "2023-01-01T12:00:00Z"
  }
}

Generate working file path

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

Jwt authorization

Generate a working file path from file tree template based on task parameters. Revision can be computed automatically if not provided.

Path parameters

task_id string(uuid) Required

Task unique identifier

application/json

Body Required

name string

File name

Default value is main.
mode string

File mode

Default value is working.
software_id string(uuid)

Software identifier
comment string

File comment
revision integer

File revision number
separator string

Path separator

Default value is /.

Responses

200 application/json

Working file path generated successfully
Hide response attributes Show response attributes object
- path string
  
  Generated file path
- name string
  
  Generated file name
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" \
 --header "Content-Type: application/json" \
 --data '{"name":"main","mode":"working","software_id":"a24a6ea4-ce75-4665-a070-57453082c25","comment":"Updated lighting","revision":1,"separator":"/"}'

Request examples

{
  "name": "main",
  "mode": "working",
  "software_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "comment": "Updated lighting",
  "revision": 1,
  "separator": "/"
}

Response examples (200)

{
  "path": "/project/asset/working/main_v001.blend",
  "name": "main_v001.blend"
}

Create new instance output file

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

Jwt authorization

Create a new output file linked to an asset instance for a specific shot. Output files track the source working file and require output type and task type for categorization.

Path parameters

asset_instance_id string(uuid) Required

Asset instance unique identifier
temporal_entity_id string(uuid) Required

Temporal entity unique identifier

application/json

Body Required

name string

Output file name

Default value is main.
mode string

Output file mode

Default value is output.
output_type_id string(uuid) Required

Output type identifier
task_type_id string(uuid) Required

Task type identifier
person_id string(uuid)

Person identifier
working_file_id string(uuid)

Source working file identifier
file_status_id string(uuid)

File status identifier
is_sequence boolean

Whether file is a sequence

Default value is false.
comment string

Output file comment
extension string

File extension
representation string

File representation
revision integer

File revision number
nb_elements integer

Number of elements

Default value is 1.
sep string

Path separator

Default value is /.

Responses

201 application/json

New output file created successfully
Hide response attributes Show response attributes object
- id string(uuid)
  
  Output file unique identifier
- name string
  
  Output file name
- path string
  
  Output file path
- revision integer
  
  Output file revision
- asset_instance_id string(uuid)
  
  Asset instance identifier
- temporal_entity_id string(uuid)
  
  Temporal entity identifier
- created_at string(date-time)
  
  Creation timestamp
- updated_at string(date-time)
  
  Last update timestamp

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/b35b7fb5-df86-5776-b181-68564193d36/output-files/new' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"name":"main","mode":"output","output_type_id":"a24a6ea4-ce75-4665-a070-57453082c25","task_type_id":"b35b7fb5-df86-5776-b181-68564193d36","person_id":"a24a6ea4-ce75-4665-a070-57453082c25","working_file_id":"a24a6ea4-ce75-4665-a070-57453082c25","file_status_id":"a24a6ea4-ce75-4665-a070-57453082c25","is_sequence":false,"comment":"Final render","extension":".mp4","representation":"mp4","revision":1,"nb_elements":1,"sep":"/"}'

Request examples

{
  "name": "main",
  "mode": "output",
  "output_type_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "task_type_id": "b35b7fb5-df86-5776-b181-68564193d36",
  "person_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "working_file_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "file_status_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "is_sequence": false,
  "comment": "Final render",
  "extension": ".mp4",
  "representation": "mp4",
  "revision": 1,
  "nb_elements": 1,
  "sep": "/"
}

Response examples (201)

{
  "id": "b35b7fb5-df86-5776-b181-68564193d36",
  "name": "main",
  "path": "/project/asset/instance/output/main_v001.mp4",
  "revision": 1,
  "asset_instance_id": "c46c8gc6-eg97-6887-c292-79675204e47",
  "temporal_entity_id": "d57d9hd7-fh08-7998-d403-80786315f58",
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-01-01T12:30:00Z"
}

Get next instance output file revision

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

Jwt authorization

Get the next revision number for an output file based on asset instance, output type, task type, and name. Used for automatic revision numbering.

Path parameters

asset_instance_id string(uuid) Required

Asset instance unique identifier
temporal_entity_id string(uuid) Required

Temporal entity unique identifier

application/json

Body Required

name string

File name

Default value is main.
output_type_id string(uuid) Required

Output type identifier
task_type_id string(uuid) Required

Task type identifier

Responses

200 application/json

Next revision number for the instance output file
Hide response attribute Show response attribute object
- next_revision integer
  
  Next available revision number

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/b35b7fb5-df86-5776-b181-68564193d36/output-files/next-revision' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"name":"main","output_type_id":"a24a6ea4-ce75-4665-a070-57453082c25","task_type_id":"b35b7fb5-df86-5776-b181-68564193d36"}'

Request examples

{
  "name": "main",
  "output_type_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "task_type_id": "b35b7fb5-df86-5776-b181-68564193d36"
}

Response examples (200)

{
  "next_revision": 2
}

Get last instance output files

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

Jwt authorization

Retrieve the last revisions of output files for a given instance grouped by output type and file name. Returns the most recent version of each output file.

Path parameters

asset_instance_id string(uuid) Required

Asset instance unique identifier
temporal_entity_id string(uuid) Required

Temporal entity unique identifier

Query parameters

output_type_id string(uuid)

Filter by output type
task_type_id string(uuid)

Filter by task type
file_status_id string(uuid)

Filter by file status
representation string

Filter by representation
name string

Filter by file name

Responses

200 application/json

Last revisions of output files grouped by output type and file name
Hide response attribute Show response attribute object
- * object Additional properties
  
  Hide * attributes Show * attributes object
  
  id string(uuid)
  
  Output file unique identifier
  
  name string
  
  Output file name
  
  revision integer
  
  Output file revision
  
  path string
  
  Output file path
  
  updated_at string(date-time)
  
  Last update timestamp

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/b35b7fb5-df86-5776-b181-68564193d36/output-files/last-revisions' \
 --header "Authorization: $API_KEY"

Response examples (200)

{
  "additionalProperty1": {
    "id": "f79f1jf9-hj20-9010-f625-a09008537h80",
    "name": "main",
    "revision": 1,
    "path": "/project/asset/instance/output/main_v001.mp4",
    "updated_at": "2023-01-01T12:00:00Z"
  },
  "additionalProperty2": {
    "id": "f79f1jf9-hj20-9010-f625-a09008537h80",
    "name": "main",
    "revision": 1,
    "path": "/project/asset/instance/output/main_v001.mp4",
    "updated_at": "2023-01-01T12:00:00Z"
  }
}

Get instance output types

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

Jwt authorization

Retrieve all types of output files generated for a given asset instance and temporal entity. Returns list of output types available for the instance.

Path parameters

asset_instance_id string(uuid) Required

Asset instance unique identifier
temporal_entity_id string(uuid) Required

Temporal entity unique identifier

Responses

200 application/json

All types of output files generated for the instance
Hide response attributes Show response attributes object
- id string(uuid)
  
  Output type unique identifier
- name string
  
  Output type name
- short_name string
  
  Output type short name
- created_at string(date-time)
  
  Creation timestamp
- updated_at string(date-time)
  
  Last update timestamp

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/b35b7fb5-df86-5776-b181-68564193d36/output-types' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {
    "id": "c46c8gc6-eg97-6887-c292-79675204e47",
    "name": "Render",
    "short_name": "RENDER",
    "created_at": "2023-01-01T12:00:00Z",
    "updated_at": "2023-01-01T12:30:00Z"
  }
]

Get instance output type files

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

Jwt authorization

Retrieve all output files for a given asset instance, temporal entity, and output type. Optionally filter by representation.

Path parameters

asset_instance_id string(uuid) Required

Asset instance unique identifier
temporal_entity_id string(uuid) Required

Temporal entity unique identifier
output_type_id string(uuid) Required

Output type unique identifier

Query parameters

representation string

Filter by representation

Responses

200 application/json

All output files for the asset instance and output type
Hide response attributes Show response attributes object
- id string(uuid)
  
  Output file unique identifier
- name string
  
  Output file name
- revision integer
  
  Output file revision
- path string
  
  Output file path
- updated_at string(date-time)
  
  Last update timestamp
- asset_instance_id string(uuid)
  
  Asset instance identifier
- temporal_entity_id string(uuid)
  
  Temporal entity identifier

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/b35b7fb5-df86-5776-b181-68564193d36/output-types/c46c8gc6-eg97-6887-c292-79675204e47/output-files' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {
    "id": "d57d9hd7-fh08-7998-d403-80786315f58",
    "name": "main",
    "revision": 1,
    "path": "/project/asset/instance/output/main_v001.mp4",
    "updated_at": "2023-01-01T12:00:00Z",
    "asset_instance_id": "e68e0ie8-gi19-8009-e514-91897426g69",
    "temporal_entity_id": "f79f1jf9-hj20-9010-f625-a09008537h80"
  }
]

Generate instance output file path

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

Jwt authorization

Generate an output file path from file tree template based on asset instance parameters. Revision can be computed automatically if not provided.

Path parameters

asset_instance_id string(uuid) Required

Asset instance unique identifier
temporal_entity_id string(uuid) Required

Temporal entity unique identifier

application/json

Body Required

name string

File name

Default value is main.
mode string

File mode

Default value is output.
output_type_id string(uuid) Required

Output type identifier
task_type_id string(uuid) Required

Task type identifier
extension string

File extension
representation string

File representation
revision integer

File revision number
separator string

Path separator

Default value is /.

Responses

200 application/json

Output file path generated successfully
Hide response attributes Show response attributes object
- folder_path string
  
  Generated folder path
- file_name string
  
  Generated file name

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/b35b7fb5-df86-5776-b181-68564193d36/output-file-path' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"name":"main","mode":"output","output_type_id":"a24a6ea4-ce75-4665-a070-57453082c25","task_type_id":"b35b7fb5-df86-5776-b181-68564193d36","extension":".mp4","representation":"mp4","revision":1,"separator":"/"}'

Request examples

{
  "name": "main",
  "mode": "output",
  "output_type_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "task_type_id": "b35b7fb5-df86-5776-b181-68564193d36",
  "extension": ".mp4",
  "representation": "mp4",
  "revision": 1,
  "separator": "/"
}

Response examples (200)

{
  "folder_path": "/project/asset/instance/output",
  "file_name": "main_v001.mp4"
}

Get entity working files

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

Jwt authorization

Retrieve all working files for a given entity with optional filtering by task and name. Returns complete list of working files with their revisions.

Path parameters

entity_id string(uuid) Required

Entity unique identifier

Query parameters

task_id string(uuid)

Filter by task
name string

Filter by file name

Responses

200 application/json

All working files for the entity
Hide response attributes Show response attributes object
- id string(uuid)
  
  Working file unique identifier
- name string
  
  Working file name
- revision integer
  
  Working file revision
- path string
  
  Working file path
- updated_at string(date-time)
  
  Last update timestamp
- task_id string(uuid)
  
  Task identifier
- entity_id string(uuid)
  
  Entity identifier

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"

Response examples (200)

[
  {
    "id": "c46c8gc6-eg97-6887-c292-79675204e47",
    "name": "main",
    "revision": 1,
    "path": "/project/asset/working/main_v001.blend",
    "updated_at": "2023-01-01T12:00:00Z",
    "task_id": "d57d9hd7-fh08-7998-d403-80786315f58",
    "entity_id": "e68e0ie8-gi19-8009-e514-91897426g69"
  }
]

Create new entity output file

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

Jwt authorization

Create a new output file linked to a specific entity. Output files are created when artists are satisfied with their working files. They track the source working file and require output type and task type for categorization. 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. The revision is automatically set.

Path parameters

entity_id string(uuid) Required

Entity unique identifier

application/json

Body Required

name string

Output file name
mode string

Output file mode

Default value is output.
output_type_id string(uuid) Required

Output type identifier
task_type_id string(uuid) Required

Task type identifier
person_id string(uuid)

Person identifier
working_file_id string(uuid)

Source working file identifier
file_status_id string(uuid)

File status identifier
comment string

Output file comment
extension string

File extension
representation string

File representation
revision integer

File revision number
nb_elements integer

Number of elements

Default value is 1.
sep string

Path separator

Default value is /.

Responses

201 application/json

New output file created successfully
Hide response attributes Show response attributes object
- id string(uuid)
  
  Output file unique identifier
- name string
  
  Output file name
- path string
  
  Output file path
- revision integer
  
  Output file revision
- entity_id string(uuid)
  
  Entity identifier
- created_at string(date-time)
  
  Creation timestamp
- updated_at string(date-time)
  
  Last update timestamp

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" \
 --header "Content-Type: application/json" \
 --data '{"name":"main","mode":"output","output_type_id":"a24a6ea4-ce75-4665-a070-57453082c25","task_type_id":"a24a6ea4-ce75-4665-a070-57453082c25","person_id":"a24a6ea4-ce75-4665-a070-57453082c25","working_file_id":"a24a6ea4-ce75-4665-a070-57453082c25","file_status_id":"a24a6ea4-ce75-4665-a070-57453082c25","comment":"Final render","extension":".mp4","representation":"mp4","revision":1,"nb_elements":1,"sep":"/"}'

Request examples

{
  "name": "main",
  "mode": "output",
  "output_type_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "task_type_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "person_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "working_file_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "file_status_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "comment": "Final render",
  "extension": ".mp4",
  "representation": "mp4",
  "revision": 1,
  "nb_elements": 1,
  "sep": "/"
}

Response examples (201)

{
  "id": "b35b7fb5-df86-5776-b181-68564193d36",
  "name": "main",
  "path": "/project/asset/output/main_v001.mp4",
  "revision": 1,
  "entity_id": "c46c8gc6-eg97-6887-c292-79675204e47",
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-01-01T12:30:00Z"
}

Get next entity output file revision

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

Jwt authorization

Get the next revision number for an output file based on entity, output type, task type, and name. Used for automatic revision numbering.

Path parameters

entity_id string(uuid) Required

Entity unique identifier

application/json

Body Required

name string

File name

Default value is main.
output_type_id string(uuid) Required

Output type identifier
task_type_id string(uuid) Required

Task type identifier

Responses

200 application/json

Next revision number for the output file
Hide response attribute Show response attribute object
- next_revision integer
  
  Next available revision number

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" \
 --header "Content-Type: application/json" \
 --data '{"name":"main","output_type_id":"a24a6ea4-ce75-4665-a070-57453082c25","task_type_id":"b35b7fb5-df86-5776-b181-68564193d36"}'

Request examples

{
  "name": "main",
  "output_type_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "task_type_id": "b35b7fb5-df86-5776-b181-68564193d36"
}

Response examples (200)

{
  "next_revision": 3
}

Get last entity output files

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

Jwt authorization

Retrieve the last revisions of output files for a given entity grouped by output type and file name. Returns the most recent version of each output file.

Path parameters

entity_id string(uuid) Required

Entity unique identifier

Query parameters

output_type_id string(uuid)

Filter by output type
task_type_id string(uuid)

Filter by task type
representation string

Filter by representation
file_status_id string(uuid)

Filter by file status
name string

Filter by file name

Responses

200 application/json

Last revisions of output files grouped by output type and file name
Hide response attribute Show response attribute object
- * object Additional properties
  
  Hide * attributes Show * attributes object
  
  id string(uuid)
  
  Output file unique identifier
  
  name string
  
  Output file name
  
  revision integer
  
  Output file revision
  
  path string
  
  Output file path
  
  updated_at string(date-time)
  
  Last update timestamp

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"

Response examples (200)

{
  "additionalProperty1": {
    "id": "e68e0ie8-gi19-8009-e514-91897426g69",
    "name": "main",
    "revision": 2,
    "path": "/project/asset/output/main_v002.mp4",
    "updated_at": "2023-01-01T12:00:00Z"
  },
  "additionalProperty2": {
    "id": "e68e0ie8-gi19-8009-e514-91897426g69",
    "name": "main",
    "revision": 2,
    "path": "/project/asset/output/main_v002.mp4",
    "updated_at": "2023-01-01T12:00:00Z"
  }
}

Get entity output types

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

Jwt authorization

Retrieve all types of output files generated for a given entity. Returns list of output types available for the entity.

Path parameters

entity_id string(uuid) Required

Entity unique identifier

Responses

200 application/json

All types of output files generated for the entity
Hide response attributes Show response attributes object
- id string(uuid)
  
  Output type unique identifier
- name string
  
  Output type name
- short_name string
  
  Output type short name
- created_at string(date-time)
  
  Creation timestamp
- updated_at string(date-time)
  
  Last update timestamp

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"

Response examples (200)

[
  {
    "id": "b35b7fb5-df86-5776-b181-68564193d36",
    "name": "Cache",
    "short_name": "CACHE",
    "created_at": "2023-01-01T12:00:00Z",
    "updated_at": "2023-01-01T12:30:00Z"
  }
]

Get entity output type files

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

Jwt authorization

Retrieve all output files for a given entity and output type. Optionally filter by representation.

Path parameters

entity_id string(uuid) Required

Entity unique identifier
output_type_id string(uuid) Required

Output type unique identifier

Query parameters

representation string

Filter by representation

Responses

200 application/json

All output files for the entity and output type
Hide response attributes Show response attributes object
- id string(uuid)
  
  Output file unique identifier
- name string
  
  Output file name
- revision integer
  
  Output file revision
- path string
  
  Output file path
- updated_at string(date-time)
  
  Last update timestamp
- entity_id string(uuid)
  
  Entity identifier

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/b35b7fb5-df86-5776-b181-68564193d36/output-files' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {
    "id": "c46c8gc6-eg97-6887-c292-79675204e47",
    "name": "main",
    "revision": 1,
    "path": "/project/asset/output/main_v001.mp4",
    "updated_at": "2023-01-01T12:00:00Z",
    "entity_id": "d57d9hd7-fh08-7998-d403-80786315f58"
  }
]

Get entity output files

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

Jwt authorization

Retrieve all output files for a given entity with optional filtering by output type, task type, representation, file status, and name.

Path parameters

entity_id string(uuid) Required

Entity unique identifier

Query parameters

output_type_id string(uuid)

Filter by output type
task_type_id string(uuid)

Filter by task type
file_status_id string(uuid)

Filter by file status
representation string

Filter by representation
name string

Filter by file name

Responses

200 application/json

All output files for the entity
Hide response attributes Show response attributes object
- id string(uuid)
  
  Output file unique identifier
- name string
  
  Output file name
- revision integer
  
  Output file revision
- path string
  
  Output file path
- updated_at string(date-time)
  
  Last update timestamp
- entity_id string(uuid)
  
  Entity identifier

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

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

Response examples (200)

[
  {
    "id": "e68e0ie8-gi19-8009-e514-91897426g69",
    "name": "main",
    "revision": 1,
    "path": "/project/asset/output/main_v001.mp4",
    "updated_at": "2023-01-01T12:00:00Z",
    "entity_id": "f79f1jf9-hj20-9010-f625-a09008537h80"
  }
]

Get project output files

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

Jwt authorization

Retrieve all output files for a given project with optional filtering by output type, task type, representation, file status, and name.

Path parameters

project_id string(uuid) Required

Project unique identifier

Query parameters

output_type_id string(uuid)

Filter by output type
task_type_id string(uuid)

Filter by task type
file_status_id string(uuid)

Filter by file status
representation string

Filter by representation
name string

Filter by file name

Responses

200 application/json

All output files for the project
Hide response attributes Show response attributes object
- id string(uuid)
  
  Output file unique identifier
- name string
  
  Output file name
- revision integer
  
  Output file revision
- path string
  
  Output file path
- updated_at string(date-time)
  
  Last update timestamp
- project_id string(uuid)
  
  Project identifier

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

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

Response examples (200)

[
  {
    "id": "e68e0ie8-gi19-8009-e514-91897426g69",
    "name": "main",
    "revision": 1,
    "path": "/project/asset/output/main_v001.mp4",
    "updated_at": "2023-01-01T12:00:00Z",
    "project_id": "f79f1jf9-hj20-9010-f625-a09008537h80"
  }
]

Get instance output files

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

Jwt authorization

Retrieve all output files for a given asset instance and temporal entity with optional filtering by output type, task type, representation, file status, and name.

Path parameters

asset_instance_id string(uuid) Required

Asset instance unique identifier

Query parameters

temporal_entity_id string(uuid)

Filter by temporal entity
output_type_id string(uuid)

Filter by output type
task_type_id string(uuid)

Filter by task type
file_status_id string(uuid)

Filter by file status
representation string

Filter by representation
name string

Filter by file name

Responses

200 application/json

All output files for the asset instance and temporal entity
Hide response attributes Show response attributes object
- id string(uuid)
  
  Output file unique identifier
- name string
  
  Output file name
- revision integer
  
  Output file revision
- path string
  
  Output file path
- updated_at string(date-time)
  
  Last update timestamp
- asset_instance_id string(uuid)
  
  Asset instance identifier
- temporal_entity_id string(uuid)
  
  Temporal entity identifier

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

Response examples (200)

[
  {
    "id": "f79f1jf9-hj20-9010-f625-a09008537h80",
    "name": "main",
    "revision": 1,
    "path": "/project/asset/instance/output/main_v001.mp4",
    "updated_at": "2023-01-01T12:00:00Z",
    "asset_instance_id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "temporal_entity_id": "b35b7fb5-df86-5776-b181-68564193d36"
  }
]

Generate entity output file path

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

Jwt authorization

Generate an output file path from file tree template based on entity parameters. Revision can be computed automatically if not provided.

Path parameters

entity_id string(uuid) Required

Entity unique identifier

application/json

Body Required

name string

File name

Default value is main.
mode string

File mode

Default value is output.
output_type_id string(uuid) Required

Output type identifier
task_type_id string(uuid) Required

Task type identifier
extension string

File extension
representation string

File representation
revision integer

File revision number
separator string

Path separator

Default value is /.

Responses

200 application/json

Output file path generated successfully
Hide response attributes Show response attributes object
- folder_path string
  
  Generated folder path
- file_name string
  
  Generated file name
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" \
 --header "Content-Type: application/json" \
 --data '{"name":"main","mode":"output","output_type_id":"a24a6ea4-ce75-4665-a070-57453082c25","task_type_id":"a24a6ea4-ce75-4665-a070-57453082c25","extension":".mp4","representation":"mp4","revision":1,"separator":"/"}'

Request examples

{
  "name": "main",
  "mode": "output",
  "output_type_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "task_type_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "extension": ".mp4",
  "representation": "mp4",
  "revision": 1,
  "separator": "/"
}

Response examples (200)

{
  "folder_path": "/project/asset/output",
  "file_name": "main_v001.mp4"
}

Guess file tree template

POST /data/entities/guess_from_path

Jwt authorization

Get list of possible project file tree templates matching a file path and data ids corresponding to template tokens.

application/json

Body Required

project_id string(uuid) Required

Project unique identifier
file_path string Required

File path to analyze
sep string

Path separator

Default value is /.

Responses

200 application/json

List of possible project file tree templates matching the file path
Hide response attribute Show response attribute object
- matches array[object]
  
  Hide matches attributes Show matches attributes object
  
  template string
  
  Template name
  
  confidence number
  
  Confidence score
  
  data object
  
  Extracted data from path
  
  Hide data attributes Show data attributes object
  
  project_id string(uuid)
  
  Project identifier
  
  entity_id string(uuid)
  
  Entity identifier
400

Invalid project ID or file path

POST /data/entities/guess_from_path

curl \
 --request POST 'http://api.example.com/data/entities/guess_from_path' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"project_id":"a24a6ea4-ce75-4665-a070-57453082c25","file_path":"/project/asset/working/main_v001.blend","sep":"/"}'

Request examples

{
  "project_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "file_path": "/project/asset/working/main_v001.blend",
  "sep": "/"
}

Response examples (200)

{
  "matches": [
    {
      "template": "default",
      "confidence": 0.95,
      "data": {
        "project_id": "a24a6ea4-ce75-4665-a070-57453082c25",
        "entity_id": "b35b7fb5-df86-5776-b181-68564193d36"
      }
    }
  ]
}

Download working file

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

Jwt authorization

Download a working file from storage. Returns the file content with appropriate headers for caching and attachment.

Path parameters

working_file_id string(uuid) Required

Working file unique identifier

Responses

200

image/png

image/png image/jpg image/gif application/octet-stream

Working file downloaded successfully

PNG image file

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"

Response examples (200)

binary data

Store working file

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

Jwt authorization

Store a working file in the file storage system. Uploads the file content and associates it with the working file record.

Path parameters

working_file_id string(uuid) Required

Working file unique identifier

multipart/form-data

Body Required

file string(binary) Required

Working file to upload

Responses

201 application/json

Working file stored successfully
Hide response attributes Show response attributes object
- id string(uuid)
  
  Working file unique identifier
- name string
  
  Working file name
- path string
  
  Working file path
- revision integer
  
  Working file revision
- task_id string(uuid)
  
  Task identifier
- created_at string(date-time)
  
  Creation timestamp
- updated_at string(date-time)
  
  Last update timestamp

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" \
 --header "Content-Type: multipart/form-data" \
 --form "file=file content"

Response examples (201)

{
  "id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "name": "main",
  "path": "/project/asset/working/main_v001.blend",
  "revision": 1,
  "task_id": "b35b7fb5-df86-5776-b181-68564193d36",
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-01-01T12:30:00Z"
}

Set project file tree

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

Jwt authorization

Define a template file to use for a given project. Template files are located on the server side and each template has a name for selection.

Path parameters

project_id string(uuid) Required

Project unique identifier

application/json

Body Required

tree_name string Required

Name of the file tree template

Responses

200 application/json

File tree template set successfully
Hide response attributes Show response attributes object
- id string(uuid)
  
  Project unique identifier
- name string
  
  Project name
- file_tree object
  
  File tree template configuration
- updated_at string(date-time)
  
  Last update timestamp

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" \
 --header "Content-Type: application/json" \
 --data '{"tree_name":"default"}'

Request examples

{
  "tree_name": "default"
}

Response examples (200)

{
  "id": "b35b7fb5-df86-5776-b181-68564193d36",
  "name": "My Project",
  "file_tree": {
    "template": "default"
  },
  "updated_at": "2023-01-01T12:30:00Z"
}

Update working file comment

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

Jwt authorization

Update the comment on a specific working file. Comments provide context about changes made to the working file.

Path parameters

working_file_id string(uuid) Required

Working file unique identifier

application/json

Body Required

comment string Required

Working file comment

Responses

200 application/json

Working file comment updated successfully
Hide response attributes Show response attributes object
- id string(uuid)
  
  Working file unique identifier
- comment string
  
  Updated comment
- updated_at string(date-time)
  
  Last update timestamp

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" \
 --header "Content-Type: application/json" \
 --data '{"comment":"Updated lighting and materials"}'

Request examples

{
  "comment": "Updated lighting and materials"
}

Response examples (200)

{
  "id": "b35b7fb5-df86-5776-b181-68564193d36",
  "comment": "Updated lighting and materials",
  "updated_at": "2023-01-01T12:30:00Z"
}

Update working file modification date

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

Jwt authorization

Update the modification date of a working file to the current timestamp. Used to track when the file was last modified.

Path parameters

working_file_id string(uuid) Required

Working file unique identifier

Responses

200 application/json

Working file modification date updated successfully
Hide response attributes Show response attributes object
- id string(uuid)
  
  Working file unique identifier
- updated_at string(date-time)
  
  Updated modification timestamp

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"

Response examples (200)

{
  "id": "b35b7fb5-df86-5776-b181-68564193d36",
  "updated_at": "2023-01-01T12:30:00Z"
}

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 application/json

API name and version
Hide response attributes Show response attributes object
- api string
- version string

GET /

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

Response examples (200)

{
  "api": "Zou",
  "version": "0.20.0"
}

Get status of the API services

GET /status

Jwt authorization

Responses

200 application/json

Status of the API services
Hide response attributes Show response attributes object
- name string
- version string
- database-up boolean
- key-value-store-up boolean
- event-stream-up boolean
- job-queue-up boolean
- indexer-up boolean

GET /status

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

Response examples (200)

{
  "name": "Zou",
  "version": "0.20.0",
  "database-up": true,
  "key-value-store-up": true,
  "event-stream-up": true,
  "job-queue-up": true,
  "indexer-up": true
}

Get status of the API services for InfluxDB

GET /status/influx

Jwt authorization

Get status of the database, key value store, event stream, job queue, indexer as a JSON object.

Responses

200 application/json

Status of database, key value, event stream, job queue and time
Hide response attributes Show response attributes object
- database-up integer
- key-value-store-up integer
- event-stream-up integer
- job-queue-up integer
- indexer-up integer
- time number(float)

GET /status/influx

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

Response examples (200)

{
  "database-up": 1,
  "key-value-store-up": 1,
  "event-stream-up": 1,
  "job-queue-up": 1,
  "indexer-up": 1,
  "time": 1701948600.123
}

Get resource usage stats

GET /status/resources

Jwt authorization

Get CPU usage for each core, memory repartition and number of jobs in the job queue.

Responses

200 application/json

CPU, memory and jobs stats
Hide response attributes Show response attributes object
- date string(date-time)
- cpu object
  
  Hide cpu attributes Show cpu attributes object
  
  percent array[number]
  
  loadavg object
  
  Hide loadavg attributes Show loadavg attributes object
  
  last 1 min number
  
  last 5 min number
  
  last 10 min number
- memory object
  
  Hide memory attributes Show memory attributes object
  
  total integer
  
  used integer
  
  available integer
  
  percent number
- jobs object
  
  Hide jobs attribute Show jobs attribute object
  
  running_jobs integer

GET /status/resources

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

Response examples (200)

{
  "date": "2023-12-07T10:30:00.000Z",
  "cpu": {
    "percent": [
      25.5,
      30.2,
      28.1
    ],
    "loadavg": {
      "last 1 min": 0.75,
      "last 5 min": 0.82,
      "last 10 min": 0.78
    }
  },
  "memory": {
    "total": 8589934592,
    "used": 4294967296,
    "available": 4294967296,
    "percent": 50.0
  },
  "jobs": {
    "running_jobs": 3
  }
}

Get status of the API services as text

GET /status.txt

Jwt authorization

Get status of the database, key value store, event stream, job queue, the indexer as a text.

Responses

200 text/plain

API name, version and status as txt

GET /status.txt

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

Response examples (200)

name: Zou
version: 0.20.0
database-up: up
event-stream-up: up
key-value-store-up: up
job-queue-up: up
indexer-up: up

Generate a test event

GET /status/test-event

Jwt authorization

Generate a main:test event to test the event stream with the Python client or similar.

Responses

200 application/json

Success flag
Hide response attribute Show response attribute object
- success boolean

GET /status/test-event

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

Response examples (200)

{
  "success": true
}

Get usage stats

GET /stats

Jwt authorization

Get the amount of projects, assets, shots, tasks, and persons.

Responses

200 application/json

Main stats
Hide response attributes Show response attributes object
- projects integer
- assets integer
- shots integer
- tasks integer
- persons integer

GET /stats

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

Response examples (200)

{
  "projects": 15,
  "assets": 1250,
  "shots": 890,
  "tasks": 5670,
  "persons": 45
}

Get the configuration of the Kitsu instance

GET /config

Jwt authorization

The configuration includes self-hosted status, Crisp token, indexer configuration, SAML status, and dark theme status.

Responses

200 application/json

Configuration object
Hide response attributes Show response attributes object
- is_self_hosted boolean
- crisp_token string
- dark_theme_by_default boolean
- indexer_configured boolean
- saml_enabled boolean
- saml_idp_name string
- default_locale string
- default_timezone string
- sentry object
  
  Hide sentry attributes Show sentry attributes object
  
  dsn string
  
  sampleRate number

GET /config

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

Response examples (200)

{
  "is_self_hosted": true,
  "crisp_token": "abc123def456",
  "dark_theme_by_default": false,
  "indexer_configured": true,
  "saml_enabled": false,
  "saml_idp_name": "My Company SSO",
  "default_locale": "en_US",
  "default_timezone": "UTC",
  "sentry": {
    "dsn": "https://example@sentry.io/123456",
    "sampleRate": 0.1
  }
}

Get news from open projects

GET /data/projects/news

Jwt authorization

Returns the latest news and activity feed from all projects the user has access to.

Query parameters

project_id string(uuid)

Filter news by specific project
before string(date)

Filter news before this date
after string(date)

Filter news after this date
page integer

Page number for pagination

Default value is 1.
limit integer

Number of news items per page

Default value is 50.
person_id string(uuid)

Filter news by specific team member
task_type_id string(uuid)

Filter news by task type
task_status_id string(uuid)

Filter news by task status
episode_id string(uuid)

Filter news by specific episode
only_preview boolean

Show only news related to preview uploads

Default value is false.

Responses

200 application/json

News feed successfully retrieved
Hide response attributes Show response attributes object
- data array[object]
  
  Array of news items
- stats object
  
  News statistics
- total integer
  
  Total number of news items

GET /data/projects/news

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

Response examples (200)

{
  "data": [
    {}
  ],
  "stats": {},
  "total": 42
}

Get latest news for a project

GET /data/projects/{project_id}/news

Jwt authorization

Get the 50 latest news object (activity feed) for a project

Path parameters

project_id string(uuid) Required

Unique identifier of the project

Query parameters

before string(date)

Filter news before this date
after string(date)

Filter news after this date
page integer

Page number for pagination

Default value is 1.
limit integer

Number of news items per page

Default value is 50.
person_id string(uuid)

Filter news by specific team member
task_type_id string(uuid)

Filter news by task type
task_status_id string(uuid)

Filter news by task status
episode_id string(uuid)

Filter news by specific episode
only_preview boolean

Show only news related to preview uploads

Default value is false.

Responses

200 application/json

All news related to given project
Hide response attributes Show response attributes object
- data array[object]
  
  Hide data attributes Show data attributes object
  
  id string(uuid)
  
  Unique news item identifier
  
  title string
  
  News item title
  
  content string
  
  created_at string(date-time)
  
  author_id string(uuid)
- stats object
  
  Hide stats attribute Show stats attribute object
  
  total integer
404

Project not found

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"

Response examples (200)

{
  "data": [
    {
      "id": "string",
      "title": "string",
      "content": "string",
      "created_at": "2025-05-04T09:42:00Z",
      "author_id": "string"
    }
  ],
  "stats": {
    "total": 42
  }
}

Get single news item

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

Jwt authorization

Retrieves detailed information about a specific news item from a givenproject.

Path parameters

project_id string(uuid) Required

Unique identifier of the project
news_id string(uuid) Required

Unique identifier of the news item

Responses

200 application/json

News item successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Unique news item identifier
- title string
  
  News item title
- content string
  
  News item content
- created_at string(date-time)
  
  Creation timestamp
- author_id string(uuid)
  
  Author's user ID
- project_id string(uuid)
  
  Project identifier
404

News item or project not found

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"

Response examples (200)

{
  "id": "string",
  "title": "string",
  "content": "string",
  "created_at": "2025-05-04T09:42:00Z",
  "author_id": "string",
  "project_id": "string"
}

Get desktop login logs

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

Jwt authorization

Retrieve desktop login logs for a person. Desktop login logs can only be created by current user.

Responses

200 application/json

Desktop login logs for the person
Hide response attributes Show response attributes object
- id string(uuid)
  
  Log entry unique identifier
- person_id string(uuid)
  
  Person unique identifier
- date string(date-time)
  
  Login date and time

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"

Response examples (200)

[
  {
    "id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "person_id": "b35b7fb5-df86-5776-b181-68564193d36",
    "date": "2022-07-12T10:30:00Z"
  }
]

Create desktop login log

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

Jwt authorization

Add a new log entry for desktop logins for a person.

application/json

Responses

201 application/json

Desktop login log entry created
Hide response attributes Show response attributes object
- id string(uuid)
  
  Log entry unique identifier
- person_id string(uuid)
  
  Person unique identifier
- date string(date-time)
  
  Login date and time
400

Invalid date format

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" \
 --header "Content-Type: application/json" \
 --data '{"date":"2022-07-12"}'

Request examples

{
  "date": "2022-07-12"
}

Response examples (201)

{
  "id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "person_id": "b35b7fb5-df86-5776-b181-68564193d36",
  "date": "2022-07-12T10:30:00Z"
}

Get presence logs

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

Jwt authorization

Return a CSV file containing the presence logs based on a daily basis for the given month.

Path parameters

month_date string(date) Required

Month in YYYY-MM format

Responses

200 text/csv

CSV file containing the presence logs based on daily basis
400

Invalid date format

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

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

Jwt authorization

Get all time spents for the given person. Optionally can accept date range parameters.

Path parameters

person_id string(uuid) Required

Person unique identifier

Query parameters

start_date string(date)

Start date for date range filter
end_date string(date)

End date for date range filter

Responses

200 application/json

All time spents for the given person
Hide response attributes Show response attributes object
- id string(uuid)
  
  Time spent unique identifier
- person_id string(uuid)
  
  Person unique identifier
- duration number(float)
  
  Time spent duration in hours
- date string(date)
  
  Date of time spent entry
400

Invalid date range parameters

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

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

Response examples (200)

[
  {
    "id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "person_id": "b35b7fb5-df86-5776-b181-68564193d36",
    "duration": 8.5,
    "date": "2022-07-12"
  }
]

Get time spents for date

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

Jwt authorization

Get time spents for given person and specific date.

Path parameters

person_id string(uuid) Required

Person unique identifier
date string(date) Required

Date to get time spents for

Responses

200 application/json

Time spents for given person and date
Hide response attributes Show response attributes object
- id string(uuid)
  
  Time spent unique identifier
- person_id string(uuid)
  
  Person unique identifier
- duration number(float)
  
  Time spent duration in hours
- date string(date)
  
  Date of time spent entry
400

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"

Response examples (200)

[
  {
    "id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "person_id": "b35b7fb5-df86-5776-b181-68564193d36",
    "duration": 8.5,
    "date": "2022-07-12"
  }
]

Get day off

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

Jwt authorization

Get day off object for given person and date.

Path parameters

person_id string(uuid) Required

Person unique identifier
date string(date) Required

Date to get day off for

Responses

200 application/json

Day off object for given person and date
Hide response attributes Show response attributes object
- id string(uuid)
  
  Day off unique identifier
- person_id string(uuid)
  
  Person unique identifier
- date string(date)
  
  Day off date
- type string
  
  Day off type
400

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"

Response examples (200)

{
  "id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "person_id": "b35b7fb5-df86-5776-b181-68564193d36",
  "date": "2022-07-12",
  "type": "vacation"
}

Get year time spents

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

Jwt authorization

Get aggregated time spents for given person and year.

Path parameters

person_id string(uuid) Required

Person unique identifier
year integer Required

Year to get aggregated time spents for

Responses

200 application/json

Aggregated time spents for given person and year
Hide response attributes Show response attributes object
- total_duration number(float)
  
  Total duration in hours
- year integer
  
  Year
400

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"

Response examples (200)

{
  "total_duration": 2080.5,
  "year": 2022
}

Get month time spents

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

Jwt authorization

Get aggregated time spents for given person and month.

Path parameters

person_id string(uuid) Required

Person unique identifier
year integer Required

Year to get aggregated time spents for
month integer Required

Month to get aggregated time spents for

Responses

200 application/json

Aggregated time spents for given person and month
Hide response attributes Show response attributes object
- total_duration number(float)
  
  Total duration in hours
- year integer
  
  Year
- month integer
  
  Month
400

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"

Response examples (200)

{
  "total_duration": 173.5,
  "year": 2022,
  "month": 7
}

Get all month time spents

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

Jwt authorization

Get all time spents for a given person and month.

Path parameters

person_id string(uuid) Required

Person unique identifier
year integer Required

Year to get time spents for
month integer Required

Month to get time spents for

Responses

200 application/json

All time spents for the given person and month

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

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

Response examples (200)

[
  {}
]

Get week time spents

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

Jwt authorization

Get aggregated time spents for given person and week.

Path parameters

person_id string(uuid) Required

Person unique identifier
year integer Required

Year to get aggregated time spents for
week integer Required

Week number to get aggregated time spents for

Responses

200 application/json

Aggregated time spents for given person and week
Hide response attributes Show response attributes object
- total_duration number(float)
  
  Total duration in hours
- year integer
  
  Year
- week integer
  
  Week number
400

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"

Response examples (200)

{
  "total_duration": 40.0,
  "year": 2022,
  "week": 35
}

Get day time spents

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

Jwt authorization

Get aggregated time spents for given person and day.

Path parameters

person_id string(uuid) Required

Person unique identifier
year integer Required

Year to get aggregated time spents for
month integer Required

Month to get aggregated time spents for
day integer Required

Day to get aggregated time spents for

Responses

200 application/json

Aggregated time spents for given person and day
Hide response attributes Show response attributes object
- total_duration number(float)
  
  Total duration in hours
- year integer
  
  Year
- month integer
  
  Month
- day integer
  
  Day
400

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"

Response examples (200)

{
  "total_duration": 8.5,
  "year": 2022,
  "month": 7,
  "day": 12
}

Get month quota shots

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

Jwt authorization

Get ended shots used for quota calculation of this month.

Path parameters

person_id string(uuid) Required

Person unique identifier
year integer Required

Year to get quota shots for
month integer Required

Month to get quota shots for

Query parameters

count_mode string

Count mode for quota calculation

Values are weighted, weighteddone, feedback, or done.

Responses

200 application/json

Ended shots used for quota calculation of this month
400

Wrong date format or invalid count mode

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

Response examples (200)

[
  {}
]

Get week quota shots

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

Jwt authorization

Get ended shots used for quota calculation of this week.

Path parameters

person_id string(uuid) Required

Person unique identifier
year integer Required

Year to get quota shots for
week integer Required

Week number to get quota shots for

Query parameters

count_mode string

Count mode for quota calculation

Values are weighted, weighteddone, feedback, or done.

Responses

200 application/json

Ended shots used for quota calculation of this week
400

Wrong date format or invalid count mode

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

Response examples (200)

[
  {}
]

Get day quota shots

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

Jwt authorization

Get ended shots used for quota calculation of this day.

Path parameters

person_id string(uuid) Required

Person unique identifier
year integer Required

Year to get quota shots for
month integer Required

Month to get quota shots for
day integer Required

Day to get quota shots for

Query parameters

count_mode string

Count mode for quota calculation

Values are weighted, weighteddone, feedback, or done.

Responses

200 application/json

Ended shots used for quota calculation of this day
400

Wrong date format or invalid count mode

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

Response examples (200)

[
  {}
]

Get time spent years table

GET /data/persons/time-spents/year-table/

Jwt authorization

Return a table giving time spent by user and by month for all years.

Responses

200 application/json

Table giving time spent by user and by month for all years

GET /data/persons/time-spents/year-table/

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

Response examples (200)

{}

Get time spent months table

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

Jwt authorization

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

Path parameters

year integer Required

Year to get time spent table for

Responses

200 application/json

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"

Response examples (200)

{}

Get time spent weeks table

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

Jwt authorization

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

Path parameters

year integer Required

Year to get time spent table for

Responses

200 application/json

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"

Response examples (200)

{}

Get time spent month table

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

Jwt authorization

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

Path parameters

year integer Required

Year to get time spent table for
month integer Required

Month to get time spent table for

Responses

200 application/json

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"

Response examples (200)

{}

Get day offs for month

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

Jwt authorization

Return all day off recorded for given month. Admins get all day offs, regular users get only their own.

Path parameters

year integer Required

Year to get day offs for
month integer Required

Month to get day offs for

Responses

200 application/json

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"

Response examples (200)

[
  {}
]

Get person week day offs

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

Jwt authorization

Return all day off recorded for given week and person.

Path parameters

person_id string(uuid) Required

Person unique identifier
year integer Required

Year to get day offs for
week integer Required

Week number to get day offs for

Responses

200 application/json

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"

Response examples (200)

[
  {}
]

Get person month day offs

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

Jwt authorization

Return all day off recorded for given month and person.

Path parameters

person_id string(uuid) Required

Person unique identifier
year integer Required

Year to get day offs for
month integer Required

Month to get day offs for

Responses

200 application/json

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"

Response examples (200)

[
  {}
]

Get person year day offs

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

Jwt authorization

Return all day off recorded for given year and person.

Path parameters

person_id string(uuid) Required

Person unique identifier
year integer Required

Year to get day offs for

Responses

200 application/json

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"

Response examples (200)

[
  {}
]

Get person day offs

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

Jwt authorization

Return all day offs recorded for given person.

Path parameters

person_id string(uuid) Required

Person unique identifier

Responses

200 application/json

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"

Response examples (200)

[
  {}
]

Invite person

GET /actions/persons/{person_id}/invite

Jwt authorization

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

Path parameters

person_id string(uuid) Required

Person unique identifier

Responses

200 application/json

Email sent successfully
Hide response attributes Show response attributes object
- success boolean
  
  Success flag
- message string
  
  Success message

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"

Response examples (200)

{
  "success": true,
  "message": "Email sent"
}

Add person to department

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

Jwt authorization

Add a user to given department.

Path parameters

person_id string(uuid) Required

Person unique identifier

application/json

Body Required

department_id string(uuid) Required

Department unique identifier

Responses

201 application/json

User added to given department
Hide response attributes Show response attributes object
- id string(uuid)
  
  Person unique identifier
- department_id string(uuid)
  
  Department unique identifier
400

Invalid department ID

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" \
 --header "Content-Type: application/json" \
 --data '{"department_id":"b35b7fb5-df86-5776-b181-68564193d36"}'

Request examples

{
  "department_id": "b35b7fb5-df86-5776-b181-68564193d36"
}

Response examples (201)

{
  "id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "department_id": "b35b7fb5-df86-5776-b181-68564193d36"
}

Remove person from department

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

Jwt authorization

Remove a user from given department.

Path parameters

person_id string(uuid) Required

Person unique identifier
department_id string(uuid) Required

Department unique identifier

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/b35b7fb5-df86-5776-b181-68564193d36' \
 --header "Authorization: $API_KEY"

Change person password

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

Jwt authorization

Allow admin to change password for given user. 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 string(uuid) Required

Person unique identifier

application/json

Body Required

password string(password) Required

New password
password_2 string(password) Required

Password confirmation

Responses

200 application/json

Password changed successfully
Hide response attribute Show response attribute object
- success boolean
  
  Success flag
400 application/json

Invalid password or inactive user
Hide response attributes Show response attributes object
- error boolean
  
  Error flag
- message string
  
  Error message

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" \
 --header "Content-Type: application/json" \
 --data '{"password":"newSecurePassword123","password_2":"newSecurePassword123"}'

Request examples

{
  "password": "newSecurePassword123",
  "password_2": "newSecurePassword123"
}

Response examples (200)

{
  "success": true
}

Response examples (400)

{
  "error": true,
  "message": "Password is too short."
}

Disable two factor authentication

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

Jwt authorization

Allow admin to disable two factor authentication for given user. An admin can't disable two factor authentication for other admins.

Path parameters

person_id string(uuid) Required

Person unique identifier

Responses

200 application/json

Two factor authentication disabled successfully
Hide response attribute Show response attribute object
- success boolean
  
  Success flag
400 application/json

Inactive user or two factor authentication not enabled
Hide response attributes Show response attributes object
- error boolean
  
  Error flag
- message string
  
  Error message

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"

Response examples (200)

{
  "success": true
}

Response examples (400)

{
  "error": true,
  "message": "User is unactive."
}

Clear person avatar

DELETE /actions/persons/{person_id}/clear-avatar

Jwt authorization

Set has_avatar flag to False for current user and remove its avatar file.

Path parameters

person_id string(uuid) Required

Person unique identifier

Responses

204

Avatar file deleted

DELETE /actions/persons/{person_id}/clear-avatar

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

Get project playlists

GET /data/projects/{project_id}/playlists

Jwt authorization

Retrieve all playlists related to given project. Result is paginated and can be sorted.

Path parameters

project_id string(uuid) Required

Project unique identifier

Query parameters

page integer

Page number for pagination
sort_by string

Field to sort by
task_type_id string(uuid)

Task type unique identifier to filter by

Responses

200 application/json

All playlists related to given project
Hide response attributes Show response attributes object
- id string(uuid)
  
  Playlist unique identifier
- name string
  
  Playlist name
- project_id string(uuid)
  
  Project unique identifier

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"

Response examples (200)

[
  {
    "id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "name": "Review Playlist",
    "project_id": "b35b7fb5-df86-5776-b181-68564193d36"
  }
]

Get all project playlists

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

Jwt authorization

Retrieve all playlists related to given project. It's mainly used for synchronisation purpose.

Path parameters

project_id string(uuid) Required

Project unique identifier

Responses

200 application/json

All playlists related to given project
Hide response attributes Show response attributes object
- id string(uuid)
  
  Playlist unique identifier
- name string
  
  Playlist name
- project_id string(uuid)
  
  Project unique identifier

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"

Response examples (200)

[
  {
    "id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "name": "Review Playlist",
    "project_id": "b35b7fb5-df86-5776-b181-68564193d36"
  }
]

Get episode playlists

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

Jwt authorization

Retrieve all playlists related to given episode. The full list is returned because the number of playlists in an episode is not that big.

Path parameters

project_id string(uuid) Required

Project unique identifier
episode_id string(uuid) Required

Episode unique identifier or special value (main, all)

Responses

200 application/json

All playlists related to given episode
Hide response attributes Show response attributes object
- id string(uuid)
  
  Playlist unique identifier
- name string
  
  Playlist name
- episode_id string(uuid)
  
  Episode unique identifier

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"

Response examples (200)

[
  {
    "id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "name": "Review Playlist",
    "episode_id": "b35b7fb5-df86-5776-b181-68564193d36"
  }
]

Get playlist

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

Jwt authorization

Retrieve a specific playlist by ID with preview file revisions.

Path parameters

project_id string(uuid) Required

Project unique identifier
playlist_id string(uuid) Required

Playlist unique identifier

Responses

200 application/json

Playlist details with preview file revisions
Hide response attributes Show response attributes object
- id string(uuid)
  
  Playlist unique identifier
- name string
  
  Playlist name
- project_id string(uuid)
  
  Project unique identifier
- shots array[object]
  
  List of shots with preview file revisions

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

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

Response examples (200)

{
  "id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "name": "Review Playlist",
  "project_id": "b35b7fb5-df86-5776-b181-68564193d36",
  "shots": [
    {
      "id": "uuid",
      "preview_file_id": "uuid"
    }
  ]
}

Get entity previews

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

Jwt authorization

Retrieve all previews related to a given entity. It sends them as a dict. Keys are related task type ids and values are arrays of preview for this task type.

Path parameters

entity_id string(uuid) Required

Entity unique identifier

Responses

200 application/json

All previews related to given entity grouped by task type
Hide response attribute Show response attribute object
- * array[object] Additional properties
  
  Hide * attributes Show * attributes object
  
  id string(uuid)
  
  Preview file unique identifier
  
  name string
  
  Preview file name

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"

Response examples (200)

{
  "additionalProperty1": [
    {
      "id": "a24a6ea4-ce75-4665-a070-57453082c25",
      "name": "preview_v001.png"
    }
  ],
  "additionalProperty2": [
    {
      "id": "a24a6ea4-ce75-4665-a070-57453082c25",
      "name": "preview_v001.png"
    }
  ]
}

Get build job

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

Jwt authorization

Retrieve build job related to given playlist.

Path parameters

playlist_id string(uuid) Required

Playlist unique identifier
build_job_id string(uuid) Required

Build job unique identifier

Responses

200 application/json

Build job related to given playlist
Hide response attributes Show response attributes object
- id string(uuid)
  
  Build job unique identifier
- status string
  
  Build job status
- created_at string(date-time)
  
  Build job creation timestamp

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

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

Response examples (200)

{
  "id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "status": "succeeded",
  "created_at": "2022-07-12T10:30:00Z"
}

Delete build job

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

Jwt authorization

Remove given build job related to given playlist.

Path parameters

playlist_id string(uuid) Required

Playlist unique identifier
build_job_id string(uuid) Required

Build job unique identifier

Responses

204

Build job removed successfully

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

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

Get project build jobs

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

Jwt authorization

Retrieve all build jobs related to given project. It's mainly used for synchronisation purpose.

Path parameters

project_id string(uuid) Required

Project unique identifier

Responses

200 application/json

All build jobs related to given project
Hide response attributes Show response attributes object
- id string(uuid)
  
  Build job unique identifier
- status string
  
  Build job status
- created_at string(date-time)
  
  Build job creation timestamp

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"

Response examples (200)

[
  {
    "id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "status": "succeeded",
    "created_at": "2022-07-12T10:30:00Z"
  }
]

Build playlist movie

GET /data/playlists/{playlist_id}/build/mp4

Jwt authorization

Build given playlist as MP4 movie. Starts a build job that processes the playlist shots into a video file.

Path parameters

playlist_id string(uuid) Required

Playlist unique identifier

Query parameters

full boolean

Whether to build full quality movie

Responses

200 application/json

Build job created for playlist movie
Hide response attributes Show response attributes object
- id string(uuid)
  
  Build job unique identifier
- status string
  
  Build job status
- created_at string(date-time)
  
  Build job creation timestamp

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"

Response examples (200)

{
  "id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "status": "pending",
  "created_at": "2022-07-12T10:30:00Z"
}

Download playlist build

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

Jwt authorization

Download given playlist build as MP4 file.

Path parameters

playlist_id string(uuid) Required

Playlist unique identifier
build_job_id string(uuid) Required

Build job unique identifier

Responses

200 video/mp4

Playlist build downloaded as MP4 file
400 application/json

Build not finished, need to retry later
Hide response attributes Show response attributes object
- error boolean
  
  Error flag
- message string
  
  Error message

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/b35b7fb5-df86-5776-b181-68564193d36/build/mp4' \
 --header "Authorization: $API_KEY"

Response examples (400)

{
  "error": true,
  "message": "Build is not finished"
}

Download playlist zip

GET /data/playlists/{playlist_id}/download/zip

Jwt authorization

Download given playlist as ZIP file containing all preview files.

Path parameters

playlist_id string(uuid) Required

Playlist unique identifier

Responses

200 application/zip

Playlist downloaded as ZIP file

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"

Generate temp playlist

POST /data/projects/{project_id}/playlists/temp

Jwt authorization

Generate a temporary playlist from task IDs. It's mainly used for synchronisation purpose.

Path parameters

project_id string(uuid) Required

Project unique identifier

Query parameters

sort boolean

Whether to sort the playlist

application/json

Body Required

task_ids array[string(uuid)] Required

List of task unique identifiers

Responses

200 application/json

Temporary playlist generated
Hide response attributes Show response attributes object
- id string(uuid)
  
  Preview file unique identifier
- name string
  
  Preview file name
400

Invalid task IDs

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" \
 --header "Content-Type: application/json" \
 --data '{"task_ids":["a24a6ea4-ce75-4665-a070-57453082c25"]}'

Request examples

{
  "task_ids": [
    "a24a6ea4-ce75-4665-a070-57453082c25"
  ]
}

Response examples (200)

[
  {
    "id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "name": "preview_v001.png"
  }
]

Notify clients playlist ready

POST /data/playlists/{playlist_id}/notify-clients

Jwt authorization

Notify clients that given playlist is ready for review.

Path parameters

playlist_id string(uuid) Required

Playlist unique identifier

application/json

Body

studio_id string(uuid)

Studio unique identifier to notify

Responses

200 application/json

Clients notified successfully
Hide response attribute Show response attribute object
- status string
  
  Notification status

POST /data/playlists/{playlist_id}/notify-clients

curl \
 --request POST 'http://api.example.com/data/playlists/a24a6ea4-ce75-4665-a070-57453082c25/notify-clients' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"studio_id":"b35b7fb5-df86-5776-b181-68564193d36"}'

Request examples

{
  "studio_id": "b35b7fb5-df86-5776-b181-68564193d36"
}

Response examples (200)

{
  "status": "success"
}

Get running preview files

GET /data/playlists/preview-files/running

Jwt authorization

Retrieve all preview files from open productions with states equal to processing or broken.

Responses

200 application/json

All preview files from open productions with processing or broken states
Hide response attributes Show response attributes object
- id string(uuid)
  
  Preview file unique identifier
- status string
  
  Preview file status

GET /data/playlists/preview-files/running

curl \
 --request GET 'http://api.example.com/data/playlists/preview-files/running' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {
    "id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "status": "processing"
  }
]

Create preview file

POST /pictures/preview-files/{instance_id}

Jwt authorization

Main resource to add a preview. It stores the preview file and generates three picture files (thumbnails) matching preview when it's possible, a square thumbnail, a rectangle thumbnail and a midsize file.

Path parameters

instance_id string(uuid) Required

Preview file unique identifier

Responses

201 application/json

Preview file added successfully
Hide response attributes Show response attributes object
- id string(uuid)
  
  Preview file unique identifier
- extension string
  
  File extension
- file_size integer
  
  File size in bytes
400

Wrong file format or normalization failed

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"

Response examples (201)

{
  "id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "extension": "png",
  "file_size": 1024000
}

Get preview movie

GET /movies/originals/preview-files/{instance_id}.mp4

Jwt authorization

Download a movie preview file.

Path parameters

instance_id string(uuid) Required

Preview file unique identifier

Responses

200 video/mp4

Movie preview downloaded

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 preview movie

GET /movies/originals/preview-files/{instance_id}/download

Jwt authorization

Download a movie preview file as attachment.

Path parameters

instance_id string(uuid) Required

Preview file unique identifier

Responses

200 video/mp4

Movie preview downloaded as attachment

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"

Get preview lowdef movie

GET /movies/low/preview-files/{instance_id}.mp4

Jwt authorization

Download a low definition movie preview file. Falls back to full quality if lowdef version is not available.

Path parameters

instance_id string(uuid) Required

Preview file unique identifier

Responses

200 video/mp4

Low definition movie preview downloaded

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"

Get preview thumbnail

GET /pictures/thumbnails/preview-files/{instance_id}.png

Jwt authorization

Download a thumbnail for a preview file.

Path parameters

instance_id string(uuid) Required

Preview file unique identifier

Responses

200 image/png

Preview thumbnail downloaded

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"

Get attachment thumbnail

GET /pictures/thumbnails/attachment-files/{attachment_file_id}.png

Jwt authorization

Download the thumbnail representing given attachment file.

Path parameters

attachment_file_id string(uuid) Required

Attachment file unique identifier

Responses

200 image/png

Attachment thumbnail downloaded

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"

Get preview thumbnail

GET /pictures/thumbnails-square/preview-files/{instance_id}.png

Jwt authorization

Download a thumbnail for a preview file.

Path parameters

instance_id string(uuid) Required

Preview file unique identifier

Responses

200 image/png

Preview thumbnail downloaded

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"

Get preview thumbnail

GET /pictures/originals/preview-files/{instance_id}.png

Jwt authorization

Download a thumbnail for a preview file.

Path parameters

instance_id string(uuid) Required

Preview file unique identifier

Responses

200 image/png

Preview thumbnail downloaded

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"

Get preview file

GET /pictures/originals/preview-files/{instance_id}.{extension}

Jwt authorization

Download a generic file preview by extension.

Path parameters

instance_id string(uuid) Required

Preview file unique identifier
extension string Required

File extension

Responses

200 application/octet-stream

Generic file preview downloaded

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

Download preview file

GET /pictures/originals/preview-files/{instance_id}/download

Jwt authorization

Download a generic file preview as attachment.

Path parameters

instance_id string(uuid) Required

Preview file unique identifier

Responses

200 application/octet-stream

Generic file preview downloaded as attachment

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"

Get preview thumbnail

GET /pictures/previews/preview-files/{instance_id}.png

Jwt authorization

Download a thumbnail for a preview file.

Path parameters

instance_id string(uuid) Required

Preview file unique identifier

Responses

200 image/png

Preview thumbnail downloaded

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"

Get preview thumbnail

GET /movies/tiles/preview-files/{instance_id}.png

Jwt authorization

Download a thumbnail for a preview file.

Path parameters

instance_id string(uuid) Required

Preview file unique identifier

Responses

200 image/png

Preview thumbnail downloaded

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"

Get thumbnail

GET /pictures/thumbnails/organisations/{instance_id}

Jwt authorization

Download the thumbnail linked to given object instance.

Path parameters

instance_id string(uuid) Required

Object instance unique identifier

Responses

200 image/png

Thumbnail downloaded

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 thumbnail

POST /pictures/thumbnails/organisations/{instance_id}

Jwt authorization

Create a thumbnail for given object instance.

Path parameters

instance_id string(uuid) Required

Object instance unique identifier

Responses

201 application/json

Thumbnail created successfully
Hide response attribute Show response attribute object
- thumbnail_path string
  
  URL path to the thumbnail

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"

Response examples (201)

{
  "thumbnail_path": "/api/thumbnails/persons/uuid"
}

Get thumbnail

GET /pictures/thumbnails/organisations/{instance_id}.png

Jwt authorization

Download the thumbnail linked to given object instance.

Path parameters

instance_id string(uuid) Required

Object instance unique identifier

Responses

200 image/png

Thumbnail downloaded

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 thumbnail

POST /pictures/thumbnails/organisations/{instance_id}.png

Jwt authorization

Create a thumbnail for given object instance.

Path parameters

instance_id string(uuid) Required

Object instance unique identifier

Responses

201 application/json

Thumbnail created successfully
Hide response attribute Show response attribute object
- thumbnail_path string
  
  URL path to the thumbnail

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"

Response examples (201)

{
  "thumbnail_path": "/api/thumbnails/persons/uuid"
}

Get thumbnail

GET /pictures/thumbnails/persons/{instance_id}

Jwt authorization

Download the thumbnail linked to given object instance.

Path parameters

instance_id string(uuid) Required

Object instance unique identifier

Responses

200 image/png

Thumbnail downloaded

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 thumbnail

POST /pictures/thumbnails/persons/{instance_id}

Jwt authorization

Create a thumbnail for given object instance.

Path parameters

instance_id string(uuid) Required

Object instance unique identifier

Responses

201 application/json

Thumbnail created successfully
Hide response attribute Show response attribute object
- thumbnail_path string
  
  URL path to the thumbnail

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"

Response examples (201)

{
  "thumbnail_path": "/api/thumbnails/persons/uuid"
}

Get thumbnail

GET /pictures/thumbnails/persons/{instance_id}.png

Jwt authorization

Download the thumbnail linked to given object instance.

Path parameters

instance_id string(uuid) Required

Object instance unique identifier

Responses

200 image/png

Thumbnail downloaded

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 thumbnail

POST /pictures/thumbnails/persons/{instance_id}.png

Jwt authorization

Create a thumbnail for given object instance.

Path parameters

instance_id string(uuid) Required

Object instance unique identifier

Responses

201 application/json

Thumbnail created successfully
Hide response attribute Show response attribute object
- thumbnail_path string
  
  URL path to the thumbnail

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"

Response examples (201)

{
  "thumbnail_path": "/api/thumbnails/persons/uuid"
}