Authentication

Jwt authorization (http_api_key)

Format in header: Authorization: Bearer {token}.

Value example: Bearer xxxxx.yyyyy.zzzzz

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 register a FIDO device.

POST /auth/fido
Jwt authorization

Responses

  • 200

    FIDO device registered.

  • 400

    Invalid password Wrong or expired token Inactive user

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

Resource to allow a user to unregister a FIDO device.

DELETE /auth/fido
Jwt authorization

Responses

  • 200

    FIDO device unregistered.

  • 400

    Invalid password Wrong or expired token Inactive user Wrong 2FA

DELETE /auth/fido 
curl \
 --request DELETE 'http://api.example.com/auth/fido' \
 --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"

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 assets from given asset type.

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

Responses

  • 200

    Casting of assets from given asset type

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

Retrieve all asset instances linked to scene.

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

Responses

  • 200

    All asset instances linked to given scene

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

Create an asset instance on given scene.

POST /data/scenes/{scene_id}/asset-instances
Jwt authorization

Path parameters

Responses

  • 201

    Asset instances created on given scene

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

Comments

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"

Add given files to the comment entry as attachments.

POST /actions/tasks/{task_id}/comments/{comment_id}/add-attachment
Jwt authorization

Path parameters

Responses

  • 201

    Given files added to the comment entry as attachments

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

Update a model with data given in the request body.

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

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

Responses

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

Update a model with data given in the request body.

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

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

Responses

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

Retrieve all entries for given model.

GET /data/task-status
Jwt authorization

Filters can be specified in the query string.

Responses

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

Retrieve a software corresponding at given ID and return it as a

GET /data/softwares/{instance_id}
Jwt authorization

JSON object.

Responses

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

Retrieve all entries for given model.

GET /data/output-types
Jwt authorization

Filters can be specified in the query string.

Responses

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

Retrieve all entries for given model.

GET /data/attachment-files
Jwt authorization

Filters can be specified in the query string.

Responses

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

Create a model with data given in the request body.

POST /data/attachment-files
Jwt authorization

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

Responses

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

Create a model with data given in the request body.

POST /data/status-automations/
Jwt authorization

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

Responses

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

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

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

Responses

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

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

DELETE /data/playlists/{instance_id}
Jwt authorization

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

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

Retrieve all entries for given model.

GET /data/search-filters/
Jwt authorization

Filters can be specified in the query string.

Responses

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

Retrieve all entries for given model.

GET /data/entity-links/
Jwt authorization

Filters can be specified in the query string.

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

Retrieve all entries for given model.

GET /data/chats/
Jwt authorization

Filters can be specified in the query string.

Responses

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

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"

Export as csv.

GET /export/csv/tasks.csv
Jwt authorization

Responses

GET /export/csv/tasks.csv 
curl \
 --request GET 'http://api.example.com/export/csv/tasks.csv' \
 --header "Authorization: $API_KEY"

Get information about a file that could be a working file as much as an

GET /data/files/{file_id}
Jwt authorization

output file.

Responses

  • 200

    Information about file

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

Get all output files for given asset instance and given output type.

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

Responses

  • 200

    All output files for given asset instance and given output type

GET /data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-types/{output_type_id}/output-files 
curl \
 --request GET 'http://api.example.com/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-types/{output_type_id}/output-files' \
 --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"

Get all output files for given asset instance and given output type.

GET /data/asset-instances/{asset_instance_id}/output-files
Jwt authorization

Responses

  • 200

    All output files for given asset instance and given temporal entity (shot, sequence, etc.)

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

Import shotgun resource.

POST /import/shotgun/status
Jwt authorization

Responses

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

Import shotgun resource.

POST /import/shotgun/tasks
Jwt authorization

Responses

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

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"

Get time spents for given person and date.

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

Responses

  • 200

    Time spents for given person and date

  • 404

    Wrong date format

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

Download a movie preview.

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

Responses

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

Download a lowdef movie preview.

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

Responses

  • 200

    Lowdef movie preview downloaded

  • 403

    Instance not allowed

  • 404

    File not found

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

Download a generic file preview.

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

Responses

  • 200

    Generic file preview downloaded

  • 403

    Instance not allowed

  • 404

    Non-movie file not found

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

Create a thumbnail for given object instance.

POST /pictures/thumbnails/persons/{instance_id}
Jwt authorization

Path parameters

Responses

  • 200

    Thumbnail created

  • 404

    Cannot found related object.

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

Create a new metadata descriptor

POST /data/projects/{project_id}/metadata-descriptors
Jwt authorization

It serves to describe extra fields listed in the data attribute of entities.

Path parameters

Responses

  • 201

    Create a new metadata descriptor

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

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 given episode.

GET /data/episodes/{episode_id}
Jwt authorization

Responses

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

Delete a comment corresponding at given ID.

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

Responses

  • 204

    Comment corresponding at given ID deleted

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

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"

Delete preview from given comment.

DELETE /actions/tasks/{task_id}/comments/{comment_id}/preview-files/{preview_file_id}
Jwt authorization

Responses

  • 204

    Preview deleted from given comment

DELETE /actions/tasks/{task_id}/comments/{comment_id}/preview-files/{preview_file_id} 
curl \
 --request DELETE 'http://api.example.com/actions/tasks/{task_id}/comments/{comment_id}/preview-files/{preview_file_id}' \
 --header "Authorization: $API_KEY"

Change a task status to "to review".

PUT /actions/tasks/{task_id}/to-review
Jwt authorization

It creates a new preview file entry and set path from the hard disk.

Responses

  • 200

    Task status changed to "to review"

  • 400

    Given person not found

PUT /actions/tasks/{task_id}/to-review 
curl \
 --request PUT 'http://api.example.com/actions/tasks/{task_id}/to-review' \
 --header "Authorization: $API_KEY"