Resource to allow a user to enable OTP by email.

POST /auth/email-otp
Jwt authorization

Responses

  • 200

    OTP by email enabled

  • 400

    Invalid password Wrong or expired token Inactive user

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

Retrieve given asset type.

GET /data/asset-types/{asset_type_id}
Jwt authorization

Responses

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

Share or unshare a list of assets.

POST /actions/assets/share
Jwt authorization

Responses

  • 201

    All assets modified.

POST /actions/assets/share 
curl \
 --request POST 'http://api.example.com/actions/assets/share' \
 --header "Authorization: $API_KEY"

Retrieve all shared assets used in project episode.

GET /data/projects/{project_id}/episodes/{episode_id}/assets/shared-used
Jwt authorization

Responses

  • 200

    All shared assets used in project episode

GET /data/projects/{project_id}/episodes/{episode_id}/assets/shared-used 
curl \
 --request GET 'http://api.example.com/data/projects/{project_id}/episodes/{episode_id}/assets/shared-used' \
 --header "Authorization: $API_KEY"

Breakdown

Resource to retrieve the casting of shots from all sequences of given

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

project.

Responses

  • 200

    Casting for all shots from given project.

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

Return all attachment files related to given task.

GET /data/tasks/{task_id}/attachment-files
Jwt authorization

Responses

  • 200

    All attachment files related to given task

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

Update a model with data given in the request body.

PUT /data/departments/{instance_id}
Jwt authorization

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

Responses

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

Update a model with data given in the request body.

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

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

Responses

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

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"

Create a model with data given in the request body.

POST /data/search-filters/
Jwt authorization

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

Responses

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

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

DELETE /data/search-filter-groups/{instance_id}
Jwt authorization

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

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

Retrieve all entries for given model.

GET /data/subscriptions/
Jwt authorization

Filters can be specified in the query string.

Responses

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

Create a model with data given in the request body.

POST /data/entity-links/
Jwt authorization

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

Responses

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

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

GET /data/preview-background-files/{instance_id}
Jwt authorization

Responses

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

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

DELETE /data/studios/{instance_id}
Jwt authorization

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

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

Export as csv.

GET /export/csv/time-spents.csv
Jwt authorization

Responses

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

Return all types of output generated for given entity.

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

Responses

  • 200

    All types of output generated for given entity

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

Import remove instance.

POST /import/shotgun/remove/project
Jwt authorization

Responses

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

Import Kitsu resource.

POST /import/kitsu/entities
Jwt authorization

Responses

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

News

Get aggregated time spents for given person and week.

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

Responses

  • 200

    Aggregated time spents for given person and week

  • 404

    Wrong date format

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

Retrieve all previews related to a given entity.

GET /data/playlists/entities/{entity_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 entity

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

Download the thumbnail representing given attachment file.

GET /pictures/thumbnails/attachment-files/{attachment_file_id}.png
Jwt authorization

Responses

  • 200

    Thumbnail downloaded

  • 403

    Instance not allowed

  • 404

    Picture file not found

GET /pictures/thumbnails/attachment-files/{attachment_file_id}.png 
curl \
 --request GET 'http://api.example.com/pictures/thumbnails/attachment-files/{attachment_file_id}.png' \
 --header "Authorization: $API_KEY"

Download a generic file preview.

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

Responses

  • 200

    Generic file preview downloaded

  • 403

    Instance not allowed

  • 404

    Non-movie file not found

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

Retrieve asset types schedule items for given task type

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

Responses

  • 200

    All asset types schedule items for given task type

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

Create a budget for given production.

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

Path parameters

Responses

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

Retrieve budget entries for given production

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

Responses

  • 200

    All budget entries of given production and budget

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

Delete given shot.

DELETE /data/shots/{shot_id}
Jwt authorization

Responses

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

Retrieve all task types related to a given scene.

GET /data/scenes/{scene_id}/task-types
Jwt authorization

Responses

  • 200

    All task types related to given scene

GET /data/scenes/{scene_id}/task-types 
curl \
 --request GET 'http://api.example.com/data/scenes/{scene_id}/task-types' \
 --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 comments to tasks related to given project.

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

It's mainly used for synchronisation purpose.

Responses

  • 200

    All comments to tasks related to given project

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

Assign given task list to given person.

PUT /actions/tasks/{task_id}/assign
Jwt authorization

Responses

  • 200

    Given task assigned to given person

  • 400

    Assignee non-existent in database

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

Remove all assignations set to given task.

PUT /actions/tasks/clear-assignation
Jwt authorization

Responses

  • 200

    All assignations removed

PUT /actions/tasks/clear-assignation 
curl \
 --request PUT 'http://api.example.com/actions/tasks/clear-assignation' \
 --header "Authorization: $API_KEY"

Retrieve desktop login logs.

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

Responses

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

Change notification read status.

PUT /data/user/notifications/{notification_id}
Jwt authorization

Responses

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