Resource to allow a user to disable OTP by email.

DELETE /auth/email-otp
Jwt authorization

Responses

  • 200

    OTP by email disabled.

  • 400

    Invalid password. Wrong or expired token. Inactive user. Wrong 2FA.

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

Resource to retrieve the casting of a given entity.

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

Responses

  • 200

    Casting of given entity

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

Retrieve all asset instances linked to shot.

GET /data/shots/{shot_id}/asset-instances
Jwt authorization

Responses

  • 200

    All assets linked to shot

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

Retrieve all entries for given model.

GET /data/task-types
Jwt authorization

Filters can be specified in the query string.

Responses

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

Create a model with data given in the request body.

POST /data/task-status
Jwt authorization

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

Responses

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

Retrieve all entries for given model.

GET /data/organisations
Jwt authorization

Filters can be specified in the query string.

Responses

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

Retrieve all entries for given model.

GET /data/file-status/
Jwt authorization

Filters can be specified in the query string.

Responses

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

Retrieve all entries for given model.

GET /data/softwares
Jwt authorization

Filters can be specified in the query string.

Responses

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

Update a model with data given in the request body.

PUT /data/output-types/{instance_id}
Jwt authorization

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

Responses

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

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

DELETE /data/output-types/{instance_id}
Jwt authorization

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

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

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

GET /data/day-offs/{instance_id}
Jwt authorization

Responses

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

Update a model with data given in the request body.

PUT /data/entity-links/{instance_id}
Jwt authorization

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

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

Retrieve all edits, adds project name and all related tasks.

GET /data/edits/with-tasks
Jwt authorization

Responses

  • 200

    All edits and all related tasks.

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

Delete given edit.

DELETE /data/edits/{edit_id}
Jwt authorization

Responses

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

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 news linked to a given entity.

GET /data/entities/{entity_id}/news
Jwt authorization

Responses

  • 200

    All news linked to given entity

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

Export casting linked to a given project as csv.

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

Responses

  • 200

    Casting exported as csv

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

Get all working files for a given entity and possibly a task and a name.

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

Responses

  • 200

    All working files for given entity and possibly a task and a name

GET /data/entities/{entity_id}/working-files 
curl \
 --request GET 'http://api.example.com/data/entities/{entity_id}/working-files' \
 --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/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/sequence
Jwt authorization

Responses

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

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"

Generate a main:test event.

GET /status/test-event
Jwt authorization

Responses

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

Allow admin to disable two factor authentication for given user.

DELETE /actions/persons/{person_id}/disable-two-factor-authentication
Jwt authorization

Prior to disable two factor authentication, it requires to be admin. An admin can't disable two factor authentication for other admins.

Responses

  • 200

    Two factor authentication disabled

  • 400

    Inactive user

DELETE /actions/persons/{person_id}/disable-two-factor-authentication 
curl \
 --request DELETE 'http://api.example.com/actions/persons/{person_id}/disable-two-factor-authentication' \
 --header "Authorization: $API_KEY"

Previews

Download a movie preview.

GET /movies/originals/preview-files/{instance_id}.mp4
Jwt authorization

It stores the preview file and generates three picture files matching preview when it's possible: a square thumbnail, a rectangle thumbnail and a midsize file.

Responses

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

Retrieve a budget for given production

GET /data/projects/{project_id}/budgets/{budget_id}
Jwt authorization

Responses

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

Update given shot.

PUT /data/shots/{shot_id}
Jwt authorization

Responses

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

Retrieve all task types related to a given shot.

GET /data/shots/{shot_id}/task-types
Jwt authorization

Responses

  • 200

    All task types related to given shot

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

Retrieve all previews related to a given shot.

GET /data/shots/{shot_id}/preview-files
Jwt authorization

It sends them as a dict. Keys are related task type ids and values are arrays of preview for this task type.

Responses

  • 200

    All previews related to given episode

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

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"

Create a shot for given project.

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

Path parameters

Responses

  • 201

    Shot created for given project

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

Get time spents for current user and given date.

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

Responses

  • 200

    Time spents for current user and given date

  • 404

    Wrong date format

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