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
[{...},
{...}]
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.
http://localhost:8080/api
Returns information if the user is authenticated else it returns a 401 response.
It can be used by third party tools, especially browser frontend, to know if current user is still logged in.
curl \
-X GET http://localhost:8080/api/auth/authenticated \
-H "Authorization: $API_KEY"
Allow the user to change his 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.
curl \
-X POST http://localhost:8080/api/auth/change-password \
-H "Authorization: $API_KEY"
Log in user by creating and registering auth tokens.
Login is based on email and password. If no user match given email and a destkop ID, it looks in matching the desktop ID with the one stored in database. It is useful for clients that run on desktop tools and that don't know user email.
curl \
-X POST http://localhost:8080/api/auth/login \
-H "Authorization: $API_KEY"
Log user out by revoking his auth tokens.
Once logged out, current user cannot access the API anymore.
curl \
-X GET http://localhost:8080/api/auth/logout \
-H "Authorization: $API_KEY"
Tokens are considered as outdated every two weeks.
This route allows to make their lifetime long before they get outdated.
curl \
-X GET http://localhost:8080/api/auth/refresh-token \
-H "Authorization: $API_KEY"
Allow a user to register himself to the service.
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.
It uses a classic scheme: a token is sent by email to the user. Then he can change his 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.
It uses a classic scheme: a token is sent by email to the user. Then he can change his password.
curl \
-X POST http://localhost:8080/api/auth/reset-password \
-H "Authorization: $API_KEY"
Retrieve all asset types (entity types that are not shot, sequence or episode).
curl \
-X GET http://localhost:8080/api/data/asset-types \
-H "Authorization: $API_KEY"
Retrieve given asset type.
Path parameters
-
asset_type_id string(UUID) Required
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.
Adds project name and asset type name.
curl \
-X GET http://localhost:8080/api/data/assets \
-H "Authorization: $API_KEY"
Retrieve all entities that are not shot or sequence.
Adds project name and asset type name.
curl \
-X GET http://localhost:8080/api/data/assets/all \
-H "Authorization: $API_KEY"
Retrieve all entities that are not shot or sequence.
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.
curl \
-X GET http://localhost:8080/api/data/assets/with-tasks \
-H "Authorization: $API_KEY"
Retrieve given asset.
Path parameters
-
asset_id string(UUID) Required
curl \
-X GET http://localhost:8080/api/data/assets/{asset_id} \
-H "Authorization: $API_KEY"
Delete given asset.
Path parameters
-
asset_id string(UUID) Required
curl \
-X DELETE http://localhost:8080/api/data/assets/{asset_id} \
-H "Authorization: $API_KEY"
Retrieve all asset instances instantiated inside this asset.
Path parameters
-
asset_id string(UUID) Required
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.
Path parameters
-
asset_id string(UUID) Required
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.
Path parameters
-
asset_id string(UUID) Required
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.
Path parameters
-
asset_id string(UUID) Required
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.
Path parameters
-
asset_id string(UUID) Required
curl \
-X GET http://localhost:8080/api/data/assets/{asset_id}/casting \
-H "Authorization: $API_KEY"
Resource to allow the modification of assets linked to a asset.
Path parameters
-
asset_id string(UUID) Required
curl \
-X PUT http://localhost:8080/api/data/assets/{asset_id}/casting \
-H "Authorization: $API_KEY"
Retrieve all scene asset instances linked to asset.
Path parameters
-
asset_id string(UUID) Required
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.
Path parameters
-
asset_id string(UUID) Required
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.
Path parameters
-
asset_id string(UUID) Required
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.
Path parameters
-
asset_id string(UUID) Required
curl \
-X GET http://localhost:8080/api/data/assets/{asset_id}/tasks \
-H "Authorization: $API_KEY"
Retrieve all asset types for given project.
Path parameters
-
project_id string(UUID) Required
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.
Path parameters
-
project_id string(UUID) Required
-
asset_type_id string(UUID) Required
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.
Path parameters
-
project_id string(UUID) Required
-
asset_type_id string(UUID) Required
Body
Name, description, data and ID of asset
-
data string Required
-
description string Required
-
name string Required
-
source_id string(UUID) Required
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"}'
{
"data": "string",
"description": "string",
"name": "string",
"source_id": "a24a6ea4-ce75-4665-a070-57453082c25"
}
Retrieve all assets for given project.
Path parameters
-
project_id string(UUID) Required
curl \
-X GET http://localhost:8080/api/data/projects/{project_id}/assets \
-H "Authorization: $API_KEY"
Retrieve all asset shots for given shot.
Path parameters
-
shot_id string(UUID) Required
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.
Path parameters
-
project_id string(UUID) Required
-
asset_type_id string(UUID) Required
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.
Path parameters
-
project_id string(UUID) Required
-
entity_id string(UUID) Required
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.
Path parameters
-
project_id string(UUID) Required
-
entity_id string(UUID) Required
curl \
-X PUT http://localhost:8080/api/data/projects/{project_id}/entities/{entity_id}/casting \
-H "Authorization: $API_KEY"
Retrieve all entity links related to given project.
It's mainly used for synchronisation purpose.
Path parameters
-
project_id string(UUID) Required
curl \
-X GET http://localhost:8080/api/data/projects/{project_id}/entity-links \
-H "Authorization: $API_KEY"
Delete given entity link.
It's mainly used for synchronisation purpose.
Path parameters
-
project_id string(UUID) Required
-
entity_link_id string(UUID) Required
curl \
-X DELETE http://localhost:8080/api/data/projects/{project_id}/entity-links/{entity_link_id} \
-H "Authorization: $API_KEY"
Resource to retrieve the casting of episodes.
Path parameters
-
project_id string(UUID) Required
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.
Path parameters
-
project_id string(UUID) Required
-
sequence_id string(UUID) Required
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.
Path parameters
-
scene_id string(UUID) Required
curl \
-X GET http://localhost:8080/api/data/scenes/{scene_id}/asset-instances \
-H "Authorization: $API_KEY"
Create an asset instance on given scene.
Path parameters
-
scene_id string(UUID) Required
curl \
-X POST http://localhost:8080/api/data/scenes/{scene_id}/asset-instances \
-H "Authorization: $API_KEY"
Retrieve all camera instances linked to scene.
Path parameters
-
scene_id string(UUID) Required
curl \
-X GET http://localhost:8080/api/data/scenes/{scene_id}/camera-instances \
-H "Authorization: $API_KEY"
Retrieve all asset instances linked to shot.
Path parameters
-
shot_id string(UUID) Required
curl \
-X GET http://localhost:8080/api/data/shots/{shot_id}/asset-instances \
-H "Authorization: $API_KEY"
Add an asset instance to given shot.
Path parameters
-
shot_id string(UUID) Required
curl \
-X POST http://localhost:8080/api/data/shots/{shot_id}/asset-instances \
-H "Authorization: $API_KEY"
Remove an asset instance from given shot.
Path parameters
-
shot_id string(UUID) Required
-
asset_instance_id string(UUID) Required
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.
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
-
project_id string(UUID) Required
Body
person ID, name, comment, revision and change status of task
-
checklist object
-
comment string
-
created_at string(date-time)
-
object_id string(UUID)
-
person_id string(UUID)
-
task_status_id string(UUID) Required
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"}'
{
"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.
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 string(UUID) Required
Body
person ID, name, comment, revision and change status of task
-
checklist object
-
comment string
-
created_at string(date-time)
-
person_id string(UUID)
-
task_status_id string(UUID) Required
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"}'
{
"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.
Path parameters
-
task_id string(UUID) Required
-
comment_id string(UUID) Required
curl \
-X POST http://localhost:8080/api/actions/tasks/{task_id}/comments/{comment_id}/add-attachment \
-H "Authorization: $API_KEY"
Download attachment file.
Path parameters
-
attachment_file_id string(UUID) Required
-
file_name string Required
curl \
-X GET http://localhost:8080/api/data/attachment-files/{attachment_file_id}/file/{file_name} \
-H "Authorization: $API_KEY"
"string"
Return all attachment files related to given project.
Path parameters
-
project_id string(UUID) Required
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.
Path parameters
-
task_id string(UUID) Required
curl \
-X GET http://localhost:8080/api/data/tasks/{task_id}/attachment-files \
-H "Authorization: $API_KEY"
Acknowledge given comment.
If it's already acknowledged, remove acknowledgement.
Path parameters
-
task_id string(UUID) Required
-
comment_id string(UUID) Required
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.
Path parameters
-
task_id string(UUID) Required
-
comment_id string(UUID) Required
-
attachment_id string(UUID) Required
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.
Add comment to its replies list.
Path parameters
-
task_id string(UUID) Required
-
comment_id string(UUID) Required
curl \
-X POST http://localhost:8080/api/data/tasks/{task_id}/comments/{comment_id}/reply \
-H "Authorization: $API_KEY"
Delete given comment reply.
Path parameters
-
task_id string(UUID) Required
-
comment_id string(UUID) Required
-
reply_id string(UUID) Required
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.
Filters can be specified in the query string.
curl \
-X GET http://localhost:8080/api/data/asset-instances/ \
-H "Authorization: $API_KEY"
Create a model with data given in the request body.
JSON format is expected. The model performs the validation automatically when instantiated.
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}'
{
"data": [
"string"
],
"limit": 42,
"nb_pages": 42,
"offset": 42,
"page": 42,
"total": 42
}
Retrieve a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id string(UUID) Required
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.
JSON format is expected. Model performs the validation automatically when fields are modified.
Path parameters
-
instance_id string(UUID) Required
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}'
{
"data": [
"string"
],
"limit": 42,
"nb_pages": 42,
"offset": 42,
"page": 42,
"total": 42
}
Delete a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id string(UUID) Required
curl \
-X DELETE http://localhost:8080/api/data/asset-instances/{instance_id} \
-H "Authorization: $API_KEY"
Retrieve all entries for given model.
Filters can be specified in the query string.
curl \
-X GET http://localhost:8080/api/data/attachment-files \
-H "Authorization: $API_KEY"
Create a model with data given in the request body.
JSON format is expected. The model performs the validation automatically when instantiated.
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}'
{
"data": [
"string"
],
"limit": 42,
"nb_pages": 42,
"offset": 42,
"page": 42,
"total": 42
}
Retrieve a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id string(UUID) Required
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.
JSON format is expected. Model performs the validation automatically when fields are modified.
Path parameters
-
instance_id string(UUID) Required
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}'
{
"data": [
"string"
],
"limit": 42,
"nb_pages": 42,
"offset": 42,
"page": 42,
"total": 42
}
Delete a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id string(UUID) Required
curl \
-X DELETE http://localhost:8080/api/data/attachment-files/{instance_id} \
-H "Authorization: $API_KEY"
Retrieve all entries for given model.
Filters can be specified in the query string.
curl \
-X GET http://localhost:8080/api/data/comments \
-H "Authorization: $API_KEY"
Create a model with data given in the request body.
JSON format is expected. The model performs the validation automatically when instantiated.
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}'
{
"data": [
"string"
],
"limit": 42,
"nb_pages": 42,
"offset": 42,
"page": 42,
"total": 42
}
Update a model with data given in the request body.
JSON format is expected. Model performs the validation automatically when fields are modified.
Path parameters
-
instance_id string(UUID) Required
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}'
{
"data": [
"string"
],
"limit": 42,
"nb_pages": 42,
"offset": 42,
"page": 42,
"total": 42
}
Retrieve all entries for given model.
Filters can be specified in the query string.
curl \
-X GET http://localhost:8080/api/data/custom-actions/ \
-H "Authorization: $API_KEY"
Create a model with data given in the request body.
JSON format is expected. The model performs the validation automatically when instantiated.
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}'
{
"data": [
"string"
],
"limit": 42,
"nb_pages": 42,
"offset": 42,
"page": 42,
"total": 42
}
Retrieve a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id string(UUID) Required
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.
JSON format is expected. Model performs the validation automatically when fields are modified.
Path parameters
-
instance_id string(UUID) Required
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}'
{
"data": [
"string"
],
"limit": 42,
"nb_pages": 42,
"offset": 42,
"page": 42,
"total": 42
}
Delete a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id string(UUID) Required
curl \
-X DELETE http://localhost:8080/api/data/custom-actions/{instance_id} \
-H "Authorization: $API_KEY"
Retrieve all entries for given model.
Filters can be specified in the query string.
curl \
-X GET http://localhost:8080/api/data/day-offs/ \
-H "Authorization: $API_KEY"
Create a model with data given in the request body.
JSON format is expected. The model performs the validation automatically when instantiated.
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}'
{
"data": [
"string"
],
"limit": 42,
"nb_pages": 42,
"offset": 42,
"page": 42,
"total": 42
}
Retrieve a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id string(UUID) Required
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.
JSON format is expected. Model performs the validation automatically when fields are modified.
Path parameters
-
instance_id string(UUID) Required
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}'
{
"data": [
"string"
],
"limit": 42,
"nb_pages": 42,
"offset": 42,
"page": 42,
"total": 42
}
Delete a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id string(UUID) Required
curl \
-X DELETE http://localhost:8080/api/data/day-offs/{instance_id} \
-H "Authorization: $API_KEY"
Retrieve all entries for given model.
Filters can be specified in the query string.
curl \
-X GET http://localhost:8080/api/data/departments \
-H "Authorization: $API_KEY"
Create a model with data given in the request body.
JSON format is expected. The model performs the validation automatically when instantiated.
curl \
-X POST http://localhost:8080/api/data/departments \
-H "Authorization: $API_KEY" \
-d '{"data":["string"],"limit":42,"nb_pages":42,"offset":42,"page":42,"total":42}'
{
"data": [
"string"
],
"limit": 42,
"nb_pages": 42,
"offset": 42,
"page": 42,
"total": 42
}
Retrieve a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id string(UUID) Required
curl \
-X GET http://localhost:8080/api/data/departments/{instance_id} \
-H "Authorization: $API_KEY"
Update a model with data given in the request body.
JSON format is expected. Model performs the validation automatically when fields are modified.
Path parameters
-
instance_id string(UUID) Required
curl \
-X PUT http://localhost:8080/api/data/departments/{instance_id} \
-H "Authorization: $API_KEY" \
-d '{"data":["string"],"limit":42,"nb_pages":42,"offset":42,"page":42,"total":42}'
{
"data": [
"string"
],
"limit": 42,
"nb_pages": 42,
"offset": 42,
"page": 42,
"total": 42
}
Delete a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id string(UUID) Required
curl \
-X DELETE http://localhost:8080/api/data/departments/{instance_id} \
-H "Authorization: $API_KEY"
Retrieve all entries for given model.
Filters can be specified in the query string.
curl \
-X GET http://localhost:8080/api/data/entities \
-H "Authorization: $API_KEY"
Create a model with data given in the request body.
JSON format is expected. The model performs the validation automatically when instantiated.
curl \
-X POST http://localhost:8080/api/data/entities \
-H "Authorization: $API_KEY" \
-d '{"data":["string"],"limit":42,"nb_pages":42,"offset":42,"page":42,"total":42}'
{
"data": [
"string"
],
"limit": 42,
"nb_pages": 42,
"offset": 42,
"page": 42,
"total": 42
}
Retrieve a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id string(UUID) Required
curl \
-X GET http://localhost:8080/api/data/entities/{instance_id} \
-H "Authorization: $API_KEY"
Delete a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id string(UUID) Required
curl \
-X DELETE http://localhost:8080/api/data/entities/{instance_id} \
-H "Authorization: $API_KEY"
Retrieve all entries for given model.
Filters can be specified in the query string.
curl \
-X GET http://localhost:8080/api/data/entity-links/ \
-H "Authorization: $API_KEY"
Create a model with data given in the request body.
JSON format is expected. The model performs the validation automatically when instantiated.
curl \
-X POST http://localhost:8080/api/data/entity-links/ \
-H "Authorization: $API_KEY" \
-d '{"data":["string"],"limit":42,"nb_pages":42,"offset":42,"page":42,"total":42}'
{
"data": [
"string"
],
"limit": 42,
"nb_pages": 42,
"offset": 42,
"page": 42,
"total": 42
}
Retrieve a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id string(UUID) Required
curl \
-X GET http://localhost:8080/api/data/entity-links/{instance_id} \
-H "Authorization: $API_KEY"
Update a model with data given in the request body.
JSON format is expected. Model performs the validation automatically when fields are modified.
Path parameters
-
instance_id string(UUID) Required
curl \
-X PUT http://localhost:8080/api/data/entity-links/{instance_id} \
-H "Authorization: $API_KEY" \
-d '{"data":["string"],"limit":42,"nb_pages":42,"offset":42,"page":42,"total":42}'
{
"data": [
"string"
],
"limit": 42,
"nb_pages": 42,
"offset": 42,
"page": 42,
"total": 42
}
Delete a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id string(UUID) Required
curl \
-X DELETE http://localhost:8080/api/data/entity-links/{instance_id} \
-H "Authorization: $API_KEY"
Retrieve all entries for given model.
Filters can be specified in the query string.
curl \
-X GET http://localhost:8080/api/data/entity-types \
-H "Authorization: $API_KEY"
Create a model with data given in the request body.
JSON format is expected. The model performs the validation automatically when instantiated.
curl \
-X POST http://localhost:8080/api/data/entity-types \
-H "Authorization: $API_KEY" \
-d '{"data":["string"],"limit":42,"nb_pages":42,"offset":42,"page":42,"total":42}'
{
"data": [
"string"
],
"limit": 42,
"nb_pages": 42,
"offset": 42,
"page": 42,
"total": 42
}
Retrieve a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id string(UUID) Required
curl \
-X GET http://localhost:8080/api/data/entity-types/{instance_id} \
-H "Authorization: $API_KEY"
Update a model with data given in the request body.
JSON format is expected. Model performs the validation automatically when fields are modified.
Path parameters
-
instance_id string(UUID) Required
curl \
-X PUT http://localhost:8080/api/data/entity-types/{instance_id} \
-H "Authorization: $API_KEY" \
-d '{"data":["string"],"limit":42,"nb_pages":42,"offset":42,"page":42,"total":42}'
{
"data": [
"string"
],
"limit": 42,
"nb_pages": 42,
"offset": 42,
"page": 42,
"total": 42
}
Delete a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id string(UUID) Required
curl \
-X DELETE http://localhost:8080/api/data/entity-types/{instance_id} \
-H "Authorization: $API_KEY"
Retrieve all entries for given model.
Filters can be specified in the query string.
curl \
-X GET http://localhost:8080/api/data/events/ \
-H "Authorization: $API_KEY"
Create a model with data given in the request body.
JSON format is expected. The model performs the validation automatically when instantiated.
curl \
-X POST http://localhost:8080/api/data/events/ \
-H "Authorization: $API_KEY" \
-d '{"data":["string"],"limit":42,"nb_pages":42,"offset":42,"page":42,"total":42}'
{
"data": [
"string"
],
"limit": 42,
"nb_pages": 42,
"offset": 42,
"page": 42,
"total": 42
}
Retrieve a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id string(UUID) Required
curl \
-X GET http://localhost:8080/api/data/events/{instance_id} \
-H "Authorization: $API_KEY"
Update a model with data given in the request body.
JSON format is expected. Model performs the validation automatically when fields are modified.
Path parameters
-
instance_id string(UUID) Required
curl \
-X PUT http://localhost:8080/api/data/events/{instance_id} \
-H "Authorization: $API_KEY" \
-d '{"data":["string"],"limit":42,"nb_pages":42,"offset":42,"page":42,"total":42}'
{
"data": [
"string"
],
"limit": 42,
"nb_pages": 42,
"offset": 42,
"page": 42,
"total": 42
}
Delete a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id string(UUID) Required
curl \
-X DELETE http://localhost:8080/api/data/events/{instance_id} \
-H "Authorization: $API_KEY"
Retrieve all entries for given model.
Filters can be specified in the query string.
curl \
-X GET http://localhost:8080/api/data/file-status/ \
-H "Authorization: $API_KEY"
Create a model with data given in the request body.
JSON format is expected. The model performs the validation automatically when instantiated.
curl \
-X POST http://localhost:8080/api/data/file-status/ \
-H "Authorization: $API_KEY" \
-d '{"data":["string"],"limit":42,"nb_pages":42,"offset":42,"page":42,"total":42}'
{
"data": [
"string"
],
"limit": 42,
"nb_pages": 42,
"offset": 42,
"page": 42,
"total": 42
}
Retrieve a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id string(UUID) Required
curl \
-X GET http://localhost:8080/api/data/file-status/{instance_id} \
-H "Authorization: $API_KEY"
Update a model with data given in the request body.
JSON format is expected. Model performs the validation automatically when fields are modified.
Path parameters
-
instance_id string(UUID) Required
curl \
-X PUT http://localhost:8080/api/data/file-status/{instance_id} \
-H "Authorization: $API_KEY" \
-d '{"data":["string"],"limit":42,"nb_pages":42,"offset":42,"page":42,"total":42}'
{
"data": [
"string"
],
"limit": 42,
"nb_pages": 42,
"offset": 42,
"page": 42,
"total": 42
}
Delete a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id string(UUID) Required
curl \
-X DELETE http://localhost:8080/api/data/file-status/{instance_id} \
-H "Authorization: $API_KEY"
Retrieve all entries for given model.
Filters can be specified in the query string.
curl \
-X GET http://localhost:8080/api/data/metadata-descriptors/ \
-H "Authorization: $API_KEY"
Create a model with data given in the request body.
JSON format is expected. The model performs the validation automatically when instantiated.
curl \
-X POST http://localhost:8080/api/data/metadata-descriptors/ \
-H "Authorization: $API_KEY" \
-d '{"data":["string"],"limit":42,"nb_pages":42,"offset":42,"page":42,"total":42}'
{
"data": [
"string"
],
"limit": 42,
"nb_pages": 42,
"offset": 42,
"page": 42,
"total": 42
}
Retrieve a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id string(UUID) Required
curl \
-X GET http://localhost:8080/api/data/metadata-descriptors/{instance_id} \
-H "Authorization: $API_KEY"
Update a model with data given in the request body.
JSON format is expected. Model performs the validation automatically when fields are modified.
Path parameters
-
instance_id string(UUID) Required
curl \
-X PUT http://localhost:8080/api/data/metadata-descriptors/{instance_id} \
-H "Authorization: $API_KEY" \
-d '{"data":["string"],"limit":42,"nb_pages":42,"offset":42,"page":42,"total":42}'
{
"data": [
"string"
],
"limit": 42,
"nb_pages": 42,
"offset": 42,
"page": 42,
"total": 42
}
Delete a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id string(UUID) Required
curl \
-X DELETE http://localhost:8080/api/data/metadata-descriptors/{instance_id} \
-H "Authorization: $API_KEY"
Retrieve all entries for given model.
Filters can be specified in the query string.
curl \
-X GET http://localhost:8080/api/data/milestones/ \
-H "Authorization: $API_KEY"
Create a model with data given in the request body.
JSON format is expected. The model performs the validation automatically when instantiated.
curl \
-X POST http://localhost:8080/api/data/milestones/ \
-H "Authorization: $API_KEY" \
-d '{"data":["string"],"limit":42,"nb_pages":42,"offset":42,"page":42,"total":42}'
{
"data": [
"string"
],
"limit": 42,
"nb_pages": 42,
"offset": 42,
"page": 42,
"total": 42
}
Retrieve a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id string(UUID) Required
curl \
-X GET http://localhost:8080/api/data/milestones/{instance_id} \
-H "Authorization: $API_KEY"
Update a model with data given in the request body.
JSON format is expected. Model performs the validation automatically when fields are modified.
Path parameters
-
instance_id string(UUID) Required
curl \
-X PUT http://localhost:8080/api/data/milestones/{instance_id} \
-H "Authorization: $API_KEY" \
-d '{"data":["string"],"limit":42,"nb_pages":42,"offset":42,"page":42,"total":42}'
{
"data": [
"string"
],
"limit": 42,
"nb_pages": 42,
"offset": 42,
"page": 42,
"total": 42
}
Delete a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id string(UUID) Required
curl \
-X DELETE http://localhost:8080/api/data/milestones/{instance_id} \
-H "Authorization: $API_KEY"
curl \
-X GET http://localhost:8080/api/data/news/ \
-H "Authorization: $API_KEY"
Create a model with data given in the request body.
JSON format is expected. The model performs the validation automatically when instantiated.
curl \
-X POST http://localhost:8080/api/data/news/ \
-H "Authorization: $API_KEY" \
-d '{"data":["string"],"limit":42,"nb_pages":42,"offset":42,"page":42,"total":42}'
{
"data": [
"string"
],
"limit": 42,
"nb_pages": 42,
"offset": 42,
"page": 42,
"total": 42
}
Retrieve a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id string(UUID) Required
curl \
-X GET http://localhost:8080/api/data/news/{instance_id} \
-H "Authorization: $API_KEY"
Update a model with data given in the request body.
JSON format is expected. Model performs the validation automatically when fields are modified.
Path parameters
-
instance_id string(UUID) Required
curl \
-X PUT http://localhost:8080/api/data/news/{instance_id} \
-H "Authorization: $API_KEY" \
-d '{"data":["string"],"limit":42,"nb_pages":42,"offset":42,"page":42,"total":42}'
{
"data": [
"string"
],
"limit": 42,
"nb_pages": 42,
"offset": 42,
"page": 42,
"total": 42
}
Delete a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id string(UUID) Required
curl \
-X DELETE http://localhost:8080/api/data/news/{instance_id} \
-H "Authorization: $API_KEY"
Retrieve all entries for given model.
Filters can be specified in the query string.
curl \
-X GET http://localhost:8080/api/data/notifications/ \
-H "Authorization: $API_KEY"
Create a model with data given in the request body.
JSON format is expected. The model performs the validation automatically when instantiated.
curl \
-X POST http://localhost:8080/api/data/notifications/ \
-H "Authorization: $API_KEY" \
-d '{"data":["string"],"limit":42,"nb_pages":42,"offset":42,"page":42,"total":42}'
{
"data": [
"string"
],
"limit": 42,
"nb_pages": 42,
"offset": 42,
"page": 42,
"total": 42
}
Retrieve a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id string(UUID) Required
curl \
-X GET http://localhost:8080/api/data/notifications/{instance_id} \
-H "Authorization: $API_KEY"
Update a model with data given in the request body.
JSON format is expected. Model performs the validation automatically when fields are modified.
Path parameters
-
instance_id string(UUID) Required
curl \
-X PUT http://localhost:8080/api/data/notifications/{instance_id} \
-H "Authorization: $API_KEY" \
-d '{"data":["string"],"limit":42,"nb_pages":42,"offset":42,"page":42,"total":42}'
{
"data": [
"string"
],
"limit": 42,
"nb_pages": 42,
"offset": 42,
"page": 42,
"total": 42
}
Delete a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id string(UUID) Required
curl \
-X DELETE http://localhost:8080/api/data/notifications/{instance_id} \
-H "Authorization: $API_KEY"