Log user out by revoking his auth tokens.

GET /auth/logout
Jwt authorization

Once logged out, current user cannot access the API anymore.

Responses

  • 200

    Logout successful

  • 500

    Access token not found

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

Resource to allow a user to change his password when he forgets it.

POST /auth/reset-password
Jwt authorization

It uses a classic scheme: a token is sent by email to the user. Then he can change his password.

Responses

  • 200

    Reset token sent

  • 400

    Email not listed in database

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

Resource to send an OTP by email to user.

GET /auth/email-otp
Jwt authorization

Responses

  • 200

    OTP by email sent

  • 400

    Invalid password Wrong or expired token Inactive user

GET /auth/email-otp 
curl \
 --request GET 'http://api.example.com/auth/email-otp' \
 --header "Authorization: $API_KEY"

Resource to allow a user to disable OTP by email.

DELETE /auth/email-otp
Jwt authorization

Responses

  • 200

    OTP by email disabled.

  • 400

    Invalid password. Wrong or expired token. Inactive user. Wrong 2FA.

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

Resource to get a challenge for a FIDO device.

GET /auth/fido
Jwt authorization

Responses

  • 200

    Challenge for FIDO device.

  • 400

    Wrong parameter.

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

Retrieve all task types of tasks related to given asset.

GET /data/assets/{asset_id}/task-types
Jwt authorization

Responses

  • 200

    All task types of tasks related to given asset

GET /data/assets/{asset_id}/task-types 
curl \
 --request GET 'http://api.example.com/data/assets/{asset_id}/task-types' \
 --header "Authorization: $API_KEY"

Retrieve all asset types for given project.

GET /data/projects/{project_id}/asset-types
Jwt authorization

Responses

  • 200

    All asset types for given project

GET /data/projects/{project_id}/asset-types 
curl \
 --request GET 'http://api.example.com/data/projects/{project_id}/asset-types' \
 --header "Authorization: $API_KEY"

Share or unshare all assets for given project and asset type.

POST /actions/projects/{project_id}/asset-types/{asset_type_id}/assets/share
Jwt authorization

Path parameters

Responses

  • 201

    All assets modified.

POST /actions/projects/{project_id}/asset-types/{asset_type_id}/assets/share 
curl \
 --request POST 'http://api.example.com/actions/projects/{project_id}/asset-types/{asset_type_id}/assets/share' \
 --header "Authorization: $API_KEY"

Retrieve all shared assets used in project.

GET /data/projects/{project_id}/assets/shared-used
Jwt authorization

Responses

  • 200

    All shared assets used in project

GET /data/projects/{project_id}/assets/shared-used 
curl \
 --request GET 'http://api.example.com/data/projects/{project_id}/assets/shared-used' \
 --header "Authorization: $API_KEY"

Add an asset instance to given shot.

POST /data/shots/{shot_id}/asset-instances
Jwt authorization

Path parameters

Responses

  • 201

    Asset instance added to given shot

POST /data/shots/{shot_id}/asset-instances 
curl \
 --request POST 'http://api.example.com/data/shots/{shot_id}/asset-instances' \
 --header "Authorization: $API_KEY"

Remove an asset instance from given shot.

DELETE /data/shots/{shot_id}/asset-instances/{asset_instance_id}
Jwt authorization

Responses

  • 204

    Asset instance removed from given shot

DELETE /data/shots/{shot_id}/asset-instances/{asset_instance_id} 
curl \
 --request DELETE 'http://api.example.com/data/shots/{shot_id}/asset-instances/{asset_instance_id}' \
 --header "Authorization: $API_KEY"

Reply to given comment.

POST /data/tasks/{task_id}/comments/{comment_id}/reply
Jwt authorization

Add comment to its replies list.

Path parameters

Responses

  • 200

    Reply to given comment

POST /data/tasks/{task_id}/comments/{comment_id}/reply 
curl \
 --request POST 'http://api.example.com/data/tasks/{task_id}/comments/{comment_id}/reply' \
 --header "Authorization: $API_KEY"

Creates new comments for given task. Each comments requires a text, a

POST /actions/tasks/{task_id}/batch-comment
Jwt authorization

task_status and a person as arguments.

Path parameters

Responses

  • 201

    New comments created

POST /actions/tasks/{task_id}/batch-comment 
curl \
 --request POST 'http://api.example.com/actions/tasks/{task_id}/batch-comment' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/projects
Jwt authorization

Filters can be specified in the query string.

Responses

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

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

GET /data/projects/{instance_id}
Jwt authorization

Responses

GET /data/projects/{instance_id} 
curl \
 --request GET 'http://api.example.com/data/projects/{instance_id}' \
 --header "Authorization: $API_KEY"

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

DELETE /data/projects/{instance_id}
Jwt authorization

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

DELETE /data/projects/{instance_id} 
curl \
 --request DELETE 'http://api.example.com/data/projects/{instance_id}' \
 --header "Authorization: $API_KEY"

Create a model with data given in the request body.

POST /data/project-status
Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

POST /data/project-status 
curl \
 --request POST 'http://api.example.com/data/project-status' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

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

JSON format is expected. Model performs the validation automatically when fields are modified.

Responses

PUT /data/project-status/{instance_id} 
curl \
 --request PUT 'http://api.example.com/data/project-status/{instance_id}' \
 --header "Authorization: $API_KEY"

Create a model with data given in the request body.

POST /data/entities
Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

POST /data/entities 
curl \
 --request POST 'http://api.example.com/data/entities' \
 --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

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/{instance_id}' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/task-types
Jwt authorization

Filters can be specified in the query string.

Responses

GET /data/task-types 
curl \
 --request GET 'http://api.example.com/data/task-types' \
 --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.

Responses

PUT /data/task-status/{instance_id} 
curl \
 --request PUT 'http://api.example.com/data/task-status/{instance_id}' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/tasks/{instance_id}
Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Responses

PUT /data/tasks/{instance_id} 
curl \
 --request PUT 'http://api.example.com/data/tasks/{instance_id}' \
 --header "Authorization: $API_KEY"

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

GET /data/departments/{instance_id}
Jwt authorization

Responses

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

Retrieve all entries for given model.

GET /data/file-status/
Jwt authorization

Filters can be specified in the query string.

Responses

GET /data/file-status/ 
curl \
 --request GET 'http://api.example.com/data/file-status/' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

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

JSON format is expected. Model performs the validation automatically when fields are modified.

Responses

PUT /data/file-status/{instance_id} 
curl \
 --request PUT 'http://api.example.com/data/file-status/{instance_id}' \
 --header "Authorization: $API_KEY"

Retrieve a software corresponding at given ID and return it as a

GET /data/softwares/{instance_id}
Jwt authorization

JSON object.

Responses

GET /data/softwares/{instance_id} 
curl \
 --request GET 'http://api.example.com/data/softwares/{instance_id}' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/output-files/{instance_id}
Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Responses

PUT /data/output-files/{instance_id} 
curl \
 --request PUT 'http://api.example.com/data/output-files/{instance_id}' \
 --header "Authorization: $API_KEY"

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

DELETE /data/output-files/{instance_id}
Jwt authorization

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

DELETE /data/output-files/{instance_id} 
curl \
 --request DELETE 'http://api.example.com/data/output-files/{instance_id}' \
 --header "Authorization: $API_KEY"

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

DELETE /data/output-types/{instance_id}
Jwt authorization

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

DELETE /data/output-types/{instance_id} 
curl \
 --request DELETE 'http://api.example.com/data/output-types/{instance_id}' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/preview-files
Jwt authorization

Filters can be specified in the query string.

Responses

GET /data/preview-files 
curl \
 --request GET 'http://api.example.com/data/preview-files' \
 --header "Authorization: $API_KEY"

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

GET /data/preview-files/{instance_id}
Jwt authorization

Responses

GET /data/preview-files/{instance_id} 
curl \
 --request GET 'http://api.example.com/data/preview-files/{instance_id}' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/preview-files/{instance_id}
Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Responses

PUT /data/preview-files/{instance_id} 
curl \
 --request PUT 'http://api.example.com/data/preview-files/{instance_id}' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/attachment-files
Jwt authorization

Filters can be specified in the query string.

Responses

GET /data/attachment-files 
curl \
 --request GET 'http://api.example.com/data/attachment-files' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/custom-actions/{instance_id}
Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Responses

PUT /data/custom-actions/{instance_id} 
curl \
 --request PUT 'http://api.example.com/data/custom-actions/{instance_id}' \
 --header "Authorization: $API_KEY"

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

DELETE /data/custom-actions/{instance_id}
Jwt authorization

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

DELETE /data/custom-actions/{instance_id} 
curl \
 --request DELETE 'http://api.example.com/data/custom-actions/{instance_id}' \
 --header "Authorization: $API_KEY"

Create a model with data given in the request body.

POST /data/status-automations/
Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

POST /data/status-automations/ 
curl \
 --request POST 'http://api.example.com/data/status-automations/' \
 --header "Authorization: $API_KEY"

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

GET /data/status-automations/{instance_id}
Jwt authorization

Responses

GET /data/status-automations/{instance_id} 
curl \
 --request GET 'http://api.example.com/data/status-automations/{instance_id}' \
 --header "Authorization: $API_KEY"

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

DELETE /data/playlists/{instance_id}
Jwt authorization

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

DELETE /data/playlists/{instance_id} 
curl \
 --request DELETE 'http://api.example.com/data/playlists/{instance_id}' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/events/
Jwt authorization

Filters can be specified in the query string.

Responses

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

Update a model with data given in the request body.

PUT /data/notifications/{instance_id}
Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Responses

PUT /data/notifications/{instance_id} 
curl \
 --request PUT 'http://api.example.com/data/notifications/{instance_id}' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/search-filter-groups/
Jwt authorization

Filters can be specified in the query string.

Responses

GET /data/search-filter-groups/ 
curl \
 --request GET 'http://api.example.com/data/search-filter-groups/' \
 --header "Authorization: $API_KEY"

Create a model with data given in the request body.

POST /data/search-filter-groups/
Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

POST /data/search-filter-groups/ 
curl \
 --request POST 'http://api.example.com/data/search-filter-groups/' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/search-filter-groups/{instance_id}
Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Responses

PUT /data/search-filter-groups/{instance_id} 
curl \
 --request PUT 'http://api.example.com/data/search-filter-groups/{instance_id}' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/schedule-items/
Jwt authorization

Filters can be specified in the query string.

Responses

GET /data/schedule-items/ 
curl \
 --request GET 'http://api.example.com/data/schedule-items/' \
 --header "Authorization: $API_KEY"

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

DELETE /data/schedule-items/{instance_id}
Jwt authorization

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

DELETE /data/schedule-items/{instance_id} 
curl \
 --request DELETE 'http://api.example.com/data/schedule-items/{instance_id}' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/milestones/
Jwt authorization

Filters can be specified in the query string.

Responses

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

Retrieve all entries for given model.

GET /data/chat-messages/
Jwt authorization

Filters can be specified in the query string.

Responses

GET /data/chat-messages/ 
curl \
 --request GET 'http://api.example.com/data/chat-messages/' \
 --header "Authorization: $API_KEY"

Create a model with data given in the request body.

POST /data/chat-messages/
Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

POST /data/chat-messages/ 
curl \
 --request POST 'http://api.example.com/data/chat-messages/' \
 --header "Authorization: $API_KEY"

Create a model with data given in the request body.

POST /data/preview-background-files
Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

POST /data/preview-background-files 
curl \
 --request POST 'http://api.example.com/data/preview-background-files' \
 --header "Authorization: $API_KEY"

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

GET /data/preview-background-files/{instance_id}
Jwt authorization

Responses

GET /data/preview-background-files/{instance_id} 
curl \
 --request GET 'http://api.example.com/data/preview-background-files/{instance_id}' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/preview-background-files/{instance_id}
Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Responses

PUT /data/preview-background-files/{instance_id} 
curl \
 --request PUT 'http://api.example.com/data/preview-background-files/{instance_id}' \
 --header "Authorization: $API_KEY"

Create a model with data given in the request body.

POST /data/salary-scales
Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

POST /data/salary-scales 
curl \
 --request POST 'http://api.example.com/data/salary-scales' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/plugins/{instance_id}
Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Responses

PUT /data/plugins/{instance_id} 
curl \
 --request PUT 'http://api.example.com/data/plugins/{instance_id}' \
 --header "Authorization: $API_KEY"

Retrieve all edit entries.

GET /data/edits/all
Jwt authorization

Filters can be specified in the query string.

Responses

GET /data/edits/all 
curl \
 --request GET 'http://api.example.com/data/edits/all' \
 --header "Authorization: $API_KEY"

Retrieve all previews related to a given edit.

GET /data/edits/{edit_id}/preview-files
Jwt authorization

It sends them as a dict. Keys are related task type ids and values are arrays of preview for this task type.

Responses

  • 200

    All previews related to given edit

GET /data/edits/{edit_id}/preview-files 
curl \
 --request GET 'http://api.example.com/data/edits/{edit_id}/preview-files' \
 --header "Authorization: $API_KEY"

Retrieve all time spents linked to a given entity.

GET /data/entities/{entity_id}/time-spents
Jwt authorization

Responses

  • 200

    All time spents linked to given entity

GET /data/entities/{entity_id}/time-spents 
curl \
 --request GET 'http://api.example.com/data/entities/{entity_id}/time-spents' \
 --header "Authorization: $API_KEY"

Export a given playlist as csv.

GET /export/csv/playlists/{playlist_id}
Jwt authorization

Responses

  • 200

    Playlist exported as csv

GET /export/csv/playlists/{playlist_id} 
curl \
 --request GET 'http://api.example.com/export/csv/playlists/{playlist_id}' \
 --header "Authorization: $API_KEY"

Export as csv.

GET /export/csv/persons.csv
Jwt authorization

Responses

GET /export/csv/persons.csv 
curl \
 --request GET 'http://api.example.com/export/csv/persons.csv' \
 --header "Authorization: $API_KEY"

Get last revisions of output files for given instance grouped by output type and file name.

GET /data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-files/last-revisions
Jwt authorization

Responses

  • 200

    Last revisions of output files for given instance grouped by output type and file name

GET /data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-files/last-revisions 
curl \
 --request GET 'http://api.example.com/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-files/last-revisions' \
 --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

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/{asset_instance_id}/entities/{temporal_entity_id}/output-types' \
 --header "Authorization: $API_KEY"

Get all working files for a given entity and possibly a task and a name.

GET /data/entities/{entity_id}/working-files
Jwt authorization

Responses

  • 200

    All working files for given entity and possibly a task and a name

GET /data/entities/{entity_id}/working-files 
curl \
 --request GET 'http://api.example.com/data/entities/{entity_id}/working-files' \
 --header "Authorization: $API_KEY"

Get last revisions of output files for given entity grouped by output type and file name.

GET /data/entities/{entity_id}/output-files/last-revisions
Jwt authorization

Responses

  • 200

    Last revisions of output files for given entity grouped by output type and file name

GET /data/entities/{entity_id}/output-files/last-revisions 
curl \
 --request GET 'http://api.example.com/data/entities/{entity_id}/output-files/last-revisions' \
 --header "Authorization: $API_KEY"

Get all output files for given entity.

GET /data/entities/{entity_id}/output-files
Jwt authorization

Responses

  • 200

    All output files for given entity

GET /data/entities/{entity_id}/output-files 
curl \
 --request GET 'http://api.example.com/data/entities/{entity_id}/output-files' \
 --header "Authorization: $API_KEY"

Get all output files for given poject.

GET /data/projects/{project_id}/output-files
Jwt authorization

Responses

  • 200

    All output files for given project.

GET /data/projects/{project_id}/output-files 
curl \
 --request GET 'http://api.example.com/data/projects/{project_id}/output-files' \
 --header "Authorization: $API_KEY"

Import shotgun resource.

POST /import/shotgun/persons
Jwt authorization

Responses

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

Import shotgun resource.

POST /import/shotgun/projects
Jwt authorization

Responses

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

Import shotgun resource.

POST /import/shotgun/sequences
Jwt authorization

Responses

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

Import shotgun resource.

POST /import/shotgun/scenes
Jwt authorization

Responses

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

Import shotgun resource.

POST /import/shotgun/versions
Jwt authorization

Responses

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

Delete error.

DELETE /import/shotgun/errors/{error_id}
Jwt authorization

Responses

  • 204

    Error deleted

  • 404

    Error non-existant or Statement error

DELETE /import/shotgun/errors/{error_id} 
curl \
 --request DELETE 'http://api.example.com/import/shotgun/errors/{error_id}' \
 --header "Authorization: $API_KEY"

Import remove instance.

POST /import/shotgun/remove/scene
Jwt authorization

Responses

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

Import remove instance.

POST /import/shotgun/remove/asset
Jwt authorization

Responses

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

Import remove instance.

POST /import/shotgun/remove/task
Jwt authorization

Responses

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

Import remove instance.

POST /import/shotgun/remove/note
Jwt authorization

Responses

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

Import project shots via a .csv file.

POST /import/csv/projects/{project_id}/shots
Jwt authorization

Path parameters

Responses

  • 201

    The lists of imported assets.

  • 400

    The .csv file is not properly formatted.

POST /import/csv/projects/{project_id}/shots 
curl \
 --request POST 'http://api.example.com/import/csv/projects/{project_id}/shots' \
 --header "Authorization: $API_KEY"

Import the estimations of task-types for given episode of given project.

POST /import/csv/projects/{project_id}/episodes/{episode_id}/task-types/{task_type_id}/estimations
Jwt authorization

Path parameters

Responses

POST /import/csv/projects/{project_id}/episodes/{episode_id}/task-types/{task_type_id}/estimations 
curl \
 --request POST 'http://api.example.com/import/csv/projects/{project_id}/episodes/{episode_id}/task-types/{task_type_id}/estimations' \
 --header "Authorization: $API_KEY"

Import an OTIO file to enter frame_in / frame_out / nb_frames (it can

POST /import/otio/projects/{project_id}
Jwt authorization

be every adapter supported by OpenTimelineIO, for example: EDL, OTIO...
).

Path parameters

Responses

  • 201

    .

  • 400

    The .otio file is not properly formatted.

POST /import/otio/projects/{project_id} 
curl \
 --request POST 'http://api.example.com/import/otio/projects/{project_id}' \
 --header "Authorization: $API_KEY"

Import Kitsu resource.

POST /import/kitsu/projects
Jwt authorization

Responses

POST /import/kitsu/projects 
curl \
 --request POST 'http://api.example.com/import/kitsu/projects' \
 --header "Authorization: $API_KEY"

Generate a main:test event.

GET /status/test-event
Jwt authorization

Responses

GET /status/test-event 
curl \
 --request GET 'http://api.example.com/status/test-event' \
 --header "Authorization: $API_KEY"

Retrieve desktop login logs.

GET /data/persons/{person_id}/desktop-login-logs
Jwt authorization

Desktop login logs can only be created by current user.

Responses

GET /data/persons/{person_id}/desktop-login-logs 
curl \
 --request GET 'http://api.example.com/data/persons/{person_id}/desktop-login-logs' \
 --header "Authorization: $API_KEY"

Return a csv file containing the presence logs based on a daily basis.

GET /data/persons/presence-logs/{month_date}
Jwt authorization

Responses

  • 200

    CSV file containing the presence logs based on a daily basis

GET /data/persons/presence-logs/{month_date} 
curl \
 --request GET 'http://api.example.com/data/persons/presence-logs/{month_date}' \
 --header "Authorization: $API_KEY"

Get aggregated time spents for given person and day.

GET /data/persons/{person_id}/time-spents/day/{year}/{month}/{day}
Jwt authorization

Path parameters

Responses

  • 200

    Aggregated time spents for given person and day

  • 404

    Wrong date format

GET /data/persons/{person_id}/time-spents/day/{year}/{month}/{day} 
curl \
 --request GET 'http://api.example.com/data/persons/{person_id}/time-spents/day/{year}/{month}/{day}' \
 --header "Authorization: $API_KEY"

Return a table giving time spent by user and by month for given year.

GET /data/persons/time-spents/year-table/
Jwt authorization

Responses

  • 200

    Table giving time spent by user and by month for given year

GET /data/persons/time-spents/year-table/ 
curl \
 --request GET 'http://api.example.com/data/persons/time-spents/year-table/' \
 --header "Authorization: $API_KEY"

Sends an email to given person to invite him/her to connect to Kitsu.

GET /actions/persons/{person_id}/invite
Jwt authorization
GET /actions/persons/{person_id}/invite 
curl \
 --request GET 'http://api.example.com/actions/persons/{person_id}/invite' \
 --header "Authorization: $API_KEY"

Add a user to given department.

POST /actions/persons/{person_id}/departments/add
Jwt authorization

Path parameters

Responses

  • 201

    User added to given department

POST /actions/persons/{person_id}/departments/add 
curl \
 --request POST 'http://api.example.com/actions/persons/{person_id}/departments/add' \
 --header "Authorization: $API_KEY"

Remove a user from given department.

DELETE /actions/persons/{person_id}/departments/{department_id}
Jwt authorization

Responses

  • 204

    User removed from given department

DELETE /actions/persons/{person_id}/departments/{department_id} 
curl \
 --request DELETE 'http://api.example.com/actions/persons/{person_id}/departments/{department_id}' \
 --header "Authorization: $API_KEY"

Retrieve build job related to given playlist.

GET /data/playlists/{playlist_id}/jobs/{build_job_id}
Jwt authorization

Responses

  • 200

    Build job related to given playlist

GET /data/playlists/{playlist_id}/jobs/{build_job_id} 
curl \
 --request GET 'http://api.example.com/data/playlists/{playlist_id}/jobs/{build_job_id}' \
 --header "Authorization: $API_KEY"

Download the thumbnail representing given attachment file.

GET /pictures/thumbnails/attachment-files/{attachment_file_id}.png
Jwt authorization

Responses

  • 200

    Thumbnail downloaded

  • 403

    Instance not allowed

  • 404

    Picture file not found

GET /pictures/thumbnails/attachment-files/{attachment_file_id}.png 
curl \
 --request GET 'http://api.example.com/pictures/thumbnails/attachment-files/{attachment_file_id}.png' \
 --header "Authorization: $API_KEY"

Download a thumbnail.

GET /movies/tiles/preview-files/{instance_id}.png
Jwt authorization

Responses

  • 200

    Thumbnail downloaded

  • 403

    Instance not allowed

  • 404

    Picture file not found

GET /movies/tiles/preview-files/{instance_id}.png 
curl \
 --request GET 'http://api.example.com/movies/tiles/preview-files/{instance_id}.png' \
 --header "Authorization: $API_KEY"

Download the thumbnail linked to given object instance.

GET /pictures/thumbnails/persons/{instance_id}.png
Jwt authorization

Responses

  • 200

    Thumbnail downloaded

  • 403

    Access not allowed

  • 404

    Object instance not found

GET /pictures/thumbnails/persons/{instance_id}.png 
curl \
 --request GET 'http://api.example.com/pictures/thumbnails/persons/{instance_id}.png' \
 --header "Authorization: $API_KEY"

Download the thumbnail linked to given object instance.

GET /pictures/thumbnails/projects/{instance_id}
Jwt authorization

Responses

  • 200

    Thumbnail downloaded

  • 403

    Access not allowed

  • 404

    Object instance not found

GET /pictures/thumbnails/projects/{instance_id} 
curl \
 --request GET 'http://api.example.com/pictures/thumbnails/projects/{instance_id}' \
 --header "Authorization: $API_KEY"

Create a thumbnail for given object instance.

POST /pictures/thumbnails/projects/{instance_id}
Jwt authorization

Path parameters

Responses

  • 200

    Thumbnail created

  • 404

    Cannot found related object.

POST /pictures/thumbnails/projects/{instance_id} 
curl \
 --request POST 'http://api.example.com/pictures/thumbnails/projects/{instance_id}' \
 --header "Authorization: $API_KEY"

Create a thumbnail for given object instance.

POST /pictures/thumbnails/preview-background-files/{instance_id}.png
Jwt authorization

Path parameters

Responses

  • 200

    Thumbnail created

  • 404

    Cannot found related object.

POST /pictures/thumbnails/preview-background-files/{instance_id}.png 
curl \
 --request POST 'http://api.example.com/pictures/thumbnails/preview-background-files/{instance_id}.png' \
 --header "Authorization: $API_KEY"