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

Delete given entity link.

DELETE /data/projects/{project_id}/entity-links/{entity_link_id}
Jwt authorization

It's mainly used for synchronisation purpose.

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

Delete attachment linked to a comment matching given ID.

DELETE /data/tasks/{task_id}/comments/{comment_id}/attachments/{attachment_id}
Jwt authorization

Responses

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

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

GET /data/task-status/{instance_id}
Jwt authorization

Responses

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

Retrieve all entries for given model.

GET /data/departments
Jwt authorization

Filters can be specified in the query string.

Responses

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

Create a model with data given in the request body.

POST /data/preview-files
Jwt authorization

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

Responses

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

Update a model with data given in the request body.

PUT /data/attachment-files/{instance_id}
Jwt authorization

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

Responses

PUT /data/attachment-files/{instance_id} 
curl \
 --request PUT '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/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"

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"

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

GET /data/asset-instances/{instance_id}
Jwt authorization

Responses

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

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

GET /data/search-filter-groups/{instance_id}
Jwt authorization

Responses

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

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

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

Create a model with data given in the request body.

POST /data/studios
Jwt authorization

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

Responses

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

Update a model with data given in the request body.

PUT /data/studios/{instance_id}
Jwt authorization

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

Responses

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

Update a model with data given in the request body.

PUT /data/plugins/{instance_id}
Jwt authorization

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

Responses

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

Edits

Retrieve all edits related to a given episode.

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

Responses

  • 200

    All efits related to given episode

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

Retrieve all time spents linked to a given entity.

GET /data/entities/{entity_id}/time-spents
Jwt authorization

Responses

  • 200

    All time spents linked to given entity

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

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 shotgun resource.

POST /import/shotgun/assets
Jwt authorization

Responses

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

Delete error.

DELETE /import/shotgun/errors/{error_id}
Jwt authorization

Responses

  • 204

    Error deleted

  • 404

    Error non-existant or Statement error

DELETE /import/shotgun/errors/{error_id} 
curl \
 --request DELETE 'http://api.example.com/import/shotgun/errors/{error_id}' \
 --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 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 date and CPU, memory and jobs stats.

GET /status/resources
Jwt authorization

Responses

  • 200

    Date and CPU, memory and jobs stats

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

News

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"

Retrieve build job related to given playlist.

GET /data/playlists/{playlist_id}/jobs/{build_job_id}
Jwt authorization

Responses

  • 200

    Build job related to given playlist

GET /data/playlists/{playlist_id}/jobs/{build_job_id} 
curl \
 --request GET 'http://api.example.com/data/playlists/{playlist_id}/jobs/{build_job_id}' \
 --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"

Return the people listed in a production team.

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

Responses

  • 200

    People listed in a production team

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

Remove a task type from a production.

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

Responses

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

Retrieve episodes schedule items for given task type

GET /data/projects/{project_id}/schedule-items/{task_type_id}/episodes
Jwt authorization

Responses

  • 200

    All episodes schedule items for given task type

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

Update a budget entry for given production and budget

PUT /data/projects/{project_id}/budgets/{budget_id}/entries/{entry_id}
Jwt authorization

Responses

  • 200

    Budget entry updated

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

Delete a budget entry for given production and budget.

DELETE /data/projects/{project_id}/budgets/{budget_id}/entries/{entry_id}
Jwt authorization

Responses

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

Shots

Retrieve given shot.

GET /data/shots/{shot_id}
Jwt authorization
GET /data/shots/{shot_id} 
curl \
 --request GET 'http://api.example.com/data/shots/{shot_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 data versions of given shot.

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

Responses

  • 204

    Data versions of given shot

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

Retrieve given scene.

GET /data/scenes/{scene_id}
Jwt authorization

Responses

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

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"

Retrieve quotas statistics for shots.

GET /data/projects/{project_id}/quotas/persons/{person_id}
Jwt authorization

Responses

  • 200

    Quotas statistics for shots

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

Get comment corresponding at given ID.

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

Responses

  • 200

    Comment corresponding at given ID

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