Authentication

Jwt authorization (http_api_key)

Format in header: Authorization: Bearer {token}.

Value example: Bearer xxxxx.yyyyy.zzzzz

Resource to allow a user to enable OTP by email.

POST /auth/email-otp
Jwt authorization

Responses

  • 200

    OTP by email enabled

  • 400

    Invalid password Wrong or expired token Inactive user

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

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

PUT /auth/fido
Jwt authorization

Responses

  • 200

    FIDO device pre-registered.

  • 400

    Invalid password Wrong or expired token Inactive user

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

Resource to allow a user to register a FIDO device.

POST /auth/fido
Jwt authorization

Responses

  • 200

    FIDO device registered.

  • 400

    Invalid password Wrong or expired token Inactive user

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

Delete given asset.

DELETE /data/assets/{asset_id}
Jwt authorization

Responses

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

Retrieve all assets linked to given asset.

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

Responses

  • 200

    All assets linked to given asset

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

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

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

Responses

  • 200

    Casting of assets from given asset type

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

Resource to retrieve the casting of episodes.

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

Responses

  • 200

    Casting of episodes

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

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

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

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

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

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

Responses

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

Update a model with data given in the request body.

PUT /data/metadata-descriptors/{instance_id}
Jwt authorization

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

Responses

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

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

DELETE /data/metadata-descriptors/{instance_id}
Jwt authorization

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

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

Retrieve all tasks related to a given edit.

GET /data/edits/{edit_id}/tasks
Jwt authorization

Responses

  • 200

    All tasks related to given edit

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

Export

Export a given playlist as csv.

GET /export/csv/playlists/{playlist_id}
Jwt authorization

Responses

  • 200

    Playlist exported as csv

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

Export as csv.

GET /export/csv/time-spents.csv
Jwt authorization

Responses

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

Get all output files for given entity.

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

Responses

  • 200

    All output files for given entity

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

Update comment on given working file.

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

Responses

  • 200

    Comment updated on given working file

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

Import shotgun resource.

POST /import/shotgun/sequences
Jwt authorization

Responses

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

Import remove instance.

POST /import/shotgun/remove/status
Jwt authorization

Responses

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

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/version
Jwt authorization

Responses

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

Index

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"

Return all day off recorded for given week and person.

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

Responses

  • 200

    All day off recorded for given week and person

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

Allow admin to change password for given user.

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

Prior to modifying the password, it requires to be admin. An admin can't change other admins password. The new password requires a confirmation to ensure that the admin didn't make a mistake by typing the new password.

Path parameters

Responses

  • 200

    Password changed

  • 400

    Invalid password or inactive user

POST /actions/persons/{person_id}/change-password 
curl \
 --request POST 'http://api.example.com/actions/persons/{person_id}/change-password' \
 --header "Authorization: $API_KEY"

Retrieve all playlists related to given project.

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

It's mainly used for synchronisation purpose.

Path parameters

Responses

  • 200

    All playlists related to given project

POST /data/projects/{project_id}/playlists/temp 
curl \
 --request POST 'http://api.example.com/data/projects/{project_id}/playlists/temp' \
 --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"

Download the thumbnail linked to given object instance.

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

Responses

  • 200

    Thumbnail downloaded

  • 403

    Access not allowed

  • 404

    Object instance not found

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

Remove people listed in a production team.

DELETE /data/projects/{project_id}/team/{person_id}
Jwt authorization

Responses

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

Return preview background files linked to a production

GET /data/projects/{project_id}/settings/preview-background-files
Jwt authorization

Responses

  • 200

    Preview background files linked to production

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

Add a preview background file linked to a production.

POST /data/projects/{project_id}/settings/preview-background-files
Jwt authorization

Path parameters

Responses

  • 201

    Preview background file added to production

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

Search

Retrieve all scene entries.

GET /data/scenes/all
Jwt authorization

Filters can be specified in the query string.

Responses

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

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

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

Retrieve all tasks related to a given scene.

GET /data/scenes/{scene_id}/tasks
Jwt authorization

Responses

  • 200

    All tasks related to given scene

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

Delete given episode.

DELETE /data/episodes/{episode_id}
Jwt authorization

Responses

  • 204

    Given episode deleted

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

Preview files related to a given project.

GET /data/projects/{project_id}/preview-files
Jwt authorization

Responses

  • 200

    Preview files related to given project

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

Delete tasks matching id list given in parameter.

POST /actions/projects/{project_id}/delete-tasks
Jwt authorization

See it as a way to batch delete tasks.

Path parameters

Responses

  • 200

    Tasks matching id list given in parameter deleted

POST /actions/projects/{project_id}/delete-tasks 
curl \
 --request POST 'http://api.example.com/actions/projects/{project_id}/delete-tasks' \
 --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"

Get time spent on a given task and date.

GET /actions/tasks/{task_id}/time-spents/{date}
Jwt authorization

Responses

  • 200

    Time spent on given task and date

  • 404

    Wrong date format

GET /actions/tasks/{task_id}/time-spents/{date} 
curl \
 --request GET 'http://api.example.com/actions/tasks/{task_id}/time-spents/{date}' \
 --header "Authorization: $API_KEY"

Create a new task with given task type for each entity of given

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

entity type.

Path parameters

Responses

  • 201

    List of created tasks.

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

Return tasks related to given scene for current user.

GET /data/user/scenes/{scene_id}/task-types
Jwt authorization

Responses

  • 200

    Tasks related to given scene for current user

GET /data/user/scenes/{scene_id}/task-types 
curl \
 --request GET 'http://api.example.com/data/user/scenes/{scene_id}/task-types' \
 --header "Authorization: $API_KEY"

Return tasks related to given sequence for current user.

GET /data/user/sequences/{sequence_id}/task-types
Jwt authorization

Responses

  • 200

    Tasks related to given sequence for current user

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

Create filter group for current user and only for open projects.

POST /data/user/filter-groups
Jwt authorization

Responses

  • 201

    Filter groups for the current user and only for open projects created.

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

Retrieve given filter group for the current user.

GET /data/user/filter-groups/{filter_group_id}
Jwt authorization

Responses

  • 200

    Filter groups for the current user and only for open projects

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

Change notification read status.

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

Responses

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

Return the list of sequence ids to which the current user has

GET /data/user/projects/{project_id}/task-types/{task_type_id}/sequence-subscriptions
Jwt authorization

subscribed for given task type.

Responses

  • 200

    List of sequence ids to which the current user has subscribed for given task type

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

Resource to retrieve the entities linked on a given entity.

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

Responses

  • 200

    Entities linked on given entity

GET /data/entities/{entity_id}/entities-linked/with-tasks 
curl \
 --request GET 'http://api.example.com/data/entities/{entity_id}/entities-linked/with-tasks' \
 --header "Authorization: $API_KEY"

Set last preview from given task as main preview of the related entity.

PUT /actions/tasks/{task_id}/set-main-preview
Jwt authorization

This preview will be used as thumbnail to illustrate the entity.

Responses

  • 200

    Given preview set as main preview

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

Retrieve all task types related to a given concept.

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

Responses

  • 200

    All task types related to given concept

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

Retrieve all tasks related to a given concept.

GET /data/concepts/{concept_id}/tasks
Jwt authorization

Responses

  • 200

    All tasks related to given concept

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