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

GET /data/persons/{instance_id}
Jwt authorization

Path parameters

  • instance_id Required

Responses

  • 200

    Model as a JSON object

  • 400

    Statement error

  • 404

    Value error

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

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

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

Path parameters

  • instance_id Required

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

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

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

DELETE /data/departments/{instance_id}
Jwt authorization

Path parameters

  • instance_id Required

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

DELETE /data/departments/{instance_id} 
curl \
 --request DELETE '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/day-offs/{instance_id}
Jwt authorization

Path parameters

  • instance_id Required

Responses

  • 200

    Model as a JSON object

  • 400

    Statement error

  • 404

    Value error

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

Retrieve all entries for given model.

GET /data/custom-actions/
Jwt authorization

Filters can be specified in the query string.

Responses

  • 200

    All entries for given model

  • 400

    Format error

  • 403

    Permission denied

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

Path parameters

  • instance_id Required

Responses

  • 200

    Model updated

  • 400

    Error

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

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

DELETE /data/news/{instance_id}
Jwt authorization

Path parameters

  • instance_id Required

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

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

Export as csv.

GET /export/csv/task-types.csv
Jwt authorization

Responses

  • 200

    Exported as csv

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

Generate a working file path from file tree template.

POST /data/tasks/{task_id}/working-file-path
Jwt authorization

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

Path parameters

  • task_id Required

Responses

  • 200

    Working file path generated

  • 400

    Malformed file tree

POST /data/tasks/{task_id}/working-file-path 
curl \
 --request POST 'http://api.example.com/data/tasks/{task_id}/working-file-path' \
 --header "Authorization: $API_KEY"

Get all output files for given entity and given output type.

GET /data/entities/{entity_id}/output-types/{output_type_id}/output-files
Jwt authorization

Path parameters

  • entity_id Required
  • output_type_id Required

Responses

  • 200

    All output files for given entity and given output type

GET /data/entities/{entity_id}/output-types/{output_type_id}/output-files 
curl \
 --request GET 'http://api.example.com/data/entities/{entity_id}/output-types/{output_type_id}/output-files' \
 --header "Authorization: $API_KEY"

Import remove instance.

POST /import/shotgun/remove/sequence
Jwt authorization

Responses

  • 204

    Instance removed

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

Import the estimations of task-types for given project.

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

Path parameters

  • project_id Required
  • task_type_id Required

Responses

  • 201

    Estimations imported

  • 400

    Format error

POST /import/csv/projects/{project_id}/task-types/{task_type_id}/estimations 
curl \
 --request POST 'http://api.example.com/import/csv/projects/{project_id}/task-types/{task_type_id}/estimations' \
 --header "Authorization: $API_KEY"

Retrieve desktop login logs.

GET /data/persons/{person_id}/desktop-login-logs
Jwt authorization

Desktop login logs can only be created by current user.

Path parameters

  • person_id Required

Responses

  • 200

    Desktop login logs

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

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

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

Path parameters

  • year Required
  • month Required

Responses

  • 200

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

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

Path parameters

  • person_id Required
  • year Required
  • month Required

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"

Extract a frame from a preview_file

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

Path parameters

  • preview_file_id Required

Responses

  • 200

    Extracted frame

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"

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"

Add a preview background file linked to a production.

POST /data/projects/{project_id}/settings/preview-background-files
Jwt authorization

Path parameters

  • project_id Required

Responses

  • 201

    Preview background file added to production

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

Path parameters

  • project_id Required
  • task_type_id Required

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"

Retrieve sequences schedule items for given task type

GET /data/projects/{project_id}/schedule-items/{task_type_id}/sequences
Jwt authorization

Path parameters

  • project_id Required
  • task_type_id Required

Responses

  • 200

    All sequences schedule items for given task type

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

Retrieve all shot entries.

GET /data/shots/all
Jwt authorization

Filters can be specified in the query string.

Query parameters

  • sequence_id
  • project_id
  • parent_id

Responses

  • 200

    All shot entries

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

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"

Delete given sequence.

DELETE /data/sequences/{sequence_id}
Jwt authorization

Path parameters

  • sequence_id Required

Responses

  • 204

    Given sequence deleted

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

Retrieve all scenes related to a given project.

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

Path parameters

  • project_id Required

Responses

  • 200

    All scenes related to given project

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

Create a scene for given project.

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

Path parameters

  • project_id Required

Responses

  • 201

    Scene created for given project

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

Return comments linked to given task.

GET /data/tasks/{task_id}/comments
Jwt authorization

Path parameters

  • task_id Required

Responses

  • 200

    Comments linked to given task

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

Create a new task with given task type for each entity of given

POST /actions/projects/{project_id}/task-types/{task_type_id}/create-tasks/{entity_type}/
Jwt authorization

entity type.

Path parameters

  • project_id Required
  • task_type_id Required

Responses

  • 201

    List of created tasks.

POST /actions/projects/{project_id}/task-types/{task_type_id}/create-tasks/{entity_type}/ 
curl \
 --request POST 'http://api.example.com/actions/projects/{project_id}/task-types/{task_type_id}/create-tasks/{entity_type}/' \
 --header "Authorization: $API_KEY"

Return open projects for which the user has at least one task assigned.

GET /data/user/projects/open
Jwt authorization

Responses

  • 200

    Open projects for which the user has at least one task assigned

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

Return sequences related to given project if the current user has access

GET /data/user/projects/{project_id}/sequences
Jwt authorization

to it.

Path parameters

  • project_id Required

Responses

  • 200

    Sequences related to given project

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

Create filter for current user and only for open projects.

POST /data/user/filters
Jwt authorization

Responses

  • 201

    Filter for current user and only for open projects created

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

Create a desktop login log.

POST /data/user/desktop-login-logs
Jwt authorization

The desktop login log can only be created by the current user.

Responses

  • 201

    Desktop login log created

POST /data/user/desktop-login-logs 
curl \
 --request POST 'http://api.example.com/data/user/desktop-login-logs' \
 --header "Authorization: $API_KEY"

Return true if current user has subscribed to given task.

GET /data/user/tasks/{task_id}/subscribed
Jwt authorization

Path parameters

  • task_id Required

Responses

  • 200

    True if current user has subscribed to given task, False otherwise

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

Create a new chat message.

POST /data/entities/{entity_id}/chat/messages
Jwt authorization

Path parameters

  • entity_id Required

    ID of the entity related to the chat

Responses

  • 201

    Chat message created

  • 400

    Not participant of the chat

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

Retrieve all previews related to a given concept.

GET /data/concepts/{concept_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.

Path parameters

  • concept_id Required

Responses

  • 200

    All previews related to given episode

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