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"

Retrieve given asset type.

GET /data/asset-types/{asset_type_id}
Jwt authorization

Responses

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

Retrieve all camera instances linked to scene.

GET /data/scenes/{scene_id}/camera-instances
Jwt authorization

Responses

  • 201

    All camera instances linked to scene

GET /data/scenes/{scene_id}/camera-instances 
curl \
 --request GET 'http://api.example.com/data/scenes/{scene_id}/camera-instances' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/entity-types
Jwt authorization

Filters can be specified in the query string.

Responses

GET /data/entity-types 
curl \
 --request GET 'http://api.example.com/data/entity-types' \
 --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 a model corresponding at given ID and return it as a JSON object.

GET /data/organisations/{instance_id}
Jwt authorization

Responses

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

Retrieve all entries for given model.

GET /data/working-files
Jwt authorization

Filters can be specified in the query string.

Responses

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

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

GET /data/comments/{instance_id}
Jwt authorization

Responses

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

Retrieve all entries for given model.

GET /data/day-offs/
Jwt authorization

Filters can be specified in the query string.

Responses

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

Update a model with data given in the request body.

PUT /data/asset-instances/{instance_id}
Jwt authorization

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

Responses

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

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

DELETE /data/events/{instance_id}
Jwt authorization

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

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

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

GET /data/notifications/{instance_id}
Jwt authorization

Responses

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

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

DELETE /data/search-filters/{instance_id}
Jwt authorization

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

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

Create a model with data given in the request body.

POST /data/schedule-items/
Jwt authorization

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

Responses

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

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

GET /data/news/{instance_id}
Jwt authorization

Responses

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

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

GET /data/studios/{instance_id}
Jwt authorization

Responses

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

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

DELETE /data/salary-scales/{instance_id}
Jwt authorization

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

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

Retrieve all login logs.

GET /data/events/login-logs/last
Jwt authorization

Responses

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

Generate an output file path from file tree template

POST /data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-file-path
Jwt authorization

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.

Path parameters

Responses

  • 200

    Output file path generated

  • 400

    Malformed file tree

POST /data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-file-path 
curl \
 --request POST 'http://api.example.com/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-file-path' \
 --header "Authorization: $API_KEY"

Import remove instance.

POST /import/shotgun/remove/projectconnection
Jwt authorization

Responses

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

Import persons via a .csv file.

POST /import/csv/persons
Jwt authorization

Responses

  • 201

    The lists of imported persons.

  • 400

    The .csv file is not properly formatted.

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

Get API name and version.

GET /
Jwt authorization

Responses

  • 200

    API name and version

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

Retrieve a single given news related to a given project

GET /data/projects/{project_id}/news/{news_id}
Jwt authorization

Responses

  • 200

    Single given news related to given project

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

Get ended shots used for quota calculation of this month.

GET /data/persons/{person_id}/quota-shots/month/{year}/{month}
Jwt authorization

Responses

  • 200

    Ended shots used for quota calculation of this month

  • 404

    Wrong date format

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

Allow admin to change password for given user.

POST /actions/persons/{person_id}/change-password
Jwt authorization

Prior to modifying the password, it requires to be admin. An admin can't change other admins password. The new password requires a confirmation to ensure that the admin didn't make a mistake by typing the new password.

Path parameters

Responses

  • 200

    Password changed

  • 400

    Invalid password or inactive user

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

Download a generic file preview.

GET /pictures/originals/preview-files/{instance_id}.{extension}
Jwt authorization

Responses

  • 200

    Generic file preview downloaded

  • 403

    Instance not allowed

  • 404

    Non-movie file not found

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

Download the thumbnail linked to given object instance.

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

Responses

  • 200

    Thumbnail downloaded

  • 403

    Access not allowed

  • 404

    Object instance not found

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

Extract a frame from a preview_file

GET /actions/preview-files/{preview_file_id}/extract-frame
Jwt authorization

Responses

GET /actions/preview-files/{preview_file_id}/extract-frame 
curl \
 --request GET 'http://api.example.com/actions/preview-files/{preview_file_id}/extract-frame' \
 --header "Authorization: $API_KEY"

Allow to change orders of previews for a single revision.

PUT /actions/preview-files/{preview_file_id}/update-position
Jwt authorization

This preview will be used to illustrate the entity.

Responses

  • 200

    Orders of previews changed for a single revision

PUT /actions/preview-files/{preview_file_id}/update-position 
curl \
 --request PUT 'http://api.example.com/actions/preview-files/{preview_file_id}/update-position' \
 --header "Authorization: $API_KEY"

Projects

Add a task type linked to a production.

POST /data/projects/{project_id}/settings/task-types
Jwt authorization

Path parameters

Responses

  • 201

    Asset type added to production

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

Retrieve sequences schedule items for given task type

GET /data/projects/{project_id}/schedule-items/{task_type_id}/sequences
Jwt authorization

Responses

  • 200

    All sequences schedule items for given task type

GET /data/projects/{project_id}/schedule-items/{task_type_id}/sequences 
curl \
 --request GET 'http://api.example.com/data/projects/{project_id}/schedule-items/{task_type_id}/sequences' \
 --header "Authorization: $API_KEY"

Delete given scene.

DELETE /data/scenes/{scene_id}
Jwt authorization

Responses

  • 204

    Given scene deleted

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

Retrieve all shots related to a given episode.

GET /data/episodes/{episode_id}/shots
Jwt authorization

Responses

  • 200

    All shots related to given episode

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

Retrieve all task types related to a given episode.

GET /data/episodes/{episode_id}/task-types
Jwt authorization

Responses

  • 200

    All task types related to given episode

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

Create a shot for given project.

POST /data/projects/{project_id}/shots
Jwt authorization

Path parameters

Responses

  • 201

    Shot created for given project

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

Retrieve all sequences related to a given project.

GET /data/projects/{project_id}/sequences
Jwt authorization

Responses

  • 200

    All sequences related to given project

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

Delete time spent by a person on a task for a given day.

DELETE /actions/tasks/{task_id}/time-spents/{date}/persons/{person_id}
Jwt authorization

Responses

  • 201

    Time spent by given person on given task for given day is removed

  • 404

    Wrong date format

DELETE /actions/tasks/{task_id}/time-spents/{date}/persons/{person_id} 
curl \
 --request DELETE 'http://api.example.com/actions/tasks/{task_id}/time-spents/{date}/persons/{person_id}' \
 --header "Authorization: $API_KEY"

Return tasks requiring feedback for current user departments.

GET /data/user/tasks-to-check
Jwt authorization


If the user is not a supervisor, it returns an empty list.

Responses

  • 200

    Tasks requiring feedback in current user departments.

GET /data/user/tasks-to-check 
curl \
 --request GET 'http://api.example.com/data/user/tasks-to-check' \
 --header "Authorization: $API_KEY"

Mark all notifications as read for the current user.

POST /actions/user/notifications/mark-all-as-read
Jwt authorization

Responses

  • 200

    All notifications marked as read

POST /actions/user/notifications/mark-all-as-read 
curl \
 --request POST 'http://api.example.com/actions/user/notifications/mark-all-as-read' \
 --header "Authorization: $API_KEY"

Resource to retrieve the entities linked on a given entity.

GET /data/entities/{entity_id}/entities-linked/with-tasks
Jwt authorization

Responses

  • 200

    Entities linked on given entity

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

Create a concept for given project.

POST /data/projects/{project_id}/concepts
Jwt authorization

Path parameters

Responses

  • 201

    Concept created for given project

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