Authentication

Log user out by revoking his auth tokens.

GET /auth/logout
Jwt authorization

Once logged out, current user cannot access the API anymore.

Responses

  • 200

    Logout successful

  • 500

    Access token not found

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

Resource to allow a user to disable OTP by email.

DELETE /auth/email-otp
Jwt authorization

Responses

  • 200

    OTP by email disabled.

  • 400

    Invalid password. Wrong or expired token. Inactive user. Wrong 2FA.

DELETE /auth/email-otp 
curl \
 --request DELETE 'http://api.example.com/auth/email-otp' \
 --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 login with SAML SSO.

POST /auth/saml/sso
Jwt authorization

Responses

  • 302

    Login successful, redirect to the home page.

  • 400

    Wrong parameter

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

Resource to allow a user to login with SAML SSO.

GET /auth/saml/login
Jwt authorization

Responses

  • 302

    Redirect to the SAML IDP.

  • 400

    Wrong parameter.

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

Retrieve all asset instances instantiated inside given asset.

GET /data/assets/{asset_id}/asset-asset-instances
Jwt authorization

Responses

  • 200

    All asset instances instantiated inside given asset

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

Retrieve all assets for given project.

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

Responses

  • 200

    All assets for given project

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

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"

Remove an asset instance from given shot.

DELETE /data/shots/{shot_id}/asset-instances/{asset_instance_id}
Jwt authorization

Responses

  • 204

    Asset instance removed from given shot

DELETE /data/shots/{shot_id}/asset-instances/{asset_instance_id} 
curl \
 --request DELETE 'http://api.example.com/data/shots/{shot_id}/asset-instances/{asset_instance_id}' \
 --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"

Creates new comments for given task. Each comments requires a text, a

POST /actions/tasks/{task_id}/batch-comment
Jwt authorization

task_status and a person as arguments.

Path parameters

Responses

  • 201

    New comments created

POST /actions/tasks/{task_id}/batch-comment 
curl \
 --request POST 'http://api.example.com/actions/tasks/{task_id}/batch-comment' \
 --header "Authorization: $API_KEY"

Creates new comments for given task. Each comments requires a task_id,

POST /actions/tasks/batch-comment
Jwt authorization

text, a task_status and a person as arguments.

Responses

  • 201

    New comments created

POST /actions/tasks/batch-comment 
curl \
 --request POST 'http://api.example.com/actions/tasks/batch-comment' \
 --header "Authorization: $API_KEY"

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

GET /data/projects/{instance_id}
Jwt authorization

Responses

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

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

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

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

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

Retrieve all entries for given model.

GET /data/entities
Jwt authorization

Filters can be specified in the query string.

Responses

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

Create a model with data given in the request body.

POST /data/entities
Jwt authorization

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

Responses

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

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

DELETE /data/entities/{instance_id}
Jwt authorization

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

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

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

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

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

DELETE /data/task-status/{instance_id} 
curl \
 --request DELETE '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"

Retrieve all entries for given model.

GET /data/organisations
Jwt authorization

Filters can be specified in the query string.

Responses

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

Update a model with data given in the request body.

PUT /data/organisations/{instance_id}
Jwt authorization

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

Responses

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

Create a model with data given in the request body.

POST /data/file-status/
Jwt authorization

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

Responses

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

Create a model with data given in the request body.

POST /data/working-files
Jwt authorization

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

Responses

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

Retrieve all entries for given model.

GET /data/time-spents/
Jwt authorization

Filters can be specified in the query string.

Responses

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

Retrieve all entries for given model.

GET /data/day-offs/
Jwt authorization

Filters can be specified in the query string.

Responses

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

Create a model with data given in the request body.

POST /data/day-offs/
Jwt authorization

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

Responses

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

Responses

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

Update a model with data given in the request body.

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

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

Responses

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

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

GET /data/events/{instance_id}
Jwt authorization

Responses

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

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

GET /data/milestones/{instance_id}
Jwt authorization

Responses

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

Create a model with data given in the request body.

POST /data/metadata-descriptors/
Jwt authorization

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

Responses

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

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

GET /data/subscriptions/{instance_id}
Jwt authorization

Responses

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

Update a model with data given in the request body.

PUT /data/chat-messages/{instance_id}
Jwt authorization

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

Responses

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

Retrieve all edits related to a given project.

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

Responses

  • 200

    All edits related to given project

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

Events

Files

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"

Import remove instance.

POST /import/shotgun/remove/projectconnection
Jwt authorization

Responses

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

Import project assets via a .csv file.

POST /import/csv/projects/{project_id}/assets
Jwt authorization

Path parameters

Responses

  • 201

    The lists of imported assets.

  • 400

    The .csv file is not properly formatted.

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

Retrieve API name, version and status as txt.

GET /status.txt
Jwt authorization

Responses

  • 200

    API name, version and status as txt

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

Return all day off recorded for given week and person.

GET /data/persons/{person_id}/day-offs/week/{year}/{week}
Jwt authorization

Responses

  • 200

    All day off recorded for given week and person

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

Download a thumbnail.

GET /movies/tiles/preview-files/{instance_id}.png
Jwt authorization

Responses

  • 200

    Thumbnail downloaded

  • 403

    Instance not allowed

  • 404

    Picture file not found

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

Download the thumbnail linked to given object instance.

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

Responses

  • 200

    Thumbnail downloaded

  • 403

    Access not allowed

  • 404

    Object instance not found

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

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"

Retrieve a budget entry for given production and budget

GET /data/projects/{project_id}/budgets/{budget_id}/entries/{entry_id}
Jwt authorization

Responses

  • 200

    Budget entry retrieved

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

Retrieve quotas statistics for shots.

GET /data/projects/{project_id}/quotas/persons/{person_id}
Jwt authorization

Responses

  • 200

    Quotas statistics for shots

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

Delete all tasks for a given task type and project.

DELETE /actions/projects/{project_id}/task-types/{task_type_id}/delete-tasks
Jwt authorization

It's mainly used when tasks are created by mistake at the beginning of the project.

Responses

  • 204

    All tasks for given task type and project deleted

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

Create a new task for given shot and task type.

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

Path parameters

Responses

  • 201

    New task for given shot and task type created

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

Return asset types related to given project if the current user has

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

access to it.

Responses

  • 200

    Asset types related to given project

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