Resource to get a challenge for a FIDO device.

GET /auth/fido

Responses

  • 200

    Challenge for FIDO device.

  • 400

    Wrong parameter.

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













































































































Share or unshare a list of assets.

POST /actions/assets/share

Responses

  • 201

    All assets modified.

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

Path parameters

  • project_id Required
  • asset_type_id Required

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"

















Resource to retrieve the casting of assets from given asset type.

GET /data/projects/{project_id}/asset-types/{asset_type_id}/casting

Path parameters

  • project_id Required
  • asset_type_id Required

Responses

  • 200

    Casting of assets from given asset type

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
















Retrieve all entity links related to given project.

GET /data/projects/{project_id}/entity-links


Results can be paginated using page and limit query parameters. If you
prefer a more accurate pagination, you can use and
cursor_created_at to get the next page.

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




















Add an asset instance to given shot.

POST /data/shots/{shot_id}/asset-instances

Path parameters

  • shot_id Required

Responses

  • 201

    Asset instance added to given shot

POST /data/shots/{shot_id}/asset-instances
curl \
 --request POST 'http://api.example.com/data/shots/{shot_id}/asset-instances' \
 --header "Authorization: $API_KEY"









































Create several comments at once.

POST /actions/projects/{project_id}/tasks/comment-many

Each comment requires a text, a task id, a task_status and a person as arguments. This way, comments keep history of status changes. When the comment is created, it updates the task status with given task status.

Path parameters

  • project_id Required

Responses

  • 201

    Given files added to the comment entry as attachments

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

































































































































































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

GET /data/departments/{instance_id}

Path parameters

  • instance_id Required

Responses

  • 200

    Model as a JSON object

  • 400

    Statement error

  • 404

    Value error

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




























Retrieve all entries for given model.

GET /data/file-status/

Filters can be specified in the query string.

Responses

  • 200

    All entries for given model

  • 400

    Format error

  • 403

    Permission denied

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




































































Update a model with data given in the request body.

PUT /data/output-types/{instance_id}

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/output-types/{instance_id}
curl \
 --request PUT 'http://api.example.com/data/output-types/{instance_id}' \
 --header "Authorization: $API_KEY"

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

DELETE /data/output-types/{instance_id}

Path parameters

  • instance_id Required

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

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




































































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

GET /data/comments/{instance_id}

Path parameters

  • instance_id Required

Responses

  • 200

    Model as a JSON object

  • 400

    Statement error

  • 404

    Value error

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








































































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

GET /data/status-automations/{instance_id}

Path parameters

  • instance_id Required

Responses

  • 200

    Model as a JSON object

  • 400

    Statement error

  • 404

    Value error

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

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"












Update a model with data given in the request body.

PUT /data/milestones/{instance_id}

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/milestones/{instance_id}
curl \
 --request PUT 'http://api.example.com/data/milestones/{instance_id}' \
 --header "Authorization: $API_KEY"




















































































Retrieve all entries for given model.

GET /data/chat-messages/

Filters can be specified in the query string.

Responses

  • 200

    All entries for given model

  • 400

    Format error

  • 403

    Permission denied

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
























































Retrieve all salary scale entries.

GET /data/salary-scales

Retrieve all salary scale entries.

Responses

  • 200

    All salary scale entries

  • 403

    Permission denied

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





















































Delete given edit.

DELETE /data/edits/{edit_id}

Path parameters

  • edit_id Required

Responses

  • 204

    Given edit deleted

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















































































Export as csv.

GET /export/csv/projects.csv

Responses

  • 200

    Exported as csv

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

























Return last working files revision for each file name for given task.

GET /data/tasks/{task_id}/working-files/last-revisions

Path parameters

  • task_id Required

Responses

  • 200

    Last working files revision for each file name for given task

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









































































































































































Import remove instance.

POST /import/shotgun/remove/episode

Responses

  • 204

    Instance removed

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












































Import project edits.

POST /import/csv/projects/{project_id}/edits

Path parameters

  • project_id Required

Responses

  • 201

    Edits imported

  • 400

    Format error

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

Import project casting links via a .csv file.

POST /import/csv/projects/{project_id}/casting

Path parameters

  • project_id Required

Responses

  • 201

    The lists of imported casting links.

  • 400

    The .csv file is not properly formatted.

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


















































































Persons

























































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

GET /data/persons/time-spents/week-table/{year}

Path parameters

  • year Required

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 week and person.

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

Path parameters

  • person_id Required
  • year Required
  • week Required

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"


































































































































































































Set given preview as main preview of the related entity.

PUT /actions/preview-files/{preview_file_id}/set-main-preview

This preview will be used to illustrate the entity.

Path parameters

  • preview_file_id Required

Responses

  • 200

    Given preview set as main preview

PUT /actions/preview-files/{preview_file_id}/set-main-preview
curl \
 --request PUT 'http://api.example.com/actions/preview-files/{preview_file_id}/set-main-preview' \
 --header "Authorization: $API_KEY"













Return the list of projects currently running.

GET /data/projects/open

Most of the time, past projects are not needed.

Responses

  • 200

    All running projects

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












Retrieve task types linked to the production

GET /data/projects/{project_id}/task-types

Path parameters

  • project_id Required

Responses

  • 200

    Task types linked to the production

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
















































Return preview background files linked to a production

GET /data/projects/{project_id}/settings/preview-background-files

Path parameters

  • project_id Required

Responses

  • 200

    Preview background files linked to production

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

Path parameters

  • project_id Required
  • task_type_id Required

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"

Retrieve episodes schedule items for given task type

GET /data/projects/{project_id}/schedule-items/{task_type_id}/episodes

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 given sequence.

GET /data/sequences/{sequence_id}

Path parameters

  • sequence_id Required

Responses

  • 200

    Given sequence

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




























Create a shot for given project.

POST /data/projects/{project_id}/shots

Path parameters

  • project_id Required

Responses

  • 201

    Shot created for given project

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

Retrieve all scenes related to a given project.

GET /data/projects/{project_id}/scenes

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"













































Return task amount, task done amount, total estimation, total duration

GET /data/tasks/open-tasks/stats

by status by task type by project for open projects. It aggregates the
result at the project level.

Responses

  • 200

    A dict organized by project that contains the results for each task type and status pairs.

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
































































































































Create a new task for given concept and task type.

POST /actions/projects/{project_id}/task-types/{task_type_id}/concepts/create-tasks

Path parameters

  • project_id Required
  • task_type_id Required

Responses

  • 201

    New task for given concept and task type created

POST /actions/projects/{project_id}/task-types/{task_type_id}/concepts/create-tasks
curl \
 --request POST 'http://api.example.com/actions/projects/{project_id}/task-types/{task_type_id}/concepts/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

access to it.

Path parameters

  • project_id Required

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"




























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

GET /data/user/done-tasks

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"
































Delete given filter group if it's owned by the current user.

DELETE /data/user/filter-groups/{filter_group_id}

Path parameters

  • filter_id Required

Responses

  • 204

    Empty response

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













































































Get chat details.

GET /data/entities/{entity_id}/chat

Path parameters

  • entity_id Required

    ID of the entity related to the chat

Responses

  • 200

    Chat information

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
















































Retrieve all task types related to a given concept.

GET /data/concepts/{concept_id}/task-types

Path parameters

  • concept_id Required

Responses

  • 200

    All task types related to given concept

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