Tokens are considered as outdated every two weeks.

GET /auth/refresh-token
Jwt authorization

This route allows to make their lifetime long before they get outdated.

Responses

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

Delete attachment linked to a comment matching given ID.

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

Responses

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

Crud

Create a model with data given in the request body.

POST /data/project-status
Jwt authorization

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

Responses

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

Update a model with data given in the request body.

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

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

Responses

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

Update a model with data given in the request body.

PUT /data/tasks/{instance_id}
Jwt authorization

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

Responses

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

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

DELETE /data/organisations/{instance_id}
Jwt authorization

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

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

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

DELETE /data/softwares/{instance_id}
Jwt authorization

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

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

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

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

Responses

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

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

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

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

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

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

DELETE /data/time-spents/{instance_id}
Jwt authorization

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

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

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

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

Responses

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

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 a model corresponding at given ID and return it as a JSON object.

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

Retrieve all entries for given model.

GET /data/chat-messages/
Jwt authorization

Filters can be specified in the query string.

Responses

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

Edits

Retrieve all edit entries.

GET /data/edits/all
Jwt authorization

Filters can be specified in the query string.

Responses

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

Define a template file to use for given project.

POST /actions/projects/{project_id}/set-file-tree
Jwt authorization

Template files are located on the server side. Each template has a name which means that you just have to give a name to "select" the template to link with the project.

Path parameters

Responses

  • 200

    Template file defined

  • 400

    Selected tree not available

POST /actions/projects/{project_id}/set-file-tree 
curl \
 --request POST 'http://api.example.com/actions/projects/{project_id}/set-file-tree' \
 --header "Authorization: $API_KEY"

Import shotgun resource.

POST /import/shotgun/projects
Jwt authorization

Responses

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

Import shotgun resource.

POST /import/shotgun/assets
Jwt authorization

Responses

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

Serialize shotgun error resource.

POST /import/shotgun/errors
Jwt authorization

Responses

  • 200

    Resource serialized

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

Import persons via a .csv file.

POST /import/csv/persons
Jwt authorization

Responses

  • 201

    The lists of imported persons.

  • 400

    The .csv file is not properly formatted.

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

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"

Get aggregated time spents for given person and day.

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

Path parameters

Responses

  • 200

    Aggregated time spents for given person and day

  • 404

    Wrong date format

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

Retrieve build job related to given playlist.

GET /data/playlists/{playlist_id}/jobs/{build_job_id}
Jwt authorization

Responses

  • 200

    Build job related to given playlist

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

Download a thumbnail.

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

Responses

  • 200

    Thumbnail downloaded

  • 403

    Instance not allowed

  • 404

    Picture file not found

GET /pictures/thumbnails/preview-files/{instance_id}.png 
curl \
 --request GET 'http://api.example.com/pictures/thumbnails/preview-files/{instance_id}.png' \
 --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"

Add a task type linked to a production.

POST /data/projects/{project_id}/settings/task-types
Jwt authorization

Path parameters

Responses

  • 201

    Asset type added to production

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

Update a metadata descriptor.

PUT /data/projects/{project_id}/metadata-descriptors/{descriptor_id}
Jwt authorization

Descriptors serve to describe extra fields listed in the data attribute of entities.

Responses

  • 200

    Metadata descriptor updated

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

Delete a metadata descriptor.

DELETE /data/projects/{project_id}/metadata-descriptors/{descriptor_id}
Jwt authorization

Descriptors serve to describe extra fields listed in the data attribute of entities.

Responses

DELETE /data/projects/{project_id}/metadata-descriptors/{descriptor_id} 
curl \
 --request DELETE 'http://api.example.com/data/projects/{project_id}/metadata-descriptors/{descriptor_id}' \
 --header "Authorization: $API_KEY"

Retrieve task type schedule items for given production

GET /data/projects/{project_id}/schedule-items/task-types
Jwt authorization

Responses

  • 200

    All task types schedule items of given production

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

Update a budget name for given production

PUT /data/projects/{project_id}/budgets/{budget_id}
Jwt authorization

Responses

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

Retrieve all tasks related to a given scene.

GET /data/scenes/{scene_id}/tasks
Jwt authorization

Responses

  • 200

    All tasks related to given scene

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