Resource to allow a user to disable OTP by email.

DELETE /auth/email-otp
Jwt authorization

Responses

  • 200

    OTP by email disabled.

  • 400

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

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

Retrieve all tasks related to given asset.

GET /data/assets/{asset_id}/tasks
Jwt authorization

Responses

  • 200

    All tasks related to given asset

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

Retrieve all asset instances instantiated inside given asset.

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

Responses

  • 200

    All asset instances instantiated inside given asset

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

Retrieve all asset types for given project.

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

Responses

  • 200

    All asset types for given project

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

Resource to retrieve the casting of shots from given episode.

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

Responses

  • 200

    Casting for all shots from given episode.

GET /data/projects/{project_id}/episodes/{episode_id}/sequences/all/casting 
curl \
 --request GET 'http://api.example.com/data/projects/{project_id}/episodes/{episode_id}/sequences/all/casting' \
 --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

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/{instance_id}' \
 --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

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/{instance_id}' \
 --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

Responses

GET /data/file-status/{instance_id} 
curl \
 --request GET 'http://api.example.com/data/file-status/{instance_id}' \
 --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

POST /data/working-files 
curl \
 --request POST 'http://api.example.com/data/working-files' \
 --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.

Responses

PUT /data/comments/{instance_id} 
curl \
 --request PUT 'http://api.example.com/data/comments/{instance_id}' \
 --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

POST /data/time-spents/ 
curl \
 --request POST 'http://api.example.com/data/time-spents/' \
 --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

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

Retrieve all entries for given model.

GET /data/playlists/
Jwt authorization

Filters can be specified in the query string.

Responses

GET /data/playlists/ 
curl \
 --request GET 'http://api.example.com/data/playlists/' \
 --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

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

DELETE /data/search-filters/{instance_id} 
curl \
 --request DELETE 'http://api.example.com/data/search-filters/{instance_id}' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/search-filter-groups/
Jwt authorization

Filters can be specified in the query string.

Responses

GET /data/search-filter-groups/ 
curl \
 --request GET 'http://api.example.com/data/search-filter-groups/' \
 --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

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/entity-links/
Jwt authorization

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

Responses

POST /data/entity-links/ 
curl \
 --request POST 'http://api.example.com/data/entity-links/' \
 --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.

Responses

PUT /data/chats/{instance_id} 
curl \
 --request PUT 'http://api.example.com/data/chats/{instance_id}' \
 --header "Authorization: $API_KEY"

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

DELETE /data/chats/{instance_id}
Jwt authorization

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/{instance_id}' \
 --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

Responses

GET /data/chat-messages/{instance_id} 
curl \
 --request GET 'http://api.example.com/data/chat-messages/{instance_id}' \
 --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

Responses

GET /data/studios/{instance_id} 
curl \
 --request GET 'http://api.example.com/data/studios/{instance_id}' \
 --header "Authorization: $API_KEY"

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

DELETE /data/salary-scales/{instance_id}
Jwt authorization

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/{instance_id}' \
 --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

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

Retrieve all edits related to a given project.

GET /data/projects/{project_id}/edits
Jwt authorization

Responses

  • 200

    All edits related to given project

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

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

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

Path parameters

Responses

  • 200

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

POST /data/entities/{entity_id}/output-files/next-revision 
curl \
 --request POST 'http://api.example.com/data/entities/{entity_id}/output-files/next-revision' \
 --header "Authorization: $API_KEY"

Update working file modification date with current date.

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

Responses

  • 200

    Working file modification date updated

PUT /actions/working-files/{working_file_id}/modified 
curl \
 --request PUT 'http://api.example.com/actions/working-files/{working_file_id}/modified' \
 --header "Authorization: $API_KEY"

Import shotgun resource.

POST /import/shotgun/persons
Jwt authorization

Responses

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

Import remove instance.

POST /import/shotgun/remove/asset
Jwt authorization

Responses

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

Import Kitsu resource.

POST /import/kitsu/entity-links
Jwt authorization

Responses

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

Create desktop login logs.

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

Add a new log entry for desktop logins.

Path parameters

Responses

  • 201

    Desktop login log entry created.

POST /data/persons/{person_id}/desktop-login-logs 
curl \
 --request POST 'http://api.example.com/data/persons/{person_id}/desktop-login-logs' \
 --header "Authorization: $API_KEY"

Get time spents for given person and date.

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

Responses

  • 200

    Time spents for given person and date

  • 404

    Wrong date format

GET /data/persons/{person_id}/time-spents/{date} 
curl \
 --request GET 'http://api.example.com/data/persons/{person_id}/time-spents/{date}' \
 --header "Authorization: $API_KEY"

Get aggregated time spents for given person and month.

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

Responses

  • 200

    Aggregated time spents for given person and month

  • 404

    Wrong date format

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

Main resource to add a preview.

POST /pictures/preview-files/{instance_id}
Jwt authorization

It stores the preview file and generates three picture files matching preview when it's possible: a square thumbnail, a rectangle thumbnail and a midsize file.

Path parameters

Responses

POST /pictures/preview-files/{instance_id} 
curl \
 --request POST 'http://api.example.com/pictures/preview-files/{instance_id}' \
 --header "Authorization: $API_KEY"

Download a lowdef movie preview.

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

Responses

  • 200

    Lowdef movie preview downloaded

  • 403

    Instance not allowed

  • 404

    File not found

GET /movies/low/preview-files/{instance_id}.mp4 
curl \
 --request GET 'http://api.example.com/movies/low/preview-files/{instance_id}.mp4' \
 --header "Authorization: $API_KEY"

Download a thumbnail.

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

Responses

  • 200

    Thumbnail downloaded

  • 403

    Instance not allowed

  • 404

    Picture file not found

GET /pictures/thumbnails-square/preview-files/{instance_id}.png 
curl \
 --request GET 'http://api.example.com/pictures/thumbnails-square/preview-files/{instance_id}.png' \
 --header "Authorization: $API_KEY"

Allow to modify the annotations stored at the preview level.

PUT /actions/preview-files/{preview_file_id}/update-annotations
Jwt authorization

Modifications are applied via three fields:

  • annotations to give all the annotations that need to be added.

  • updates that list annotations that needs to be modified.

  • deletions to list the IDs of annotations that needs to be removed.

Responses

  • 200

    Orders of previews changed for a single revision

PUT /actions/preview-files/{preview_file_id}/update-annotations 
curl \
 --request PUT 'http://api.example.com/actions/preview-files/{preview_file_id}/update-annotations' \
 --header "Authorization: $API_KEY"

Add a task type linked to a production.

POST /data/projects/{project_id}/settings/task-types
Jwt authorization

Path parameters

Responses

  • 201

    Asset type added to production

POST /data/projects/{project_id}/settings/task-types 
curl \
 --request POST 'http://api.example.com/data/projects/{project_id}/settings/task-types' \
 --header "Authorization: $API_KEY"

Get a metadata descriptor.

GET /data/projects/{project_id}/metadata-descriptors/{descriptor_id}
Jwt authorization

Descriptors serve to describe extra fields listed in the data attribute of entities.

Responses

  • 200

    Metadata descriptor

GET /data/projects/{project_id}/metadata-descriptors/{descriptor_id} 
curl \
 --request GET 'http://api.example.com/data/projects/{project_id}/metadata-descriptors/{descriptor_id}' \
 --header "Authorization: $API_KEY"

Retrieve all assets for a given shot.

GET /data/shots/{shot_id}/assets
Jwt authorization

Responses

  • 200

    All assets for given shot

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

Retrieve all episode entries.

GET /data/episodes
Jwt authorization

Filters can be specified in the query string.

Responses

  • 200

    All episode entries

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

Retrieve all scenes related to a given sequence.

GET /data/sequences/{sequence_id}/scenes
Jwt authorization

Responses

  • 200

    All scenes related to given sequence

GET /data/sequences/{sequence_id}/scenes 
curl \
 --request GET 'http://api.example.com/data/sequences/{sequence_id}/scenes' \
 --header "Authorization: $API_KEY"

Retrieve all tasks related to a given shot.

GET /data/sequences/{sequence_id}/tasks
Jwt authorization

Responses

  • 200

    All tasks related to given shot

GET /data/sequences/{sequence_id}/tasks 
curl \
 --request GET 'http://api.example.com/data/sequences/{sequence_id}/tasks' \
 --header "Authorization: $API_KEY"

Return a task with many information.

GET /data/tasks/{task_id}/full
Jwt authorization

Full details for assignees, full details for task type, full details for task status, etc.

Responses

  • 200

    Task with many information

GET /data/tasks/{task_id}/full 
curl \
 --request GET 'http://api.example.com/data/tasks/{task_id}/full' \
 --header "Authorization: $API_KEY"

Assign given task list to given person.

PUT /actions/tasks/{task_id}/assign
Jwt authorization

Responses

  • 200

    Given task assigned to given person

  • 400

    Assignee non-existent in database

PUT /actions/tasks/{task_id}/assign 
curl \
 --request PUT 'http://api.example.com/actions/tasks/{task_id}/assign' \
 --header "Authorization: $API_KEY"

Create a new task for given shot and task type.

POST /actions/projects/{project_id}/task-types/{task_type_id}/shots/create-tasks
Jwt authorization

Path parameters

Responses

  • 201

    New task for given shot and task type created

POST /actions/projects/{project_id}/task-types/{task_type_id}/shots/create-tasks 
curl \
 --request POST 'http://api.example.com/actions/projects/{project_id}/task-types/{task_type_id}/shots/create-tasks' \
 --header "Authorization: $API_KEY"

Create a new task for given asset and task type.

POST /actions/projects/{project_id}/task-types/{task_type_id}/assets/create-tasks
Jwt authorization

Path parameters

Responses

  • 201

    New task for given asset and task type created

POST /actions/projects/{project_id}/task-types/{task_type_id}/assets/create-tasks 
curl \
 --request POST 'http://api.example.com/actions/projects/{project_id}/task-types/{task_type_id}/assets/create-tasks' \
 --header "Authorization: $API_KEY"

Return tasks requiring feedback for current user departments.

GET /data/user/tasks-to-check
Jwt authorization


If the user is not a supervisor, it returns an empty list.

Responses

  • 200

    Tasks requiring feedback in current user departments.

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

Retrieve filters for current user and only for open projects.

GET /data/user/filters
Jwt authorization

Responses

  • 200

    Filters for current user and only for open projects

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

Return last 100 user notifications filtered by given parameters.

GET /data/user/notifications
Jwt authorization

Responses

  • 200

    100 last user notifications

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

Return notification matching given id, only if it's a notification that

GET /data/user/notifications/{notification_id}
Jwt authorization

belongs to current user.

Responses

  • 200

    Notification matching given ID

GET /data/user/notifications/{notification_id} 
curl \
 --request GET 'http://api.example.com/data/user/notifications/{notification_id}' \
 --header "Authorization: $API_KEY"

Return chats where user is participant.

GET /data/user/chats
Jwt authorization

Responses

  • 200

    Chats where user is participant

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

Create a subscription entry for given sequence,

POST /actions/user/sequences/{sequence_id}/task-types/{task_type_id}/subscribe
Jwt authorization

task type and current user.

Path parameters

Responses

  • 201

    Subscription entry created

POST /actions/user/sequences/{sequence_id}/task-types/{task_type_id}/subscribe 
curl \
 --request POST 'http://api.example.com/actions/user/sequences/{sequence_id}/task-types/{task_type_id}/subscribe' \
 --header "Authorization: $API_KEY"