Log in user by creating and registering auth tokens.

POST /auth/login
Jwt authorization

Login is based on email and password. If no user match given email and a destkop ID, it looks in matching the desktop ID with the one stored in database. It is useful for clients that run on desktop tools and that don't know user email.

Responses

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

Tokens are considered as outdated every two weeks.

GET /auth/refresh-token
Jwt authorization

This route allows to make their lifetime long before they get outdated.

Responses

GET /auth/refresh-token 
curl \
 --request GET 'http://api.example.com/auth/refresh-token' \
 --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 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 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 all entities that are not shot, sequence, episode, or edit.

GET /data/assets/all
Jwt authorization

Adds project name and asset type name.

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

Retrieve all shared assets used in project.

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

Responses

  • 200

    All shared assets used in project

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

Resource to allow the modification of assets linked to an entity.

PUT /data/projects/{project_id}/entities/{entity_id}/casting
Jwt authorization

Responses

  • 200

    Modification of assets linked to an entity

PUT /data/projects/{project_id}/entities/{entity_id}/casting 
curl \
 --request PUT 'http://api.example.com/data/projects/{project_id}/entities/{entity_id}/casting' \
 --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
Jwt authorization

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"

Add an asset instance to given shot.

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

Path parameters

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"

Download attachment file.

GET /data/attachment-files/{attachment_file_id}/file/{file_name}
Jwt authorization

Responses

  • 200

    Attachment file downloaded

  • 404

    Download failed

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

Add given files to the comment entry as attachments.

POST /actions/tasks/{task_id}/comments/{comment_id}/add-attachment
Jwt authorization

Path parameters

Responses

  • 201

    Given files added to the comment entry as attachments

POST /actions/tasks/{task_id}/comments/{comment_id}/add-attachment 
curl \
 --request POST 'http://api.example.com/actions/tasks/{task_id}/comments/{comment_id}/add-attachment' \
 --header "Authorization: $API_KEY"

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"

Retrieve all entries for given model.

GET /data/entity-types
Jwt authorization

Filters can be specified in the query string.

Responses

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

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

GET /data/entities/{instance_id}
Jwt authorization

Responses

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

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

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

Responses

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

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

GET /data/tasks/{instance_id}
Jwt authorization

Responses

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

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

DELETE /data/departments/{instance_id}
Jwt authorization

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

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

Retrieve all entries for given model.

GET /data/file-status/
Jwt authorization

Filters can be specified in the query string.

Responses

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

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

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

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 all entries for given model.

GET /data/preview-files
Jwt authorization

Filters can be specified in the query string.

Responses

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

Create a model with data given in the request body.

POST /data/attachment-files
Jwt authorization

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

Responses

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

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

DELETE /data/attachment-files/{instance_id}
Jwt authorization

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

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

Retrieve all entries for given model.

GET /data/status-automations/
Jwt authorization

Filters can be specified in the query string.

Responses

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

Retrieve all entries for given model.

GET /data/asset-instances/
Jwt authorization

Filters can be specified in the query string.

Responses

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

Create a model with data given in the request body.

POST /data/asset-instances/
Jwt authorization

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

Responses

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

Update a model with data given in the request body.

PUT /data/asset-instances/{instance_id}
Jwt authorization

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

Responses

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

Create a model with data given in the request body.

POST /data/events/
Jwt authorization

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

Responses

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

Create a model with data given in the request body.

POST /data/notifications/
Jwt authorization

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

Responses

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

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

GET /data/notifications/{instance_id}
Jwt authorization

Responses

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

Update a model with data given in the request body.

PUT /data/search-filters/{instance_id}
Jwt authorization

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

Responses

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

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

DELETE /data/search-filters/{instance_id}
Jwt authorization

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

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

Retrieve all entries for given model.

GET /data/search-filter-groups/
Jwt authorization

Filters can be specified in the query string.

Responses

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

Update a model with data given in the request body.

PUT /data/news/{instance_id}
Jwt authorization

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

Responses

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

Update a model with data given in the request body.

PUT /data/subscriptions/{instance_id}
Jwt authorization

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

Responses

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

Retrieve all entries for given model.

GET /data/chats/
Jwt authorization

Filters can be specified in the query string.

Responses

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

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"

Create a model with data given in the request body.

POST /data/salary-scales
Jwt authorization

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

Responses

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

Update a model with data given in the request body.

PUT /data/salary-scales/{instance_id}
Jwt authorization

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

Responses

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

Retrieve all entries for given model.

GET /data/plugins
Jwt authorization

Filters can be specified in the query string.

Responses

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

Edits

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"

Retrieve all preview files linked to a given entity.

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

Responses

  • 200

    All preview files linked to given entity

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

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"

Store a working file.

POST /data/working-files/{working_file_id}/file
Jwt authorization

Path parameters

Responses

  • 201

    Working file stored

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

Import shotgun resource.

POST /import/shotgun/status
Jwt authorization

Responses

POST /import/shotgun/status 
curl \
 --request POST 'http://api.example.com/import/shotgun/status' \
 --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 remove instance.

POST /import/shotgun/remove/episode
Jwt authorization

Responses

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

Import remove instance.

POST /import/shotgun/remove/sequence
Jwt authorization

Responses

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

Get API name and version.

GET /
Jwt authorization

Responses

  • 200

    API name and version

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

Create desktop login logs.

POST /data/persons/{person_id}/desktop-login-logs
Jwt authorization

Add a new log entry for desktop logins.

Path parameters

Responses

  • 201

    Desktop login log entry created.

POST /data/persons/{person_id}/desktop-login-logs 
curl \
 --request POST 'http://api.example.com/data/persons/{person_id}/desktop-login-logs' \
 --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 month for given year.

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

Responses

  • 200

    Table giving time spent by user and by month for given year

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

Return all day offs recorded for given and person.

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

Responses

  • 200

    All day off recorded for given person.

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

Create a thumbnail for given object instance.

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

Path parameters

Responses

  • 200

    Thumbnail created

  • 404

    Cannot found related object.

POST /pictures/thumbnails/organisations/{instance_id}.png 
curl \
 --request POST 'http://api.example.com/pictures/thumbnails/organisations/{instance_id}.png' \
 --header "Authorization: $API_KEY"

Download the thumbnail linked to given object instance.

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

Responses

  • 200

    Thumbnail downloaded

  • 403

    Access not allowed

  • 404

    Object instance not found

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

Create a thumbnail for given object instance.

POST /pictures/thumbnails/projects/{instance_id}
Jwt authorization

Path parameters

Responses

  • 200

    Thumbnail created

  • 404

    Cannot found related object.

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

Create a thumbnail for given object instance.

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

Path parameters

Responses

  • 200

    Thumbnail created

  • 404

    Cannot found related object.

POST /pictures/thumbnails/projects/{instance_id}.png 
curl \
 --request POST 'http://api.example.com/pictures/thumbnails/projects/{instance_id}.png' \
 --header "Authorization: $API_KEY"

Download the thumbnail linked to given object instance.

GET /pictures/thumbnails/preview-background-files/{instance_id}.png
Jwt authorization

Responses

  • 200

    Thumbnail downloaded

  • 403

    Access not allowed

  • 404

    Object instance not found

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

Return the people listed in a production team.

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

Responses

  • 200

    People listed in a production team

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

Remove an asset type from a production.

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

Responses

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

Add a status automation linked to a production.

POST /data/projects/{project_id}/settings/status-automations
Jwt authorization

Path parameters

Responses

  • 201

    Status automation added to production

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

Remove a status automation from a production.

DELETE /data/projects/{project_id}/settings/status-automations/{status_automation_id}
Jwt authorization

Responses

DELETE /data/projects/{project_id}/settings/status-automations/{status_automation_id} 
curl \
 --request DELETE 'http://api.example.com/data/projects/{project_id}/settings/status-automations/{status_automation_id}' \
 --header "Authorization: $API_KEY"

Remove a preview background file from a production.

DELETE /data/projects/{project_id}/settings/preview-background-files/{preview_background_file_id}
Jwt authorization

Responses

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

Create a new metadata descriptor

POST /data/projects/{project_id}/metadata-descriptors
Jwt authorization

It serves to describe extra fields listed in the data attribute of entities.

Path parameters

Responses

  • 201

    Create a new metadata descriptor

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

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 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"

Update a budget entry for given production and budget

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

Responses

  • 200

    Budget entry updated

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

Delete a budget entry for given production and budget.

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

Responses

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

Get aggregated time spents by month for given project.

GET /data/projects/{project_id}/budgets/time-spents
Jwt authorization

Responses

  • 200

    Aggregated time spents for given person and month

  • 400

    Wrong ID format

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

Search

Search for resource

POST /data/search
Jwt authorization

Responses

  • 200

    List of entities that contain the query

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

Retrieve all task types related to a given shot.

GET /data/shots/{shot_id}/task-types
Jwt authorization

Responses

  • 200

    All task types related to given shot

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

Mark given scene as source of given shot.

POST /data/scenes/{scene_id}/shots
Jwt authorization

Path parameters

Responses

  • 200

    Given scene marked as source of given shot

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

Retrieve all episode entries.

GET /data/episodes
Jwt authorization

Filters can be specified in the query string.

Responses

  • 200

    All episode entries

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

Retrieve all tasks related to a given episode.

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

Responses

  • 200

    All tasks related to given episode

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

Retrieve all shots tasks related to a given episode.

GET /data/episodes/{episode_id}/shot-tasks
Jwt authorization

Responses

  • 200

    All shots tasks related to given episode

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

Retrieve all assets tasks related to a given episode.

GET /data/episodes/{episode_id}/asset-tasks
Jwt authorization

Responses

  • 200

    All assets tasks related to given episode

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

Delete given sequence.

DELETE /data/sequences/{sequence_id}
Jwt authorization

Responses

  • 204

    Given sequence deleted

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

Retrieve all shot entries for a given sequence.

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

Filters can be specified in the query string.

Responses

  • 200

    All shot entries for given sequence

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

Retrieve all scenes related to a given project.

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

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"

Create a scene for given project.

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

Path parameters

Responses

  • 201

    Scene created for given project

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