Once logged out, current user cannot access the API anymore.
curl \
--request GET 'http://api.example.com/auth/logout' \
--header "Authorization: $API_KEY"It uses a classic scheme: a token is sent by email to the user. Then he can change his password.
curl \
--request POST 'http://api.example.com/auth/reset-password' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/projects/{project_id}/entities/{entity_id}/casting' \
--header "Authorization: $API_KEY"Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/project-status' \
--header "Authorization: $API_KEY"JSON format is expected. The model performs the validation automatically when instantiated.
curl \
--request POST 'http://api.example.com/data/entities' \
--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/task-status/{instance_id}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/file-status/{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/output-files' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/data/output-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/attachment-files' \
--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/attachment-files/{instance_id}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/time-spents/{instance_id}' \
--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/day-offs/{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/events/' \
--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/events/{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/search-filter-groups/' \
--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/entity-links/{instance_id}' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/data/preview-background-files/{instance_id}' \
--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/plugins/{instance_id}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/projects/{project_id}/edits' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/export/csv/playlists/{playlist_id}' \
--header "Authorization: $API_KEY"Generate file path based on several parameters: asset instance, output type, task type, revision, mode, name and separator. Revision can be computed automatically as next revision in case no revision is given in parameter.
curl \
--request POST 'http://api.example.com/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-file-path' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/entities/{entity_id}/output-types/{output_type_id}/output-files' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/import/shotgun/steps' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/import/shotgun/remove/shot' \
--header "Authorization: $API_KEY"be every adapter supported by OpenTimelineIO, for example: edl, otio...
).
curl \
--request POST 'http://api.example.com/import/otio/projects/{project_id}/episodes/{episode_id}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/persons/{person_id}/time-spents/{date}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/persons/{person_id}/quota-shots/week/{year}/{week}' \
--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"Result is paginated and can be sorted.
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/playlists' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/playlists/{playlist_id}/jobs/{build_job_id}' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/data/playlists/{playlist_id}/jobs/{build_job_id}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/actions/preview-files/{preview_file_id}/extract-frame' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/projects/{project_id}/budgets/{budget_id}/entries/{entry_id}' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/data/search' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/shots/all' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/data/episodes/{episode_id}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/episodes/{episode_id}/shots' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/episodes/{episode_id}/task-types' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/tasks/{task_id}/previews' \
--header "Authorization: $API_KEY"date of all tasks of assigned to this person and the last end date.
curl \
--request GET 'http://api.example.com/data/persons/task-dates' \
--header "Authorization: $API_KEY"uploaded afterward.
Revision is automatically set: it is equal to last revision + 1. It can
be also set manually.
curl \
--request POST 'http://api.example.com/actions/tasks/{task_id}/comments/{comment_id}/add-preview' \
--header "Authorization: $API_KEY"project if user has access to this project.
curl \
--request GET 'http://api.example.com/data/user/projects/{project_id}/asset-types/{asset_type_id}/assets' \
--header "Authorization: $API_KEY"to it.
curl \
--request GET 'http://api.example.com/data/user/projects/{project_id}/sequences' \
--header "Authorization: $API_KEY"is_done attribute set to true.
curl \
--request GET 'http://api.example.com/data/user/done-tasks' \
--header "Authorization: $API_KEY"curl \
--request PUT 'http://api.example.com/data/user/filters/{filter_id}' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/actions/user/chats/{entity_id}/join' \
--header "Authorization: $API_KEY"When a user subscribes, he gets notified everytime a comment is posted on the task.
curl \
--request POST 'http://api.example.com/actions/user/tasks/{task_id}/subscribe' \
--header "Authorization: $API_KEY"and current user.
curl \
--request DELETE 'http://api.example.com/actions/user/sequences/{sequence_id}/task-types/{task_type_id}/unsubscribe' \
--header "Authorization: $API_KEY"