Kitsu API
0.15.4

Welcome to the Kitsu API specification

Version: 0.15.4

The Kitsu API allows to store and manage the data of your animation/VFX production. Through it you can link all the tools of your pipeline and make sure they are all synchronized.

An easy to use Python client to access this API is available:
Python Kitsu Client documentation

Authentication

Before you can use any of the endpoints outline below,
you will have to get a JWT token to authorize your requests.

You can get a authorization token using a (form-encoded) POST request to /auth/login.
With curl this would look something like curl -X POST <server_address>/auth/login -d "email=<youremail>&password=<yourpassword>.

The response is a JSON object, specifically you'll need to provide the access_token for your future requests.

Here is a complete authentication process as an example (again using curl):

$ curl -X POST <server_address>/api/auth/login -d "email=<youremail>&password=<yourpassword>"'
{"login": true", "access_token": "eyJ0e...", ...}
$ jwt=eyJ0e...  # Store the access token for easier use
$ curl -H "Authorization: Bearer $jwt" <server_address>/api/data/projects
[{...},
{...}]

OpenAPI definition

This is the documentation for version 0.15.4 of the API. Last update on Sep 14, 2022.

This API is provided under license AGPL 3.0.

Base URL
http://localhost:8080/api

Authentication

Jwt authorization (http_api_key)

Send an authentication token in the Authorization header to authenticate with the API.


Returns information if the user is authenticated else it returns a 401 response.

GET /auth/authenticated

It can be used by third party tools, especially browser frontend, to know if current user is still logged in.

Responses

  • 200

    User authenticated

  • 401

    Person not found

GET /auth/authenticated
curl \
 -X GET http://localhost:8080/api/auth/authenticated \
 -H "Authorization: $API_KEY"

Allow the user to change his password.

POST /auth/change-password

Prior to modifying the password, it requires to give the current password (to make sure the user changing the password is not someone who stealed the session). The new password requires a confirmation to ensure that the user didn't make a mistake by typing his new password.

Responses

  • 200

    Password changed

  • 400

    Invalid password or inactive user

POST /auth/change-password
curl \
 -X POST http://localhost:8080/api/auth/change-password \
 -H "Authorization: $API_KEY"

Log in user by creating and registering auth tokens.

POST /auth/login

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.

Responses

  • 200

    Login successful

  • 400

    Login failed

  • 500

    Database not reachable

POST /auth/login
curl \
 -X POST http://localhost:8080/api/auth/login \
 -H "Authorization: $API_KEY"

Log user out by revoking his auth tokens.

GET /auth/logout

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

Responses

  • 200

    Logout successful

  • 500

    Access token not found

GET /auth/logout
curl \
 -X GET http://localhost:8080/api/auth/logout \
 -H "Authorization: $API_KEY"

Tokens are considered as outdated every two weeks.

GET /auth/refresh-token

This route allows to make their lifetime long before they get outdated.

Responses

GET /auth/refresh-token
curl \
 -X GET http://localhost:8080/api/auth/refresh-token \
 -H "Authorization: $API_KEY"

Responses

  • 201

    Registration successful

  • 400

    Invalid password or email

POST /auth/register
curl \
 -X POST http://localhost:8080/api/auth/register \
 -H "Authorization: $API_KEY"

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

PUT /auth/reset-password

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

Responses

  • 200

    Password reset

  • 400

    Invalid password Wrong or expired token Inactive user

PUT /auth/reset-password
curl \
 -X PUT http://localhost:8080/api/auth/reset-password \
 -H "Authorization: $API_KEY"

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

POST /auth/reset-password

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 \
 -X POST http://localhost:8080/api/auth/reset-password \
 -H "Authorization: $API_KEY"

GET /data/asset-types
curl \
 -X GET http://localhost:8080/api/data/asset-types \
 -H "Authorization: $API_KEY"

Retrieve given asset type.

GET /data/asset-types/{asset_type_id}

Responses

  • 200

    Given asset type

GET /data/asset-types/{asset_type_id}
curl \
 -X GET http://localhost:8080/api/data/asset-types/{asset_type_id} \
 -H "Authorization: $API_KEY"

Retrieve all entities that are not shot or sequence.

GET /data/assets

Adds project name and asset type name.

Responses

GET /data/assets
curl \
 -X GET http://localhost:8080/api/data/assets \
 -H "Authorization: $API_KEY"

Retrieve all entities that are not shot or sequence.

GET /data/assets/all

Adds project name and asset type name.

Responses

GET /data/assets/all
curl \
 -X GET http://localhost:8080/api/data/assets/all \
 -H "Authorization: $API_KEY"

Retrieve all entities that are not shot or sequence.

GET /data/assets/with-tasks

Adds project name and asset type name and all related tasks. If episode_id is given as parameter, it returns assets not linked to an episode and assets linked to given episode.

Responses

  • 200

    All assets with tasks

GET /data/assets/with-tasks
curl \
 -X GET http://localhost:8080/api/data/assets/with-tasks \
 -H "Authorization: $API_KEY"

Retrieve given asset.

GET /data/assets/{asset_id}

Path parameters

Responses

GET /data/assets/{asset_id}
curl \
 -X GET http://localhost:8080/api/data/assets/{asset_id} \
 -H "Authorization: $API_KEY"

Delete given asset.

DELETE /data/assets/{asset_id}

Path parameters

Responses

  • 204

    Given asset deleted

DELETE /data/assets/{asset_id}
curl \
 -X DELETE http://localhost:8080/api/data/assets/{asset_id} \
 -H "Authorization: $API_KEY"

Retrieve all asset instances instantiated inside this asset.

GET /data/assets/{asset_id}/asset-asset-instances

Path parameters

Responses

  • 200

    All asset instances instantiated inside given asset

GET /data/assets/{asset_id}/asset-asset-instances
curl \
 -X GET http://localhost:8080/api/data/assets/{asset_id}/asset-asset-instances \
 -H "Authorization: $API_KEY"

Create an asset instance inside given asset.

POST /data/assets/{asset_id}/asset-asset-instances

Path parameters

Responses

  • 201

    Asset instance created inside given asset

POST /data/assets/{asset_id}/asset-asset-instances
curl \
 -X POST http://localhost:8080/api/data/assets/{asset_id}/asset-asset-instances \
 -H "Authorization: $API_KEY"

Retrieve all assets for a given asset.

GET /data/assets/{asset_id}/assets

Path parameters

Responses

  • 200

    All assets for a given asset

GET /data/assets/{asset_id}/assets
curl \
 -X GET http://localhost:8080/api/data/assets/{asset_id}/assets \
 -H "Authorization: $API_KEY"

Resource to retrieve the casting of a given asset.

GET /data/assets/{asset_id}/cast-in

Path parameters

Responses

  • 200

    Casting of given asset

GET /data/assets/{asset_id}/cast-in
curl \
 -X GET http://localhost:8080/api/data/assets/{asset_id}/cast-in \
 -H "Authorization: $API_KEY"

Resource to retrieve the casting of a given asset.

GET /data/assets/{asset_id}/casting

Path parameters

Responses

  • 200

    Casting of given asset

GET /data/assets/{asset_id}/casting
curl \
 -X GET http://localhost:8080/api/data/assets/{asset_id}/casting \
 -H "Authorization: $API_KEY"

Path parameters

Responses

  • 200

    Modification of assets linked to given asset

PUT /data/assets/{asset_id}/casting
curl \
 -X PUT http://localhost:8080/api/data/assets/{asset_id}/casting \
 -H "Authorization: $API_KEY"

Retrieve all scene asset instances linked to asset.

GET /data/assets/{asset_id}/scene-asset-instances

Path parameters

Responses

  • 200

    All scene asset instances linked to asset

GET /data/assets/{asset_id}/scene-asset-instances
curl \
 -X GET http://localhost:8080/api/data/assets/{asset_id}/scene-asset-instances \
 -H "Authorization: $API_KEY"

Retrieve all shot asset instances linked to asset.

GET /data/assets/{asset_id}/shot-asset-instances

Path parameters

Responses

  • 200

    All shot asset instances linked to asset

GET /data/assets/{asset_id}/shot-asset-instances
curl \
 -X GET http://localhost:8080/api/data/assets/{asset_id}/shot-asset-instances \
 -H "Authorization: $API_KEY"

Retrieve all task types related to a given asset.

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

Path parameters

Responses

  • 200

    All task types related to given asset

GET /data/assets/{asset_id}/task-types
curl \
 -X GET http://localhost:8080/api/data/assets/{asset_id}/task-types \
 -H "Authorization: $API_KEY"

Retrieve all tasks related to a given shot.

GET /data/assets/{asset_id}/tasks

Path parameters

Responses

  • 200

    All tasks related to given shot

GET /data/assets/{asset_id}/tasks
curl \
 -X GET http://localhost:8080/api/data/assets/{asset_id}/tasks \
 -H "Authorization: $API_KEY"

Retrieve all asset types for given project.

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

Path parameters

Responses

  • 200

    All asset types for given project

GET /data/projects/{project_id}/asset-types
curl \
 -X GET http://localhost:8080/api/data/projects/{project_id}/asset-types \
 -H "Authorization: $API_KEY"

Retrieve all assets for given project and entity type.

GET /data/projects/{project_id}/asset-types/{asset_type_id}/assets

Path parameters

Responses

  • 200

    All assets for given project and entity type

GET /data/projects/{project_id}/asset-types/{asset_type_id}/assets
curl \
 -X GET http://localhost:8080/api/data/projects/{project_id}/asset-types/{asset_type_id}/assets \
 -H "Authorization: $API_KEY"

Create new asset resource.

POST /data/projects/{project_id}/asset-types/{asset_type_id}/assets/new

Path parameters

Body

Name, description, data and ID of asset

Responses

  • 201

    New asset resource created

POST /data/projects/{project_id}/asset-types/{asset_type_id}/assets/new
curl \
 -X POST http://localhost:8080/api/data/projects/{project_id}/asset-types/{asset_type_id}/assets/new \
 -H "Authorization: $API_KEY" \
 -d '{"data":"string","description":"string","name":"string","source_id":"a24a6ea4-ce75-4665-a070-57453082c25"}'
Request example
{
  "data": "string",
  "description": "string",
  "name": "string",
  "source_id": "a24a6ea4-ce75-4665-a070-57453082c25"
}

Retrieve all assets for given project.

GET /data/projects/{project_id}/assets

Path parameters

Responses

  • 200

    All assets for given project

GET /data/projects/{project_id}/assets
curl \
 -X GET http://localhost:8080/api/data/projects/{project_id}/assets \
 -H "Authorization: $API_KEY"

Retrieve all asset shots for given shot.

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

Path parameters

Responses

  • 200

    All asset shots for given shot

GET /data/shots/{shot_id}/asset-types
curl \
 -X GET http://localhost:8080/api/data/shots/{shot_id}/asset-types \
 -H "Authorization: $API_KEY"

Resource to retrieve the casting of assets from given asset type.

GET /data/projects/{project_id}/asset-types/{asset_type_id}/casting

Path parameters

Responses

  • 200

    Casting of assets from given asset type

GET /data/projects/{project_id}/asset-types/{asset_type_id}/casting
curl \
 -X GET http://localhost:8080/api/data/projects/{project_id}/asset-types/{asset_type_id}/casting \
 -H "Authorization: $API_KEY"

Resource to retrieve the casting of a given entity.

GET /data/projects/{project_id}/entities/{entity_id}/casting

Path parameters

Responses

  • 200

    Casting of given entity

GET /data/projects/{project_id}/entities/{entity_id}/casting
curl \
 -X GET http://localhost:8080/api/data/projects/{project_id}/entities/{entity_id}/casting \
 -H "Authorization: $API_KEY"

Resource to allow the modification of assets linked to an entity.

PUT /data/projects/{project_id}/entities/{entity_id}/casting

Path parameters

Responses

  • 200

    Modification of assets linked to an entity

PUT /data/projects/{project_id}/entities/{entity_id}/casting
curl \
 -X PUT http://localhost:8080/api/data/projects/{project_id}/entities/{entity_id}/casting \
 -H "Authorization: $API_KEY"

Resource to retrieve the casting of episodes.

GET /data/projects/{project_id}/episodes/casting

Path parameters

Responses

  • 200

    Casting of episodes

GET /data/projects/{project_id}/episodes/casting
curl \
 -X GET http://localhost:8080/api/data/projects/{project_id}/episodes/casting \
 -H "Authorization: $API_KEY"

Resource to retrieve the casting of shots from given sequence.

GET /data/projects/{project_id}/sequences/{sequence_id}/casting

Path parameters

Responses

  • 200

    Casting of shots from given sequence

GET /data/projects/{project_id}/sequences/{sequence_id}/casting
curl \
 -X GET http://localhost:8080/api/data/projects/{project_id}/sequences/{sequence_id}/casting \
 -H "Authorization: $API_KEY"

Retrieve all asset instances linked to scene.

GET /data/scenes/{scene_id}/asset-instances

Path parameters

Responses

  • 200

    All asset instances linked to given scene

GET /data/scenes/{scene_id}/asset-instances
curl \
 -X GET http://localhost:8080/api/data/scenes/{scene_id}/asset-instances \
 -H "Authorization: $API_KEY"

Create an asset instance on given scene.

POST /data/scenes/{scene_id}/asset-instances

Path parameters

Responses

  • 201

    Asset instances created on given scene

POST /data/scenes/{scene_id}/asset-instances
curl \
 -X POST http://localhost:8080/api/data/scenes/{scene_id}/asset-instances \
 -H "Authorization: $API_KEY"

Retrieve all camera instances linked to scene.

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

Path parameters

Responses

  • 201

    All camera instances linked to scene

GET /data/scenes/{scene_id}/camera-instances
curl \
 -X GET http://localhost:8080/api/data/scenes/{scene_id}/camera-instances \
 -H "Authorization: $API_KEY"

Retrieve all asset instances linked to shot.

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

Path parameters

Responses

  • 200

    All assets linked to shot

GET /data/shots/{shot_id}/asset-instances
curl \
 -X GET http://localhost:8080/api/data/shots/{shot_id}/asset-instances \
 -H "Authorization: $API_KEY"

Add an asset instance to given shot.

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

Path parameters

Responses

  • 201

    Asset instance added to given shot

POST /data/shots/{shot_id}/asset-instances
curl \
 -X POST http://localhost:8080/api/data/shots/{shot_id}/asset-instances \
 -H "Authorization: $API_KEY"

Remove an asset instance from given shot.

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

Path parameters

Responses

  • 204

    Asset instance removed from given shot

DELETE /data/shots/{shot_id}/asset-instances/{asset_instance_id}
curl \
 -X DELETE http://localhost:8080/api/data/shots/{shot_id}/asset-instances/{asset_instance_id} \
 -H "Authorization: $API_KEY"

Create several comments at once.

POST /actions/projects/{project_id}/tasks/comment-many

Each comment requires a text, a task id, 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

Body

person ID, name, comment, revision and change status of task

Responses

  • 201

    Given files added to the comment entry as attachments

POST /actions/projects/{project_id}/tasks/comment-many
curl \
 -X POST http://localhost:8080/api/actions/projects/{project_id}/tasks/comment-many \
 -H "Authorization: $API_KEY" \
 -d '{"checklist":{"item 1":"string"},"comment":"string","created_at":"2022-07-12T13:00:00","object_id":"a24a6ea4-ce75-4665-a070-57453082c25a4-ce75-4665-a070-57453082c25","person_id":"a24a6ea4-ce75-4665-a070-57453082c25a4-ce75-4665-a070-57453082c25","task_status_id":"a24a6ea4-ce75-4665-a070-57453082c25a4-ce75-4665-a070-57453082c25"}'
Request example
{
  "checklist": {
    "item 1": "string"
  },
  "comment": "string",
  "created_at": "2022-07-12T13:00:00",
  "object_id": "a24a6ea4-ce75-4665-a070-57453082c25a4-ce75-4665-a070-57453082c25",
  "person_id": "a24a6ea4-ce75-4665-a070-57453082c25a4-ce75-4665-a070-57453082c25",
  "task_status_id": "a24a6ea4-ce75-4665-a070-57453082c25a4-ce75-4665-a070-57453082c25"
}

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

Body

person ID, name, comment, revision and change status of task

Responses

  • 201

    New comment created

POST /actions/tasks/{task_id}/comment
curl \
 -X POST http://localhost:8080/api/actions/tasks/{task_id}/comment \
 -H "Authorization: $API_KEY" \
 -d '{"checklist":{"item 1":"string"},"comment":"string","created_at":"2022-07-12T13:00:00","person_id":"a24a6ea4-ce75-4665-a070-57453082c25a4-ce75-4665-a070-57453082c25","task_status_id":"a24a6ea4-ce75-4665-a070-57453082c25a4-ce75-4665-a070-57453082c25"}'
Request example
{
  "checklist": {
    "item 1": "string"
  },
  "comment": "string",
  "created_at": "2022-07-12T13:00:00",
  "person_id": "a24a6ea4-ce75-4665-a070-57453082c25a4-ce75-4665-a070-57453082c25",
  "task_status_id": "a24a6ea4-ce75-4665-a070-57453082c25a4-ce75-4665-a070-57453082c25"
}

Add given files to the comment entry as attachments.

POST /actions/tasks/{task_id}/comments/{comment_id}/add-attachment

Path parameters

Responses

  • 201

    Given files added to the comment entry as attachments

POST /actions/tasks/{task_id}/comments/{comment_id}/add-attachment
curl \
 -X POST http://localhost:8080/api/actions/tasks/{task_id}/comments/{comment_id}/add-attachment \
 -H "Authorization: $API_KEY"

Download attachment file.

GET /data/attachment-files/{attachment_file_id}/file/{file_name}

Path parameters

Responses

  • 200 file

    Attachment file downloaded

  • 404

    Download failed

GET /data/attachment-files/{attachment_file_id}/file/{file_name}
curl \
 -X GET http://localhost:8080/api/data/attachment-files/{attachment_file_id}/file/{file_name} \
 -H "Authorization: $API_KEY"
Response example (200)
"string"

Return all attachment files related to given project.

GET /data/projects/{project_id}/attachment-files

Path parameters

Responses

  • 200

    All attachment files related to given project

GET /data/projects/{project_id}/attachment-files
curl \
 -X GET http://localhost:8080/api/data/projects/{project_id}/attachment-files \
 -H "Authorization: $API_KEY"

Return all attachment files related to given task.

GET /data/tasks/{task_id}/attachment-files

Path parameters

Responses

  • 200

    All attachment files related to given task

GET /data/tasks/{task_id}/attachment-files
curl \
 -X GET http://localhost:8080/api/data/tasks/{task_id}/attachment-files \
 -H "Authorization: $API_KEY"

Acknowledge given comment.

POST /data/tasks/{task_id}/comments/{comment_id}/ack

If it's already acknowledged, remove acknowledgement.

Path parameters

Responses

  • 200

    Comment acknowledged

POST /data/tasks/{task_id}/comments/{comment_id}/ack
curl \
 -X POST http://localhost:8080/api/data/tasks/{task_id}/comments/{comment_id}/ack \
 -H "Authorization: $API_KEY"

Delete attachment linked to a comment matching given ID.

DELETE /data/tasks/{task_id}/comments/{comment_id}/attachments/{attachment_id}

Path parameters

Responses

DELETE /data/tasks/{task_id}/comments/{comment_id}/attachments/{attachment_id}
curl \
 -X DELETE http://localhost:8080/api/data/tasks/{task_id}/comments/{comment_id}/attachments/{attachment_id} \
 -H "Authorization: $API_KEY"

Reply to given comment.

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

Add comment to its replies list.

Path parameters

Responses

  • 200

    Reply to given comment

POST /data/tasks/{task_id}/comments/{comment_id}/reply
curl \
 -X POST http://localhost:8080/api/data/tasks/{task_id}/comments/{comment_id}/reply \
 -H "Authorization: $API_KEY"

Delete given comment reply.

DELETE /data/tasks/{task_id}/comments/{comment_id}/reply/{reply_id}

Path parameters

Responses

  • 200

    Given comment reply deleted

DELETE /data/tasks/{task_id}/comments/{comment_id}/reply/{reply_id}
curl \
 -X DELETE http://localhost:8080/api/data/tasks/{task_id}/comments/{comment_id}/reply/{reply_id} \
 -H "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/asset-instances/

Filters can be specified in the query string.

Responses

  • 200

    All entries for given model

  • 400

    Format error

  • 403

    Permission denied

GET /data/asset-instances/
curl \
 -X GET http://localhost:8080/api/data/asset-instances/ \
 -H "Authorization: $API_KEY"

Create a model with data given in the request body.

POST /data/asset-instances/

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

Body

Responses

POST /data/asset-instances/
curl \
 -X POST http://localhost:8080/api/data/asset-instances/ \
 -H "Authorization: $API_KEY" \
 -d '{"data":["string"],"limit":42,"nb_pages":42,"offset":42,"page":42,"total":42}'
Request example
{
  "data": [
    "string"
  ],
  "limit": 42,
  "nb_pages": 42,
  "offset": 42,
  "page": 42,
  "total": 42
}

Path parameters

Responses

  • 200

    Model as a JSON object

  • 400

    Statement error

  • 404

    Value error

GET /data/asset-instances/{instance_id}
curl \
 -X GET http://localhost:8080/api/data/asset-instances/{instance_id} \
 -H "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/asset-instances/{instance_id}

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

Path parameters

Body

Responses

PUT /data/asset-instances/{instance_id}
curl \
 -X PUT http://localhost:8080/api/data/asset-instances/{instance_id} \
 -H "Authorization: $API_KEY" \
 -d '{"data":["string"],"limit":42,"nb_pages":42,"offset":42,"page":42,"total":42}'
Request example
{
  "data": [
    "string"
  ],
  "limit": 42,
  "nb_pages": 42,
  "offset": 42,
  "page": 42,
  "total": 42
}

Path parameters

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

DELETE /data/asset-instances/{instance_id}
curl \
 -X DELETE http://localhost:8080/api/data/asset-instances/{instance_id} \
 -H "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/attachment-files

Filters can be specified in the query string.

Responses

  • 200

    All entries for given model

  • 400

    Format error

  • 403

    Permission denied

GET /data/attachment-files
curl \
 -X GET http://localhost:8080/api/data/attachment-files \
 -H "Authorization: $API_KEY"

Create a model with data given in the request body.

POST /data/attachment-files

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

Body

Responses

POST /data/attachment-files
curl \
 -X POST http://localhost:8080/api/data/attachment-files \
 -H "Authorization: $API_KEY" \
 -d '{"data":["string"],"limit":42,"nb_pages":42,"offset":42,"page":42,"total":42}'
Request example
{
  "data": [
    "string"
  ],
  "limit": 42,
  "nb_pages": 42,
  "offset": 42,
  "page": 42,
  "total": 42
}

Path parameters

Responses

  • 200

    Model as a JSON object

  • 400

    Statement error

  • 404

    Value error

GET /data/attachment-files/{instance_id}
curl \
 -X GET http://localhost:8080/api/data/attachment-files/{instance_id} \
 -H "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/attachment-files/{instance_id}

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

Path parameters

Body

Responses

PUT /data/attachment-files/{instance_id}
curl \
 -X PUT http://localhost:8080/api/data/attachment-files/{instance_id} \
 -H "Authorization: $API_KEY" \
 -d '{"data":["string"],"limit":42,"nb_pages":42,"offset":42,"page":42,"total":42}'
Request example
{
  "data": [
    "string"
  ],
  "limit": 42,
  "nb_pages": 42,
  "offset": 42,
  "page": 42,
  "total": 42
}

Path parameters

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

DELETE /data/attachment-files/{instance_id}
curl \
 -X DELETE http://localhost:8080/api/data/attachment-files/{instance_id} \
 -H "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/comments

Filters can be specified in the query string.

Responses

  • 200

    All entries for given model

  • 400

    Format error

  • 403

    Permission denied

GET /data/comments
curl \
 -X GET http://localhost:8080/api/data/comments \
 -H "Authorization: $API_KEY"

Create a model with data given in the request body.

POST /data/comments

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

Body

Responses

POST /data/comments
curl \
 -X POST http://localhost:8080/api/data/comments \
 -H "Authorization: $API_KEY" \
 -d '{"data":["string"],"limit":42,"nb_pages":42,"offset":42,"page":42,"total":42}'
Request example
{
  "data": [
    "string"
  ],
  "limit": 42,
  "nb_pages": 42,
  "offset": 42,
  "page": 42,
  "total": 42
}

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

Body

Responses

PUT /data/comments/{instance_id}
curl \
 -X PUT http://localhost:8080/api/data/comments/{instance_id} \
 -H "Authorization: $API_KEY" \
 -d '{"data":["string"],"limit":42,"nb_pages":42,"offset":42,"page":42,"total":42}'
Request example
{
  "data": [
    "string"
  ],
  "limit": 42,
  "nb_pages": 42,
  "offset": 42,
  "page": 42,
  "total": 42
}

Retrieve all entries for given model.

GET /data/custom-actions/

Filters can be specified in the query string.

Responses

  • 200

    All entries for given model

  • 400

    Format error

  • 403

    Permission denied

GET /data/custom-actions/
curl \
 -X GET http://localhost:8080/api/data/custom-actions/ \
 -H "Authorization: $API_KEY"

Create a model with data given in the request body.

POST /data/custom-actions/

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

Body

Responses

POST /data/custom-actions/
curl \
 -X POST http://localhost:8080/api/data/custom-actions/ \
 -H "Authorization: $API_KEY" \
 -d '{"data":["string"],"limit":42,"nb_pages":42,"offset":42,"page":42,"total":42}'
Request example
{
  "data": [
    "string"
  ],
  "limit": 42,
  "nb_pages": 42,
  "offset": 42,
  "page": 42,
  "total": 42
}

Path parameters

Responses

  • 200

    Model as a JSON object

  • 400

    Statement error

  • 404

    Value error

GET /data/custom-actions/{instance_id}
curl \
 -X GET http://localhost:8080/api/data/custom-actions/{instance_id} \
 -H "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/custom-actions/{instance_id}

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

Path parameters

Body

Responses

PUT /data/custom-actions/{instance_id}
curl \
 -X PUT http://localhost:8080/api/data/custom-actions/{instance_id} \
 -H "Authorization: $API_KEY" \
 -d '{"data":["string"],"limit":42,"nb_pages":42,"offset":42,"page":42,"total":42}'
Request example
{
  "data": [
    "string"
  ],
  "limit": 42,
  "nb_pages": 42,
  "offset": 42,
  "page": 42,
  "total": 42
}

Path parameters

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

DELETE /data/custom-actions/{instance_id}
curl \
 -X DELETE http://localhost:8080/api/data/custom-actions/{instance_id} \
 -H "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 \
 -X GET http://localhost:8080/api/data/day-offs/ \
 -H "Authorization: $API_KEY"

Create a model with data given in the request body.

POST /data/day-offs/

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

Body

Responses

POST /data/day-offs/
curl \
 -X POST http://localhost:8080/api/data/day-offs/ \
 -H "Authorization: $API_KEY" \
 -d '{"data":["string"],"limit":42,"nb_pages":42,"offset":42,"page":42,"total":42}'
Request example
{
  "data": [
    "string"
  ],
  "limit": 42,
  "nb_pages": 42,
  "offset": 42,
  "page": 42,
  "total": 42
}

Path parameters

Responses

  • 200

    Model as a JSON object

  • 400

    Statement error

  • 404

    Value error

GET /data/day-offs/{instance_id}
curl \
 -X GET http://localhost:8080/api/data/day-offs/{instance_id} \
 -H "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/day-offs/{instance_id}

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

Path parameters

Body

Responses

PUT /data/day-offs/{instance_id}
curl \
 -X PUT http://localhost:8080/api/data/day-offs/{instance_id} \
 -H "Authorization: $API_KEY" \
 -d '{"data":["string"],"limit":42,"nb_pages":42,"offset":42,"page":42,"total":42}'
Request example
{
  "data": [
    "string"
  ],
  "limit": 42,
  "nb_pages": 42,
  "offset": 42,
  "page": 42,
  "total": 42
}