curl \
--request POST 'http://api.example.com/actions/user/notifications/mark-all-as-read' \
--header "Authorization: $API_KEY"
{
"success": true
}
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"
curl \
--request DELETE 'http://api.example.com/auth/totp' \
--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/a24a6ea4-ce75-4665-a070-57453082c25/assets' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/actions/projects/a24a6ea4-ce75-4665-a070-57453082c25/asset-types/a24a6ea4-ce75-4665-a070-57453082c25/assets/share' \
--header "Authorization: $API_KEY" \
--header "Content-Type: application/json" \
--data '{"is_shared":true}'
{
"is_shared": true
}
curl \
--request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/episodes/a24a6ea4-ce75-4665-a070-57453082c25/sequences/all/casting' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/data/shots/a24a6ea4-ce75-4665-a070-57453082c25/asset-instances' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/entity-types' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/task-status' \
--header "Authorization: $API_KEY"
curl \
--request PUT 'http://api.example.com/data/tasks/a24a6ea4-ce75-4665-a070-57453082c25' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/data/organisations' \
--header "Authorization: $API_KEY"
curl \
--request DELETE 'http://api.example.com/data/organisations/a24a6ea4-ce75-4665-a070-57453082c25' \
--header "Authorization: $API_KEY"
curl \
--request PUT 'http://api.example.com/data/time-spents/a24a6ea4-ce75-4665-a070-57453082c25' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/schedule-items/' \
--header "Authorization: $API_KEY"
curl \
--request DELETE 'http://api.example.com/data/chats/a24a6ea4-ce75-4665-a070-57453082c25' \
--header "Authorization: $API_KEY"
curl \
--request PUT 'http://api.example.com/data/preview-background-files/a24a6ea4-ce75-4665-a070-57453082c25' \
--header "Authorization: $API_KEY"
curl \
--request PUT 'http://api.example.com/data/studios/a24a6ea4-ce75-4665-a070-57453082c25' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/edits' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/export/csv/tasks.csv' \
--header "Authorization: $API_KEY"
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.
curl \
--request POST 'http://api.example.com/data/asset-instances/a24a6ea4-ce75-4665-a070-57453082c25/entities/a24a6ea4-ce75-4665-a070-57453082c25/output-files/new' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/entities/a24a6ea4-ce75-4665-a070-57453082c25/output-types' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/persons/a24a6ea4-ce75-4665-a070-57453082c25/quota-shots/day/2022/7/12?count_mode=weighted' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/actions/persons/a24a6ea4-ce75-4665-a070-57453082c25/departments/add' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/playlists' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/movies/originals/preview-files/a24a6ea4-ce75-4665-a070-57453082c25.mp4' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/pictures/thumbnails/persons/a24a6ea4-ce75-4665-a070-57453082c25.png' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/metadata-descriptors' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/shots/a24a6ea4-ce75-4665-a070-57453082c25/tasks' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/data/scenes/a24a6ea4-ce75-4665-a070-57453082c25/shots' \
--header "Authorization: $API_KEY" \
--header "Content-Type: application/json" \
--data '{"shot_id":"a24a6ea4-ce75-4665-a070-57453082c25"}'
{
"shot_id": "a24a6ea4-ce75-4665-a070-57453082c25"
}
curl \
--request GET 'http://api.example.com/data/episodes/a24a6ea4-ce75-4665-a070-57453082c25/tasks' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/actions/tasks/a24a6ea4-ce75-4665-a070-57453082c25/comments/a24a6ea4-ce75-4665-a070-57453082c25/preview-files/a24a6ea4-ce75-4665-a070-57453082c25' \
--header "Authorization: $API_KEY" \
--header "Content-Type: multipart/form-data" \
--form "file=@file"
{}
curl \
--request PUT 'http://api.example.com/actions/tasks/{task_id}/set-main-preview' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/user/done-tasks' \
--header "Authorization: $API_KEY"
[
{}
]
curl \
--request GET 'http://api.example.com/data/user/filters' \
--header "Authorization: $API_KEY"
[
{}
]
curl \
--request GET 'http://api.example.com/data/user/desktop-login-logs' \
--header "Authorization: $API_KEY"
[
{}
]
only be created by the current user.
curl \
--request POST 'http://api.example.com/data/user/desktop-login-logs' \
--header "Authorization: $API_KEY" \
--header "Content-Type: application/x-www-form-urlencoded" \
--data 'date=2022-07-12'
{}
curl \
--request POST 'http://api.example.com/actions/user/notifications/mark-all-as-read' \
--header "Authorization: $API_KEY"
{
"success": true
}