Resource to allow a user to change his password when he forgets it.

PUT /auth/reset-password
Jwt authorization

It uses a classic scheme: a token is sent by email to the user. Then he can change his password.

Responses

  • 200

    Password reset

  • 400

    Invalid password Wrong or expired token Inactive user

PUT /auth/reset-password 
curl \
 --request PUT 'http://api.example.com/auth/reset-password' \
 --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 send an OTP by email to user.

GET /auth/email-otp
Jwt authorization

Responses

  • 200

    OTP by email sent

  • 400

    Invalid password Wrong or expired token Inactive user

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

Retrieve all tasks related to given asset.

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

Responses

  • 200

    All tasks related to given asset

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

Retrieve all task types of tasks related to given asset.

GET /data/assets/{asset_id}/task-types
Jwt authorization

Responses

  • 200

    All task types of tasks related to given asset

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

Modify the casting of given asset.

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

Responses

  • 200

    Modification of assets linked to given asset

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

Retrieve all asset types for given project.

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

Responses

  • 200

    All asset types for given project

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

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"

Create a model with data given in the request body.

POST /data/departments
Jwt authorization

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

Responses

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

Retrieve all entries for given model.

GET /data/comments
Jwt authorization

Filters can be specified in the query string.

Responses

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

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

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

Responses

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

Update a model with data given in the request body.

PUT /data/schedule-items/{instance_id}
Jwt authorization

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

Responses

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

Retrieve all entries for given model.

GET /data/milestones/
Jwt authorization

Filters can be specified in the query string.

Responses

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

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

DELETE /data/metadata-descriptors/{instance_id}
Jwt authorization

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

DELETE /data/metadata-descriptors/{instance_id} 
curl \
 --request DELETE 'http://api.example.com/data/metadata-descriptors/{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 a model corresponding at given ID and return it as a JSON object.

GET /data/chats/{instance_id}
Jwt authorization

Responses

GET /data/chats/{instance_id} 
curl \
 --request GET 'http://api.example.com/data/chats/{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 edits related to a given episode.

GET /data/episodes/{episode_id}/edits
Jwt authorization

Responses

  • 200

    All efits related to given episode

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

Create new output file linked to assets through an instance of this asset for a given shot.

POST /data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-files/new
Jwt authorization

Some output files are linked to assets through an instance of this asset for a given shot. Each time a CG artist is satisfied by what he did on a working file, he can create an output file that will be linked to a target instance. It keeps track of the working file at the origin of the output file. An output type is required for better categorization (textures, caches, ...). A task type can be set too to give the department related to the output file.

Path parameters

Responses

  • 200

    New output file created

  • 400

    Given output file already exists Given person not found Given output type not found

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

Get all working files for a given entity and possibly a task and a name.

GET /data/entities/{entity_id}/working-files
Jwt authorization

Responses

  • 200

    All working files for given entity and possibly a task and a name

GET /data/entities/{entity_id}/working-files 
curl \
 --request GET 'http://api.example.com/data/entities/{entity_id}/working-files' \
 --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/episodes
Jwt authorization

Responses

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

Import shotgun resource.

POST /import/shotgun/steps
Jwt authorization

Responses

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

Responses

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

Retrieve all news related to a given project

GET /data/projects/news
Jwt authorization

Responses

  • 200

    All news from user open projects.

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

Return a csv file containing the presence logs based on a daily basis.

GET /data/persons/presence-logs/{month_date}
Jwt authorization

Responses

  • 200

    CSV file containing the presence logs based on a daily basis

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

Get aggregated time spents for given person and year.

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

Responses

  • 200

    Aggregated time spents for given person and year

  • 404

    Wrong date format

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

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"

Download a generic file preview as attachment.

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

Responses

  • 200

    Generic file preview downloaded as attachment

  • 403

    Instance not allowed

  • 404

    Standard file not found

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

Download the thumbnail linked to given object instance.

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

Responses

  • 200

    Thumbnail downloaded

  • 403

    Access not allowed

  • 404

    Object instance not found

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

Remove people listed in a production team.

DELETE /data/projects/{project_id}/team/{person_id}
Jwt authorization

Responses

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

Get a metadata descriptor.

GET /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

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

Delete a budget for given production

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

Responses

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

Delete given scene.

DELETE /data/scenes/{scene_id}
Jwt authorization

Responses

  • 204

    Given scene deleted

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

Retrieve given sequence.

GET /data/sequences/{sequence_id}
Jwt authorization

Responses

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

Retrieve all sequences related to a given project.

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

Responses

  • 200

    All sequences related to given project

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

Create a sequence for given project.

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

Path parameters

Responses

  • 201

    Sequence created for given project

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

Return tasks related to given asset for current user.

GET /data/user/assets/{asset_id}/tasks
Jwt authorization

Responses

  • 200

    Tasks related to given asset for current user

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

Return tasks related to given shot for current user.

GET /data/user/shots/{shot_id}/tasks
Jwt authorization

Responses

  • 200

    Tasks related to given shot

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

Return tasks related to given sequence for current user.

GET /data/user/sequences/{sequence_id}/tasks
Jwt authorization

Responses

  • 200

    Tasks related to given sequence

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

Return shots related to given sequence if the current user has access

GET /data/user/sequences/{sequence_id}/shots
Jwt authorization

to it.

Responses

  • 200

    Shots related to given sequence

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

Return tasks currently assigned to current user and of which status has

GET /data/user/done-tasks
Jwt authorization

is_done attribute set to true.

Responses

  • 200

    Finished tasks currently assigned to current user

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

Retrieve filter groups for current user and only for open projects.

GET /data/user/filter-groups
Jwt authorization

Responses

  • 200

    Filter groups for current user and only for open projects

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

Create filter group for current user and only for open projects.

POST /data/user/filter-groups
Jwt authorization

Responses

  • 201

    Filter groups for the current user and only for open projects created.

POST /data/user/filter-groups 
curl \
 --request POST 'http://api.example.com/data/user/filter-groups' \
 --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 concept entries.

GET /data/concepts
Jwt authorization

Filters can be specified in the query string.

Responses

  • 200

    All concept entries

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

Delete given concept.

DELETE /data/concepts/{concept_id}
Jwt authorization

Responses

  • 204

    Given concept deleted

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