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

  • 200

    Login successful

  • 400

    Login failed

  • 500

    Database not reachable

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

Resource to allow a user to disable TOTP.

DELETE /auth/totp
Jwt authorization

Responses

  • 200

    TOTP disabled

  • 400

    TOTP not enabled

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

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

GET /data/assets/with-tasks
Jwt authorization

Adds project name and asset type name and all related tasks.
If episode_id is given as parameter, it returns assets not linked
to an episode and assets linked to given episode.

Responses

  • 200

    All assets with tasks

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

Resource to retrieve the casting of episodes.

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

Path parameters

  • project_id Required

Responses

  • 200

    Casting of episodes

GET /data/projects/{project_id}/episodes/casting 
curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/episodes/casting' \
 --header "Authorization: $API_KEY"

Get chat details.

GET /data/entities/{entity_id}/chat
Jwt authorization

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/a24a6ea4-ce75-4665-a070-57453082c25/chat' \
 --header "Authorization: $API_KEY"

Delete chat message.

DELETE /data/entities/{entity_id}/chat/messages/{chat_message_id}
Jwt authorization

Path parameters

  • entity_id Required

    ID of the entity related to the chat

  • chat_message_id Required

    ID of the chat message

Responses

  • 204

    Empty response

DELETE /data/entities/{entity_id}/chat/messages/{chat_message_id} 
curl \
 --request DELETE 'http://api.example.com/data/entities/a24a6ea4-ce75-4665-a070-57453082c25/chat/messages/1' \
 --header "Authorization: $API_KEY"

Create a concept for given project.

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

Path parameters

  • project_id Required

Responses

  • 201

    Concept created for given project

POST /data/projects/{project_id}/concepts 
curl \
 --request POST 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/concepts' \
 --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

Path parameters

  • instance_id Required

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/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

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

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/task-status/{instance_id} 
curl \
 --request PUT 'http://api.example.com/data/task-status/a24a6ea4-ce75-4665-a070-57453082c25' \
 --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.

Path parameters

  • instance_id Required

Responses

  • 200

    Model updated

  • 400

    Error

PUT /data/organisations/{instance_id} 
curl \
 --request PUT 'http://api.example.com/data/organisations/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

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

DELETE /data/organisations/{instance_id}
Jwt authorization

Path parameters

  • instance_id Required

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

DELETE /data/organisations/{instance_id} 
curl \
 --request DELETE 'http://api.example.com/data/organisations/a24a6ea4-ce75-4665-a070-57453082c25' \
 --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

  • 200

    Model created

  • 400

    Error

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/search-filter-groups/{instance_id}
Jwt authorization

Path parameters

  • instance_id Required

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/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

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

GET /data/metadata-descriptors/{instance_id}
Jwt authorization

Path parameters

  • instance_id Required

Responses

  • 200

    Model as a JSON object

  • 400

    Statement error

  • 404

    Value error

GET /data/metadata-descriptors/{instance_id} 
curl \
 --request GET 'http://api.example.com/data/metadata-descriptors/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

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

DELETE /data/metadata-descriptors/{instance_id}
Jwt authorization

Path parameters

  • instance_id Required

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

DELETE /data/metadata-descriptors/{instance_id} 
curl \
 --request DELETE 'http://api.example.com/data/metadata-descriptors/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

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

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

Path parameters

  • instance_id Required

Responses

  • 200

    Model as a JSON object

  • 400

    Statement error

  • 404

    Value error

GET /data/salary-scales/{instance_id} 
curl \
 --request GET 'http://api.example.com/data/salary-scales/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Get all software items for all departments.

GET /data/departments/software-licenses
Jwt authorization

Responses

  • 200

    A dictionary of departments with their software items

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

Return all types of output generated for given instance.

GET /data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-types
Jwt authorization

Path parameters

  • asset_instance_id Required
  • temporal_entity_id Required

Responses

  • 200

    All types of output generated for given instance and temporal_entity

GET /data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-types 
curl \
 --request GET 'http://api.example.com/data/asset-instances/a24a6ea4-ce75-4665-a070-57453082c25/entities/a24a6ea4-ce75-4665-a070-57453082c25/output-types' \
 --header "Authorization: $API_KEY"

Import remove instance.

POST /import/shotgun/remove/step
Jwt authorization

Responses

  • 204

    Instance removed

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

Delete a budget for given production

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

Path parameters

  • project_id Required
  • budget_id Required

Responses

  • 204

    Empty response

DELETE /data/projects/{project_id}/budgets/{budget_id} 
curl \
 --request DELETE 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/budgets/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"