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.
curl \
--request POST 'http://api.example.com/auth/login' \
--header "Authorization: $API_KEY"Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/persons' \
--header "Authorization: $API_KEY"Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/task-types' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/file-status/{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/file-status/{instance_id}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/preview-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/working-files/{instance_id}' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/data/working-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"Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/time-spents/' \
--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"Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/asset-instances/' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/news/{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/metadata-descriptors/{instance_id}' \
--header "Authorization: $API_KEY"Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/subscriptions/' \
--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/subscriptions/{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/entity-links/' \
--header "Authorization: $API_KEY"JSON format is expected. The model performs the validation automatically when instantiated.
curl \
--request POST 'http://api.example.com/data/preview-background-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/preview-background-files/{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/salary-scales' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/data/edits/{edit_id}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-types/{output_type_id}/output-files' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/entities/{entity_id}/output-files/last-revisions' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/import/shotgun/sequences' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/import/shotgun/errors' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/import/shotgun/remove/status' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/status/test-event' \
--header "Authorization: $API_KEY"Desktop login logs can only be created by current user.
curl \
--request GET 'http://api.example.com/data/persons/{person_id}/desktop-login-logs' \
--header "Authorization: $API_KEY"Add a new log entry for desktop logins.
curl \
--request POST 'http://api.example.com/data/persons/{person_id}/desktop-login-logs' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/persons/time-spents/week-table/{year}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/persons/day-offs/{year}/{month}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/playlists/{playlist_id}/download/zip' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/pictures/originals/preview-files/{instance_id}/download' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/pictures/thumbnails/organisations/{instance_id}.png' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/pictures/thumbnails/persons/{instance_id}.png' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/pictures/thumbnails/persons/{instance_id}.png' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/pictures/thumbnails/preview-background-files/{instance_id}.png' \
--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 PUT 'http://api.example.com/data/shots/{shot_id}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/scenes/{scene_id}/shots' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/sequences' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/data/projects/{project_id}/scenes' \
--header "Authorization: $API_KEY"It's mainly used for synchronisation purpose.
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/tasks' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/user/scenes/{scene_id}/task-types' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/user/chats' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/pictures/preview-background-files/{instance_id}' \
--header "Authorization: $API_KEY"