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"

Retrieve all task types related to a given asset.

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

Responses

  • 200

    All task types related to given asset

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

Retrieve all shot asset instances linked to asset.

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

Responses

  • 200

    All shot asset instances linked to asset

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

Share or unshare a list of assets.

POST /actions/assets/share
Jwt authorization

Responses

  • 201

    All assets modified.

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

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

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

Responses

  • 200

    Modification of assets linked to an entity

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

Responses

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

Responses

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

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

GET /data/custom-actions/{instance_id}
Jwt authorization

Responses

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

Responses

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

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

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

Responses

POST /data/playlists/ 
curl \
 --request POST '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/subscriptions/{instance_id}
Jwt authorization

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

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

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

Export

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"

Export as csv.

GET /export/csv/task-types.csv
Jwt authorization

Responses

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

Generate a working file path from file tree template.

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

Generate file path based on several parameters: task, software, mode, revision and separator. Revision can be computed automatically as next revision if not given.

Path parameters

Responses

  • 200

    Working file path generated

  • 400

    Malformed file tree

POST /data/tasks/{task_id}/working-file-path 
curl \
 --request POST 'http://api.example.com/data/tasks/{task_id}/working-file-path' \
 --header "Authorization: $API_KEY"

Import shotgun resource.

POST /import/shotgun/projects
Jwt authorization

Responses

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

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

Import remove instance.

POST /import/shotgun/remove/project
Jwt authorization

Responses

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

Import Kitsu resource.

POST /import/kitsu/projects
Jwt authorization

Responses

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

Index

Retrieve main stats.

GET /stats
Jwt authorization

Responses

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

News

Get aggregated time spents for given person and week.

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

Responses

  • 200

    Aggregated time spents for given person and week

  • 404

    Wrong date format

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

Get ended shots used for quota calculation of this month.

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

Responses

  • 200

    Ended shots used for quota calculation of this month

  • 404

    Wrong date format

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

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

GET /data/playlists/preview-files/running
Jwt authorization

Responses

  • 200

    All preview files from open productions with states equals to processing or broken

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

Download a thumbnail.

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

Responses

  • 200

    Thumbnail downloaded

  • 403

    Instance not allowed

  • 404

    Picture file not found

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

Remove an asset type from a production.

DELETE /data/projects/{project_id}/settings/asset-types/{asset_type_id}
Jwt authorization

Responses

DELETE /data/projects/{project_id}/settings/asset-types/{asset_type_id} 
curl \
 --request DELETE 'http://api.example.com/data/projects/{project_id}/settings/asset-types/{asset_type_id}' \
 --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"

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

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 shots that come from given scene.

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

Responses

  • 200

    All shots that come from given scene

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

Retrieve given episode.

GET /data/episodes/{episode_id}
Jwt authorization

Responses

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

Retrieve all shots tasks related to a given episode.

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

Responses

  • 200

    All shots tasks related to given episode

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

Retrieve all shot entries for a given sequence.

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

Filters can be specified in the query string.

Responses

  • 200

    All shot entries for given sequence

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

Return previews linked to given task.

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

Responses

  • 200

    Previews linked to given task

GET /data/tasks/{task_id}/previews 
curl \
 --request GET 'http://api.example.com/data/tasks/{task_id}/previews' \
 --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"

Update given filter if it's owned by current user.

PUT /data/user/filters/{filter_id}
Jwt authorization

Responses

  • 200

    Given filter with updated data.

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

Task