Authentication













Allow a user to register himself to the service.

POST /auth/register

Responses

  • 201

    Registration successful

  • 400

    Invalid password or email

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
































































Resource to allow a user to login with SAML SSO.

POST /auth/saml/sso

Responses

  • 302

    Login successful, redirect to the home page.

  • 400

    Wrong parameter

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





























Delete given asset.

DELETE /data/assets/{asset_id}

Path parameters

  • asset_id Required

Responses

  • 204

    Empty response

DELETE /data/assets/{asset_id}
curl \
 --request DELETE 'http://api.example.com/data/assets/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"




















































Retrieve all asset types of assets casted in given shot.

GET /data/shots/{shot_id}/asset-types

Path parameters

  • shot_id Required

Responses

  • 200

    All asset types of assets casted in given shot

GET /data/shots/{shot_id}/asset-types
curl \
 --request GET 'http://api.example.com/data/shots/a24a6ea4-ce75-4665-a070-57453082c25/asset-types' \
 --header "Authorization: $API_KEY"

Retrieve all assets for given project.

GET /data/projects/{project_id}/assets

Path parameters

  • project_id Required

Responses

  • 200

    All assets for given project

GET /data/projects/{project_id}/assets
curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/assets' \
 --header "Authorization: $API_KEY"









































































Add an asset instance to given shot.

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

Path parameters

  • shot_id Required

Responses

  • 201

    Asset instance added to given shot

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




Chat





Get chat messages for an entity.

GET /data/entities/{entity_id}/chat/messages

Path parameters

  • entity_id Required

    ID of the entity related to the chat

Responses

  • 200

    Chat messages

GET /data/entities/{entity_id}/chat/messages
curl \
 --request GET 'http://api.example.com/data/entities/a24a6ea4-ce75-4665-a070-57453082c25/chat/messages' \
 --header "Authorization: $API_KEY"













































Create a new comment for given task.

POST /actions/tasks/{task_id}/comment

It requires a text, a task_status and a person as arguments. This way, comments keep history of status changes. When the comment is created, it updates the task status with given task status.

Path parameters

  • task_id Required

Responses

  • 201

    New comment created

POST /actions/tasks/{task_id}/comment
curl \
 --request POST 'http://api.example.com/actions/tasks/a24a6ea4-ce75-4665-a070-57453082c25/comment' \
 --header "Authorization: $API_KEY"

















Retrieve all concepts, adds project name and asset type name and all related tasks.

GET /data/concepts/with-tasks

Query parameters

  • project_id

Responses

  • 200

    All concepts

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












Retrieve all tasks related to a given concept.

GET /data/concepts/{concept_id}/tasks

Path parameters

  • concept_id Required

Responses

  • 200

    All tasks related to given concept

GET /data/concepts/{concept_id}/tasks
curl \
 --request GET 'http://api.example.com/data/concepts/a24a6ea4-ce75-4665-a070-57453082c25/tasks' \
 --header "Authorization: $API_KEY"

































Create a model with data given in the request body.

POST /data/projects

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

Responses

  • 200

    Model created

  • 400

    Error

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








































































































































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

DELETE /data/departments/{instance_id}

Path parameters

  • instance_id Required

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

DELETE /data/departments/{instance_id}
curl \
 --request DELETE 'http://api.example.com/data/departments/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"












Update a model with data given in the request body.

PUT /data/organisations/{instance_id}

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

Path parameters

  • instance_id Required

Responses

  • 200

    Model updated

  • 400

    Error

PUT /data/organisations/{instance_id}
curl \
 --request PUT 'http://api.example.com/data/organisations/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"




Retrieve all entries for given model.

GET /data/file-status/

Filters can be specified in the query string.

Responses

  • 200

    All entries for given model

  • 400

    Format error

  • 403

    Permission denied

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
























































Retrieve all entries for given model.

GET /data/output-files

Filters can be specified in the query string.

Responses

  • 200

    All entries for given model

  • 400

    Format error

  • 403

    Permission denied

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




















































Delete a preview file corresponding at given ID and retuns

DELETE /data/preview-files/{instance_id}

a 204 status code.

Path parameters

  • instance_id Required

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

DELETE /data/preview-files/{instance_id}
curl \
 --request DELETE 'http://api.example.com/data/preview-files/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"












Update a model with data given in the request body.

PUT /data/working-files/{instance_id}

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

Path parameters

  • instance_id Required

Responses

  • 200

    Model updated

  • 400

    Error

PUT /data/working-files/{instance_id}
curl \
 --request PUT 'http://api.example.com/data/working-files/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

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

DELETE /data/working-files/{instance_id}

Path parameters

  • instance_id Required

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

DELETE /data/working-files/{instance_id}
curl \
 --request DELETE 'http://api.example.com/data/working-files/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"
















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

DELETE /data/attachment-files/{instance_id}

Path parameters

  • instance_id Required

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

DELETE /data/attachment-files/{instance_id}
curl \
 --request DELETE 'http://api.example.com/data/attachment-files/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"












Update a model with data given in the request body.

PUT /data/comments/{instance_id}

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

Path parameters

  • instance_id Required

Responses

  • 200

    Model updated

  • 400

    Error

PUT /data/comments/{instance_id}
curl \
 --request PUT 'http://api.example.com/data/comments/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"




















Retrieve all entries for given model.

GET /data/day-offs/

Filters can be specified in the query string.

Responses

  • 200

    All entries for given model

  • 400

    Format error

  • 403

    Permission denied

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
































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

DELETE /data/custom-actions/{instance_id}

Path parameters

  • instance_id Required

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/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"
































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

DELETE /data/asset-instances/{instance_id}

Path parameters

  • instance_id Required

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

DELETE /data/asset-instances/{instance_id}
curl \
 --request DELETE 'http://api.example.com/data/asset-instances/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"








































Retrieve all entries for given model.

GET /data/notifications/

Filters can be specified in the query string.

Responses

  • 200

    All entries for given model

  • 400

    Format error

  • 403

    Permission denied

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








































































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

DELETE /data/schedule-items/{instance_id}

Path parameters

  • instance_id Required

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/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"












































Create a model with data given in the request body.

POST /data/metadata-descriptors/

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

Responses

  • 200

    Model created

  • 400

    Error

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




































































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

DELETE /data/chats/{instance_id}

Path parameters

  • instance_id Required

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

DELETE /data/chats/{instance_id}
curl \
 --request DELETE 'http://api.example.com/data/chats/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"
























































































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

DELETE /data/plugins/{instance_id}

Path parameters

  • instance_id Required

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

DELETE /data/plugins/{instance_id}
curl \
 --request DELETE 'http://api.example.com/data/plugins/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"




Create a model with data given in the request body.

POST /data/plugins

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

Responses

  • 200

    Model created

  • 400

    Error

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

























































Get all hardware items for all departments.

GET /data/departments/hardware-items

Responses

  • 200

    A dictionary of departments with their hardware items

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












Edits

Retrieve all edit entries.

GET /data/edits

Filters can be specified in the query string.

Query parameters

  • project_id
  • name
  • force

Responses

  • 200

    All edit entries

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




Retrieve all edits, adds project name and all related tasks.

GET /data/edits/with-tasks

Query parameters

  • project_id
  • name
  • force

Responses

  • 200

    All edits and all related tasks.

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
































Retrieve all edits related to a given project.

GET /data/projects/{project_id}/edits

Path parameters

  • project_id Required

Responses

  • 200

    All edits related to given project

GET /data/projects/{project_id}/edits
curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/edits' \
 --header "Authorization: $API_KEY"







































































Files










































































































Import shotgun resource.

POST /import/shotgun/persons

Responses

  • 200

    Resource imported

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
















































Serialize shotgun error resource.

POST /import/shotgun/errors

Responses

  • 200

    Resource serialized

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
















































Import remove instance.

POST /import/shotgun/remove/task

Responses

  • 204

    Instance removed

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








Import persons via a .csv file.

POST /import/csv/persons

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"

Import project assets via a .csv file.

POST /import/csv/projects/{project_id}/assets

Path parameters

  • project_id Required

Responses

  • 201

    The lists of imported assets.

  • 400

    The .csv file is not properly formatted.

POST /import/csv/projects/{project_id}/assets
curl \
 --request POST 'http://api.example.com/import/csv/projects/a24a6ea4-ce75-4665-a070-57453082c25/assets' \
 --header "Authorization: $API_KEY"




























Import Kitsu resource.

POST /import/kitsu/comments

Responses

  • 200

    Resource imported

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
















Index