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 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"

Breakdown

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"

Reply to given comment.

POST /data/tasks/{task_id}/comments/{comment_id}/reply
Jwt authorization

Add comment to its replies list.

Path parameters

Responses

  • 200

    Reply to given comment

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

Retrieve all entries for given model.

GET /data/project-status
Jwt authorization

Filters can be specified in the query string.

Responses

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

Update a model with data given in the request body.

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

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

Responses

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

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

GET /data/entities/{instance_id}
Jwt authorization

Responses

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

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

GET /data/departments/{instance_id}
Jwt authorization

Responses

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

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

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

Responses

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

Update a model with data given in the request body.

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

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

Responses

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

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

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

object.

Responses

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

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

Responses

PUT /data/events/{instance_id} 
curl \
 --request PUT '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"

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/subscriptions/
Jwt authorization

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

Responses

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

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

GET /data/salary-scales/{instance_id}
Jwt authorization

Responses

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

Create a model with data given in the request body.

POST /data/plugins
Jwt authorization

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

Responses

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

Retrieve all tasks related to a given edit.

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

Responses

  • 200

    All tasks related to given edit

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

Export shots linked to a given project as csv.

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

Responses

  • 200

    Shots exported as csv

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

Download a working file.

GET /data/working-files/{working_file_id}/file
Jwt authorization

Responses

  • 200

    Working file downloaded

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

Import shotgun resource.

POST /import/shotgun/scenes
Jwt authorization

Responses

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

Import shotgun resource.

POST /import/shotgun/versions
Jwt authorization

Responses

POST /import/shotgun/versions 
curl \
 --request POST 'http://api.example.com/import/shotgun/versions' \
 --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/version
Jwt authorization

Responses

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

Retrieve status of database and time.

GET /status/influx
Jwt authorization

Responses

  • 200

    Status of database, key value, event stream, job queue and time

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

Get basic configuration for the current instance.

GET /config
Jwt authorization

Responses

  • 200

    Configuration object including self-hosted status, Crisp token, indexer configuration, SAML status, and dark theme status.

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

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

GET /data/persons/time-spents/week-table/{year}
Jwt authorization

Responses

  • 200

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

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

Build given playlist as mp4 movie.

GET /data/playlists/{playlist_id}/build/mp4
Jwt authorization

Responses

  • 200

    Given playlist built as mp4 movie

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

Download the thumbnail linked to given object instance.

GET /pictures/thumbnails/organisations/{instance_id}
Jwt authorization

Responses

  • 200

    Thumbnail downloaded

  • 403

    Access not allowed

  • 404

    Object instance not found

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

Download the thumbnail linked to given object instance.

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

Responses

  • 200

    Thumbnail downloaded

  • 403

    Access not allowed

  • 404

    Object instance not found

GET /pictures/thumbnails/persons/{instance_id} 
curl \
 --request GET 'http://api.example.com/pictures/thumbnails/persons/{instance_id}' \
 --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 thumbnail for given object instance.

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

Path parameters

Responses

  • 200

    Thumbnail created

  • 404

    Cannot found related object.

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

Create a thumbnail for given object instance.

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

Path parameters

Responses

  • 200

    Thumbnail created

  • 404

    Cannot found related object.

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

Extract a frame from a preview_file

GET /actions/preview-files/{preview_file_id}/extract-frame
Jwt authorization

Responses

GET /actions/preview-files/{preview_file_id}/extract-frame 
curl \
 --request GET 'http://api.example.com/actions/preview-files/{preview_file_id}/extract-frame' \
 --header "Authorization: $API_KEY"

Add a person to a production team.

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

Path parameters

Responses

  • 201

    Person added to the production team

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