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"

Returns information if the user is authenticated else it returns a 401

GET /auth/authenticated
Jwt authorization

response.

Responses

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

Resource to allow a user to disable TOTP.

DELETE /auth/totp
Jwt authorization

Responses

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

Resource to allow a user to login with SAML SSO.

GET /auth/saml/login
Jwt authorization

Responses

  • 302

    Redirect to the SAML IDP.

  • 400

    Wrong parameter.

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

Retrieve given asset.

GET /data/assets/{asset_id}
Jwt authorization

Responses

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

Retrieve the casting of a given asset.

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

Responses

  • 200

    Casting of given asset

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

Retrieve all asset instances instantiated inside given asset.

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

Responses

  • 200

    All asset instances instantiated inside given asset

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

Create new asset with given parameters.

POST /data/projects/{project_id}/asset-types/{asset_type_id}/assets/new
Jwt authorization

Path parameters

Responses

  • 201

    New asset resource created

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

Crud

Retrieve all entries for given model.

GET /data/projects
Jwt authorization

Filters can be specified in the query string.

Responses

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

Update a model with data given in the request body.

PUT /data/projects/{instance_id}
Jwt authorization

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

Responses

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

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

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

Responses

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

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

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

Responses

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

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

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

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

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

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"

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

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

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

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

Retrieve all entries for given model.

GET /data/playlists/
Jwt authorization

Filters can be specified in the query string.

Responses

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

Update a model with data given in the request body.

PUT /data/playlists/{instance_id}
Jwt authorization

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

Responses

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

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

DELETE /data/events/{instance_id}
Jwt authorization

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

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

Update a model with data given in the request body.

PUT /data/notifications/{instance_id}
Jwt authorization

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

Responses

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

Update a model with data given in the request body.

PUT /data/search-filters/{instance_id}
Jwt authorization

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

Responses

PUT /data/search-filters/{instance_id} 
curl \
 --request PUT 'http://api.example.com/data/search-filters/{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/news/
Jwt authorization

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

Responses

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

Create a model with data given in the request body.

POST /data/entity-links/
Jwt authorization

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

Responses

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

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

DELETE /data/chats/{instance_id}
Jwt authorization

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

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

Create a model with data given in the request body.

POST /data/preview-background-files
Jwt authorization

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

Responses

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

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

GET /data/plugins/{instance_id}
Jwt authorization

Responses

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

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

DELETE /data/plugins/{instance_id}
Jwt authorization

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

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

Retrieve all previews related to a given edit.

GET /data/edits/{edit_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 edit

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

Return all types of output generated for given instance.

GET /data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-types
Jwt authorization

Responses

  • 200

    All types of output generated for given instance and temporal_entity

GET /data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-types 
curl \
 --request GET 'http://api.example.com/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-types' \
 --header "Authorization: $API_KEY"

Generate an output file path from file tree template

POST /data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-file-path
Jwt authorization

Generate file path based on several parameters: asset instance, output type, task type, revision, mode, name and separator. Revision can be computed automatically as next revision in case no revision is given in parameter.

Path parameters

Responses

  • 200

    Output file path generated

  • 400

    Malformed file tree

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

Update working file modification date with current date.

PUT /actions/working-files/{working_file_id}/modified
Jwt authorization

Responses

  • 200

    Working file modification date updated

PUT /actions/working-files/{working_file_id}/modified 
curl \
 --request PUT 'http://api.example.com/actions/working-files/{working_file_id}/modified' \
 --header "Authorization: $API_KEY"

Import shotgun error resource.

GET /import/shotgun/errors
Jwt authorization

Responses

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

Import remove instance.

POST /import/shotgun/remove/project
Jwt authorization

Responses

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

Import remove instance.

POST /import/shotgun/remove/person
Jwt authorization

Responses

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

Import remove instance.

POST /import/shotgun/remove/asset
Jwt authorization

Responses

POST /import/shotgun/remove/asset 
curl \
 --request POST 'http://api.example.com/import/shotgun/remove/asset' \
 --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 the estimations of task-types for given episode of given project.

POST /import/csv/projects/{project_id}/episodes/{episode_id}/task-types/{task_type_id}/estimations
Jwt authorization

Path parameters

Responses

POST /import/csv/projects/{project_id}/episodes/{episode_id}/task-types/{task_type_id}/estimations 
curl \
 --request POST 'http://api.example.com/import/csv/projects/{project_id}/episodes/{episode_id}/task-types/{task_type_id}/estimations' \
 --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"

Index

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"

Retrieve all news related to a given project

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

Responses

  • 200

    All news related to given project

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

Get aggregated time spents for given person and month.

GET /data/persons/{person_id}/time-spents/month/{year}/{month}
Jwt authorization

Responses

  • 200

    Aggregated time spents for given person and month

  • 404

    Wrong date format

GET /data/persons/{person_id}/time-spents/month/{year}/{month} 
curl \
 --request GET 'http://api.example.com/data/persons/{person_id}/time-spents/month/{year}/{month}' \
 --header "Authorization: $API_KEY"

Return all day off recorded for given month and person.

GET /data/persons/{person_id}/day-offs/month/{year}/{month}
Jwt authorization

Responses

  • 200

    All day off recorded for given month and person

GET /data/persons/{person_id}/day-offs/month/{year}/{month} 
curl \
 --request GET 'http://api.example.com/data/persons/{person_id}/day-offs/month/{year}/{month}' \
 --header "Authorization: $API_KEY"

Add a user to given department.

POST /actions/persons/{person_id}/departments/add
Jwt authorization

Path parameters

Responses

  • 201

    User added to given department

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

Remove a user from given department.

DELETE /actions/persons/{person_id}/departments/{department_id}
Jwt authorization

Responses

  • 204

    User removed from given department

DELETE /actions/persons/{person_id}/departments/{department_id} 
curl \
 --request DELETE 'http://api.example.com/actions/persons/{person_id}/departments/{department_id}' \
 --header "Authorization: $API_KEY"

Download given playlist as zip.

GET /data/playlists/{playlist_id}/download/zip
Jwt authorization

Responses

  • 200

    Given playlist downloaded as zip

GET /data/playlists/{playlist_id}/download/zip 
curl \
 --request GET 'http://api.example.com/data/playlists/{playlist_id}/download/zip' \
 --header "Authorization: $API_KEY"

Main resource to add a preview.

POST /pictures/preview-files/{instance_id}
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.

Path parameters

Responses

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

Download a thumbnail.

GET /pictures/originals/preview-files/{instance_id}.png
Jwt authorization

Responses

  • 200

    Thumbnail downloaded

  • 403

    Instance not allowed

  • 404

    Picture file not found

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

Create a thumbnail for given object instance.

POST /pictures/thumbnails/organisations/{instance_id}.png
Jwt authorization

Path parameters

Responses

  • 200

    Thumbnail created

  • 404

    Cannot found related object.

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

Create a thumbnail for given object instance.

POST /pictures/thumbnails/preview-background-files/{instance_id}.png
Jwt authorization

Path parameters

Responses

  • 200

    Thumbnail created

  • 404

    Cannot found related object.

POST /pictures/thumbnails/preview-background-files/{instance_id}.png 
curl \
 --request POST 'http://api.example.com/pictures/thumbnails/preview-background-files/{instance_id}.png' \
 --header "Authorization: $API_KEY"

Projects