Tokens are considered as outdated every two weeks.

GET /auth/refresh-token
Jwt authorization

This route allows to make their lifetime long before they get outdated.

Responses

  • 200

    Access Token

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

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

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

task_status and a person as arguments.

Path parameters

  • task_id Required

Responses

  • 201

    New comments created

POST /actions/tasks/{task_id}/batch-comment 
curl \
 --request POST 'http://api.example.com/actions/tasks/{task_id}/batch-comment' \
 --header "Authorization: $API_KEY"

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

GET /data/departments/{instance_id}
Jwt authorization

Path parameters

  • instance_id Required

Responses

  • 200

    Model as a JSON object

  • 400

    Statement error

  • 404

    Value error

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

Path parameters

  • instance_id Required

Responses

  • 200

    Model updated

  • 400

    Error

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

Update a model with data given in the request body.

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

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

Path parameters

  • instance_id Required

Responses

  • 200

    Model updated

  • 400

    Error

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

Path parameters

  • instance_id Required

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"

Retrieve all edit entries.

GET /data/edits
Jwt authorization

Filters can be specified in the query string.

Query parameters

  • project_id
  • name
  • force

Responses

  • 200

    All edit entries

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

Export casting linked to a given project as csv.

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

Path parameters

  • project_id Required

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"

Generate an output file path from file tree template

POST /data/entities/{entity_id}/output-file-path
Jwt authorization

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

Path parameters

  • entity_id Required

Responses

  • 200

    Output file path generated

  • 400

    Malformed file tree

POST /data/entities/{entity_id}/output-file-path 
curl \
 --request POST 'http://api.example.com/data/entities/{entity_id}/output-file-path' \
 --header "Authorization: $API_KEY"

Import Kitsu resource.

POST /import/kitsu/tasks
Jwt authorization

Responses

  • 200

    Resource imported

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

Return a csv file containing the presence logs based on a daily basis.

GET /data/persons/presence-logs/{month_date}
Jwt authorization

Path parameters

  • month_date Required

Responses

  • 200

    CSV file containing the presence logs based on a daily basis

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

Shots

Retrieve all shots, adds project name and asset type name and all related tasks.

GET /data/shots/with-tasks
Jwt authorization

Query parameters

  • project_id

Responses

  • 200

    All shots

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

Retrieve all task types related to a given episode.

GET /data/episodes/{episode_id}/task-types
Jwt authorization

Path parameters

  • episode_id Required

Responses

  • 200

    All task types related to given episode

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

Retrieve all tasks related to given project.

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

It's mainly used for synchronisation purpose.

Path parameters

  • project_id Required

Query parameters

  • page
  • task_type_id
  • episode_id

Responses

  • 200

    All tasks related to given project

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

Path parameters

  • task_id Required
  • date Required
  • person_id Required

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"

Add given timeframe to time spent by a person on a task for a given day.

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

Path parameters

  • task_id Required
  • date Required
  • person_id Required

Responses

  • 201

    Given timeframe added to time spent by given person on given task for given day

  • 404

    Wrong date format

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

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

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

Path parameters

  • filter_id Required

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"