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"

Retrieve all asset types (entity types that are not shot, sequence or episode).

GET /data/asset-types
Jwt authorization

Responses

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

Retrieve all scene asset instances linked to given asset.

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

Responses

  • 200

    All scene asset instances linked to given asset

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

Retrieve all assets for given project and asset type.

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

Responses

  • 200

    All assets for given project and asset type

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

Resource to retrieve the casting of shots from given sequence.

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

Responses

  • 200

    Casting of shots from given sequence

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

Acknowledge given comment.

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

If it's already acknowledged, remove acknowledgement.

Path parameters

Responses

  • 200

    Comment acknowledged

POST /data/tasks/{task_id}/comments/{comment_id}/ack 
curl \
 --request POST 'http://api.example.com/data/tasks/{task_id}/comments/{comment_id}/ack' \
 --header "Authorization: $API_KEY"

Reply to given comment.

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

Add comment to its replies list.

Path parameters

Responses

  • 200

    Reply to given comment

POST /data/tasks/{task_id}/comments/{comment_id}/reply 
curl \
 --request POST 'http://api.example.com/data/tasks/{task_id}/comments/{comment_id}/reply' \
 --header "Authorization: $API_KEY"

Create a new comment for given task.

POST /actions/tasks/{task_id}/comment
Jwt authorization

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

Path parameters

Responses

  • 201

    New comment created

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

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

Responses

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

Responses

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

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/{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"

Retrieve all entries for given model.

GET /data/comments
Jwt authorization

Filters can be specified in the query string.

Responses

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

Responses

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

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

DELETE /data/schedule-items/{instance_id}
Jwt authorization

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

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

Retrieve all edit entries.

GET /data/edits
Jwt authorization

Filters can be specified in the query string.

Responses

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

Entities

Export as csv.

GET /export/csv/projects.csv
Jwt authorization

Responses

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

Get all output files for given poject.

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

Responses

  • 200

    All output files for given project.

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

Import remove instance.

POST /import/shotgun/remove/shot
Jwt authorization

Responses

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

Responses

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

Import project shots via a .csv file.

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

Path parameters

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

Import Kitsu resource.

POST /import/kitsu/entities
Jwt authorization

Responses

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

Retrieve all news related to a given project

GET /data/projects/news
Jwt authorization

Responses

  • 200

    All news from user open projects.

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

Retrieve all playlists related to given episode.

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

The full list is returned because the number of playlists in an episode is not that big.

Responses

  • 200

    All playlists related to given episode

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

Download a thumbnail.

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

Responses

  • 200

    Thumbnail downloaded

  • 403

    Instance not allowed

  • 404

    Picture file not found

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

Set given preview as main preview of the related entity.

PUT /actions/preview-files/{preview_file_id}/set-main-preview
Jwt authorization

This preview will be used to illustrate the entity.

Responses

  • 200

    Given preview set as main preview

PUT /actions/preview-files/{preview_file_id}/set-main-preview 
curl \
 --request PUT 'http://api.example.com/actions/preview-files/{preview_file_id}/set-main-preview' \
 --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"

Create a new metadata descriptor

POST /data/projects/{project_id}/metadata-descriptors
Jwt authorization

It serves to describe extra fields listed in the data attribute of entities.

Path parameters

Responses

  • 201

    Create a new metadata descriptor

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

Get a metadata descriptor.

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 shot entries.

GET /data/shots
Jwt authorization

Filters can be specified in the query string.

Responses

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

Delete given scene.

DELETE /data/scenes/{scene_id}
Jwt authorization

Responses

  • 204

    Given scene deleted

DELETE /data/scenes/{scene_id} 
curl \
 --request DELETE 'http://api.example.com/data/scenes/{scene_id}' \
 --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"

Mark given scene as source of given shot.

POST /data/scenes/{scene_id}/shots
Jwt authorization

Path parameters

Responses

  • 200

    Given scene marked as source of given shot

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

Retrieve all tasks related to a given episode.

GET /data/episodes/{episode_id}/tasks
Jwt authorization

Responses

  • 200

    All tasks related to given episode

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

For schedule usages, for each active person, it returns the first start

GET /data/persons/task-dates
Jwt authorization

date of all tasks of assigned to this person and the last end date.

Responses

  • 200

    For each person, the first start date of all tasks of assigned to this person and the last end date.

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

Assign given task lists to given person.

PUT /actions/persons/{person_id}/assign
Jwt authorization

If a given task ID is wrong, it ignores it.

Responses

  • 200

    Given tasks lists assigned to given person

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

Get time spent on a given task and date.

GET /actions/tasks/{task_id}/time-spents/{date}
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"

Delete time spent by a person on a task for a given day.

DELETE /actions/tasks/{task_id}/time-spents/{date}/persons/{person_id}
Jwt authorization

Responses

  • 201

    Time spent by given person on given task for given day is removed

  • 404

    Wrong date format

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

Return context required to properly run a full app connected to the API

GET /data/user/context
Jwt authorization

(like the Kitsu web client).

Responses

  • 200

    Context to properly run a full app connected to the API

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

Return asset types related to given project if the current user has

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

access to it.

Responses

  • 200

    Asset types related to given project

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

Return assets of which type is given asset type and are listed in given

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

project if user has access to this project.

Responses

  • 200

    Assets of which type is given asset type and are listed in given project

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

Delete given filter group if it's owned by the current user.

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

Responses

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

Retrieve desktop login logs.

GET /data/user/desktop-login-logs
Jwt authorization

Responses

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

Concepts

Retrieve all concepts related to a given project.

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

Responses

  • 200

    All concepts related to given project

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

Create a concept for given project.

POST /data/projects/{project_id}/concepts
Jwt authorization

Path parameters

Responses

  • 201

    Concept created for given project

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