Once logged out, current user cannot access the API anymore.
curl \
--request GET 'http://api.example.com/auth/logout' \
--header "Authorization: $API_KEY"curl \
--request PUT 'http://api.example.com/auth/email-otp' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/auth/fido' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/assets/{asset_id}/cast-in' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/projects/{project_id}/asset-types' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/actions/projects/{project_id}/asset-types/{asset_type_id}/assets/share' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/projects/{project_id}/episodes/casting' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/data/scenes/{scene_id}/asset-instances' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/data/tasks/{task_id}/comments/{comment_id}/reply/{reply_id}' \
--header "Authorization: $API_KEY"It requires a text, 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.
curl \
--request POST 'http://api.example.com/actions/tasks/{task_id}/comment' \
--header "Authorization: $API_KEY"JSON format is expected. The model performs the validation automatically when instantiated.
curl \
--request POST 'http://api.example.com/data/entity-types' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/data/task-types/{instance_id}' \
--header "Authorization: $API_KEY"JSON format is expected. The model performs the validation automatically when instantiated.
curl \
--request POST 'http://api.example.com/data/organisations' \
--header "Authorization: $API_KEY"Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/file-status/' \
--header "Authorization: $API_KEY"JSON format is expected. Model performs the validation automatically when fields are modified.
curl \
--request PUT 'http://api.example.com/data/softwares/{instance_id}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/preview-files/{instance_id}' \
--header "Authorization: $API_KEY"Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/comments' \
--header "Authorization: $API_KEY"JSON format is expected. Model performs the validation automatically when fields are modified.
curl \
--request PUT 'http://api.example.com/data/time-spents/{instance_id}' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/data/time-spents/{instance_id}' \
--header "Authorization: $API_KEY"Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/day-offs/' \
--header "Authorization: $API_KEY"JSON format is expected. The model performs the validation automatically when instantiated.
curl \
--request POST 'http://api.example.com/data/day-offs/' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/data/custom-actions/{instance_id}' \
--header "Authorization: $API_KEY"JSON format is expected. The model performs the validation automatically when instantiated.
curl \
--request POST 'http://api.example.com/data/asset-instances/' \
--header "Authorization: $API_KEY"JSON format is expected. Model performs the validation automatically when fields are modified.
curl \
--request PUT 'http://api.example.com/data/playlists/{instance_id}' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/data/search-filter-groups/{instance_id}' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/data/schedule-items/{instance_id}' \
--header "Authorization: $API_KEY"JSON format is expected. The model performs the validation automatically when instantiated.
curl \
--request POST 'http://api.example.com/data/news/' \
--header "Authorization: $API_KEY"Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/metadata-descriptors/' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/data/studios/{instance_id}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/salary-scales' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/data/salary-scales/{instance_id}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/export/csv/task-types.csv' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-types' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/import/shotgun/persons' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/import/shotgun/remove/task' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/import/shotgun/remove/note' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/import/kitsu/comments' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/import/kitsu/tasks' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/persons/{person_id}/quota-shots/day/{year}/{month}/{day}' \
--header "Authorization: $API_KEY"It stores the preview file and generates three picture files matching preview when it's possible: a square thumbnail, a rectangle thumbnail and a midsize file.
curl \
--request POST 'http://api.example.com/pictures/preview-files/{instance_id}' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/pictures/thumbnails/organisations/{instance_id}' \
--header "Authorization: $API_KEY"Modifications are applied via three fields:
annotations to give all the annotations that need to be added.
updates that list annotations that needs to be modified.
deletions to list the IDs of annotations that needs to be removed.
curl \
--request PUT 'http://api.example.com/actions/preview-files/{preview_file_id}/update-annotations' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/projects/{project_id}/budgets' \
--header "Authorization: $API_KEY"curl \
--request PUT 'http://api.example.com/data/projects/{project_id}/budgets/{budget_id}' \
--header "Authorization: $API_KEY"curl \
--request PUT 'http://api.example.com/data/projects/{project_id}/budgets/{budget_id}/entries/{entry_id}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/sequences/{sequence_id}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/sequences/{sequence_id}/task-types' \
--header "Authorization: $API_KEY"It's mainly used for synchronisation purpose.
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/notifications' \
--header "Authorization: $API_KEY"entity type.
curl \
--request POST 'http://api.example.com/actions/projects/{project_id}/task-types/{task_type_id}/create-tasks/{entity_type}/' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/user/shots/{shot_id}/tasks' \
--header "Authorization: $API_KEY"This preview will be used as thumbnail to illustrate the entity.
curl \
--request PUT 'http://api.example.com/actions/tasks/{task_id}/set-main-preview' \
--header "Authorization: $API_KEY"