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 unregister a FIDO device.

DELETE /auth/fido
Jwt authorization

Responses

  • 200

    FIDO device unregistered.

  • 400

    Invalid password Wrong or expired token Inactive user Wrong 2FA

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

Resource to retrieve the casting of a given asset.

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

Responses

  • 200

    Casting of given asset

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

Retrieve all scene asset instances linked to asset.

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

Responses

  • 200

    All scene asset instances linked to 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"

Create an asset instance inside given asset.

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

Path parameters

Responses

  • 201

    Asset instance created inside given asset

POST /data/assets/{asset_id}/asset-asset-instances 
curl \
 --request POST 'http://api.example.com/data/assets/{asset_id}/asset-asset-instances' \
 --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"

Create an asset instance on given scene.

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

Path parameters

Responses

  • 201

    Asset instances created on given scene

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

Creates new comments for given task. Each comments requires a task_id,

POST /actions/tasks/batch-comment
Jwt authorization

text, a task_status and a person as arguments.

Responses

  • 201

    New comments created

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

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

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

Responses

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

Responses

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

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

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

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

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

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

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

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

POST /data/metadata-descriptors/ 
curl \
 --request POST 'http://api.example.com/data/metadata-descriptors/' \
 --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/subscriptions/
Jwt authorization

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

Responses

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

Responses

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

Responses

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

Responses

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

Retrieve given edit.

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

Export shots linked to a given project as csv.

GET /export/csv/projects/{project_id}/shots.csv
Jwt authorization

Responses

  • 200

    Shots exported as csv

GET /export/csv/projects/{project_id}/shots.csv 
curl \
 --request GET 'http://api.example.com/export/csv/projects/{project_id}/shots.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"

Get last revisions of output files for given instance grouped by output type and file name.

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

Responses

  • 200

    Last revisions of output files for given instance grouped by output type and file name

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/{asset_instance_id}/entities/{temporal_entity_id}/output-files/last-revisions' \
 --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"

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

Responses

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

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

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

Import shotgun resource.

POST /import/shotgun/notes
Jwt authorization

Responses

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

Import remove instance.

POST /import/shotgun/remove/projectconnection
Jwt authorization

Responses

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

Import project edits.

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

Path parameters

Responses

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

Persons

Retrieve desktop login logs.

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

Desktop login logs can only be created by current user.

Responses

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

Get ended shots used for quota calculation of this week.

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

Responses

  • 200

    Ended shots used for quota calculation of this week

  • 404

    Wrong date format

GET /data/persons/{person_id}/quota-shots/week/{year}/{week} 
curl \
 --request GET 'http://api.example.com/data/persons/{person_id}/quota-shots/week/{year}/{week}' \
 --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"

Previews

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"

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"

Create a budget for given production.

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

Path parameters

Responses

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

Retrieve all sequence entries for a given episode.

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

Filters can be specified in the query string.

Responses

  • 200

    All sequence entries for given episode

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

Return comments linked to given task.

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

Responses

  • 200

    Comments linked to given task

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

Create a new task for given edit and task type.

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

Path parameters

Responses

  • 201

    New task for given edit and task type created

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

Return episodes related to given project if the current user has access

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

to it.

Responses

  • 200

    Episodes related to given project

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