Authentication

Jwt authorization (http_api_key)

Format in header: Authorization: Bearer {token}.

Value example: Bearer xxxxx.yyyyy.zzzzz

Log user out by revoking his auth tokens.

GET /auth/logout
Jwt authorization

Once logged out, current user cannot access the API anymore.

Responses

  • 200

    Logout successful

  • 500

    Access token not found

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

Assets

Resource to allow the modification of assets linked to a asset.

PUT /data/assets/{asset_id}/casting
Jwt authorization

Responses

  • 200

    Modification of assets linked to given asset

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

Retrieve all asset types for given project.

GET /data/projects/{project_id}/asset-types
Jwt authorization

Responses

  • 200

    All asset types for given project

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

Share or unshare all assets for given project and asset type.

POST /actions/projects/{project_id}/asset-types/{asset_type_id}/assets/share
Jwt authorization

Path parameters

Responses

  • 201

    All assets modified.

POST /actions/projects/{project_id}/asset-types/{asset_type_id}/assets/share 
curl \
 --request POST 'http://api.example.com/actions/projects/{project_id}/asset-types/{asset_type_id}/assets/share' \
 --header "Authorization: $API_KEY"

Retrieve all camera instances linked to scene.

GET /data/scenes/{scene_id}/camera-instances
Jwt authorization

Responses

  • 201

    All camera instances linked to scene

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

Delete given comment reply.

DELETE /data/tasks/{task_id}/comments/{comment_id}/reply/{reply_id}
Jwt authorization

Responses

  • 200

    Given comment reply deleted

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

Create a model with data given in the request body.

POST /data/softwares
Jwt authorization

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

Responses

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

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 all entries for given model.

GET /data/preview-files
Jwt authorization

Filters can be specified in the query string.

Responses

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

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

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

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

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

Retrieve all entries for given model.

GET /data/asset-instances/
Jwt authorization

Filters can be specified in the query string.

Responses

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

Create a model with data given in the request body.

POST /data/events/
Jwt authorization

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

Responses

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

Filters can be specified in the query string.

Responses

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

Create a model with data given in the request body.

POST /data/milestones/
Jwt authorization

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

Responses

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

Update a model with data given in the request body.

PUT /data/chats/{instance_id}
Jwt authorization

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

Responses

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

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

GET /data/studios/{instance_id}
Jwt authorization

Responses

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

GET /data/edits/{edit_id}/versions
Jwt authorization

Responses

  • 200

    Data versions of given edit

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

Retrieve last events.

GET /data/events/last
Jwt authorization

Responses

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

Export a given playlist as csv.

GET /export/csv/playlists/{playlist_id}
Jwt authorization

Responses

  • 200

    Playlist exported as csv

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

Return a table giving time spent by user and by month for given year.

GET /data/persons/time-spents/year-table/
Jwt authorization

Responses

  • 200

    Table giving time spent by user and by month for given year

GET /data/persons/time-spents/year-table/ 
curl \
 --request GET 'http://api.example.com/data/persons/time-spents/year-table/' \
 --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"

Download the thumbnail linked to given object instance.

GET /pictures/thumbnails/projects/{instance_id}.png
Jwt authorization

Responses

  • 200

    Thumbnail downloaded

  • 403

    Access not allowed

  • 404

    Object instance not found

GET /pictures/thumbnails/projects/{instance_id}.png 
curl \
 --request GET 'http://api.example.com/pictures/thumbnails/projects/{instance_id}.png' \
 --header "Authorization: $API_KEY"

Return all projects listed in database.

GET /data/projects/all
Jwt authorization

Ensure that user has at least the manager level before that.

Responses

  • 200

    All projects listed in database

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

Remove a status automation from a production.

DELETE /data/projects/{project_id}/settings/status-automations/{status_automation_id}
Jwt authorization

Responses

DELETE /data/projects/{project_id}/settings/status-automations/{status_automation_id} 
curl \
 --request DELETE 'http://api.example.com/data/projects/{project_id}/settings/status-automations/{status_automation_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.

GET /data/sequences
Jwt authorization

Filters can be specified in the query string.

Responses

  • 200

    All sequence entries

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

Retrieve all scenes related to a given sequence.

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

Responses

  • 200

    All scenes related to given sequence

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

Return tasks related to given entity asset, episode, sequence, shot or scene.

GET /data/entities/{entity_id}/task-types/{task_type_id}/tasks
Jwt authorization

Responses

  • 200

    Tasks related to given entity asset, episode, sequence, shot or scene

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

Resource to retrieve the entities linked on a given entity.

GET /data/entities/{entity_id}/entities-linked/with-tasks
Jwt authorization

Responses

  • 200

    Entities linked on given entity

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

Retrieve all concepts related to a given project.

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

Responses

  • 200

    All concepts related to given project

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