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"

Retrieve all entities that are not shot, sequence, episode, or edit.

GET /data/assets
Jwt authorization

Adds project name and asset type name.

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

Retrieve the list of shots that cast given asset.

GET /data/assets/{asset_id}/cast-in
Jwt authorization

Responses

  • 200

    List of shots that cast given asset

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

Retrieve all shot asset instances linked to given asset.

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

Responses

  • 200

    All shot asset instances linked to given asset

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

Breakdown

Return all attachment files related to given project.

GET /data/projects/{project_id}/attachment-files
Jwt authorization

Responses

  • 200

    All attachment files related to given project

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

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"

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

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

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

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

Retrieve all entries for given model.

GET /data/task-status
Jwt authorization

Filters can be specified in the query string.

Responses

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

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

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

Responses

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

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"

Retrieve all entries for given model.

GET /data/entity-links/
Jwt authorization

Filters can be specified in the query string.

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

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

DELETE /data/chats/{instance_id}
Jwt authorization

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

DELETE /data/chats/{instance_id} 
curl \
 --request DELETE 'http://api.example.com/data/chats/{instance_id}' \
 --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/preview-background-files/{instance_id}
Jwt authorization

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

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

Retrieve all salary scale entries.

GET /data/salary-scales
Jwt authorization

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"

Retrieve all tasks related to a given edit.

GET /data/edits/{edit_id}/tasks
Jwt authorization

Responses

  • 200

    All tasks related to given edit

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

Export casting linked to a given project as csv.

GET /export/csv/projects/{project_id}/casting.csv
Jwt authorization

Responses

  • 200

    Casting exported as csv

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

Export as csv.

GET /export/csv/persons.csv
Jwt authorization

Responses

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

Export as csv.

GET /export/csv/projects.csv
Jwt authorization

Responses

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

Get last revisions of output files for given instance grouped by output type and file name.

GET /data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-files/last-revisions
Jwt authorization

Responses

  • 200

    Last revisions of output files for given instance grouped by output type and file name

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

Get last revisions of output files for given entity grouped by output type and file name.

GET /data/entities/{entity_id}/output-files/last-revisions
Jwt authorization

Responses

  • 200

    Last revisions of output files for given entity grouped by output type and file name

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

Import remove instance.

POST /import/shotgun/remove/status
Jwt authorization

Responses

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

Import an OTIO file to enter frame_in / frame_out / nb_frames (it can

POST /import/otio/projects/{project_id}/episodes/{episode_id}
Jwt authorization

be every adapter supported by OpenTimelineIO, for example: edl, otio...
).

Path parameters

Responses

  • 201

    .

  • 400

    The .otio file is not properly formatted.

POST /import/otio/projects/{project_id}/episodes/{episode_id} 
curl \
 --request POST 'http://api.example.com/import/otio/projects/{project_id}/episodes/{episode_id}' \
 --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"

Get day off object for given person and date.

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

Responses

  • 200

    Day off object for given person and date

  • 404

    Wrong date format

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

Return all day off recorded for given year and person.

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

Responses

  • 200

    All day off recorded for given year and person

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

Add a user to given department.

POST /actions/persons/{person_id}/departments/add
Jwt authorization

Path parameters

Responses

  • 201

    User added to given department

POST /actions/persons/{person_id}/departments/add 
curl \
 --request POST 'http://api.example.com/actions/persons/{person_id}/departments/add' \
 --header "Authorization: $API_KEY"

Retrieve all playlists related to given project.

GET /data/projects/{project_id}/playlists/{playlist_id}
Jwt authorization

Responses

  • 200

    All playlists related to given project

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

Return the list of projects currently running.

GET /data/projects/open
Jwt authorization

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"

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"

Add an asset type linked to a production.

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

Path parameters

Responses

  • 201

    Asset type added to production

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

Remove a task type from a production.

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

Responses

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

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 a budget for given production

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

Responses

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

Retrieve all assets for a given shot.

GET /data/shots/{shot_id}/assets
Jwt authorization

Responses

  • 200

    All assets for given shot

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

Retrieve all tasks related to a given sequence.

GET /data/sequences/{sequence_id}/shot-tasks
Jwt authorization

Responses

  • 200

    All task types related to given sequence

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

Create an episode for given project.

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

Path parameters

Responses

  • 201

    Episode created for given project

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

Retrieve number of tasks by status, task_types and episodes for given project.

GET /data/projects/{project_id}/episodes/stats
Jwt authorization

Responses

  • 200

    Number of tasks by status, task types and episodes for given project

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

Return task assigned to given user of which status has is_done flag sets to false.

GET /data/persons/{person_id}/tasks
Jwt authorization

Responses

  • 200

    Tasks assigned to user that are not done

GET /data/persons/{person_id}/tasks 
curl \
 --request GET 'http://api.example.com/data/persons/{person_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 currently assigned to current user and of which status has

GET /data/user/tasks
Jwt authorization

is_done attribute set to false.

Responses

  • 200

    Unfinished tasks currently assigned to current user

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

Return notification matching given id, only if it's a notification that

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

belongs to current user.

Responses

  • 200

    Notification matching given ID

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

Create a subscription entry for given task and current user.

POST /actions/user/tasks/{task_id}/subscribe
Jwt authorization

When a user subscribes, he gets notified everytime a comment is posted on the task.

Path parameters

Responses

  • 201

    Subscription entry created

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

Resource to retrieve the entities linked on a given entity.

GET /data/entities/{entity_id}/entities-linked/with-tasks
Jwt authorization

Responses

  • 200

    Entities linked on given entity

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