Netscales API Reference 1.0.0
Servers
| Description | URL |
|---|---|
| https://netscales.fr/api/v1 | https://netscales.fr/api/v1 |
sessions
POST /api/v1/sessions
Create a session
Response 201 Created
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"userAgent": "string",
"provider": "string",
"providerToken": "string",
"email": "string",
"user": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"name": "string",
"password": "string",
"is_agent": true,
"organization": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization_type": "string",
"license_info": "string",
"reseller_info": [
"string"
],
"groups": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"users": null,
"organization": null,
"permissions": [
"user#impersonate@any"
]
}
],
"applications": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"resources": [
{
"name": "string",
"schema": {}
}
],
"custom_resources": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"input": null,
"output": null,
"modules": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
}
],
"modules_metadata": {},
"schema": {}
}
],
"menus": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"placement": "string",
"application": null
},
"routes": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"method": "string",
"url": "string",
"path": "string",
"handler": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"current_build": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"repository": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization": null,
"repository_type": "string",
"volume": null,
"default_branch": "string",
"branches": [
"string"
],
"tags": [
"string"
],
"build_settings": null,
"builds": null
},
"target": null,
"volume": null,
"status": "string",
"errors": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
]
},
"previous_build": null,
"repository": null,
"volumes": null,
"volume_mounts": {},
"status": "string"
},
"application": null
}
],
"organization": null
}
]
},
"groups": null,
"invitation": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"group": null,
"organization": null,
"message": "string",
"user": null
},
"sessions": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"userAgent": "string",
"provider": "string",
"providerToken": "string",
"email": "string",
"user": null,
"token": "string",
"impersonator": "string",
"expiresAt": "string"
}
],
"status": "string",
"reset_at": "string",
"reset_password_token": "string"
},
"token": "string",
"impersonator": "string",
"expiresAt": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"userAgent": {
"type": "string"
},
"provider": {
"type": "string"
},
"providerToken": {
"type": "string"
},
"email": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/User"
},
"token": {
"type": "string"
},
"impersonator": {
"type": "string"
},
"expiresAt": {
"type": "string",
"format": "datetime"
}
},
"required": [
"email"
]
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
groups
POST /api/v1/groups
Create a group
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 201 Created
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"users": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"name": "string",
"password": "string",
"is_agent": true,
"organization": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization_type": "string",
"license_info": "string",
"reseller_info": [
"string"
],
"groups": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"users": null,
"organization": null,
"permissions": [
"user#impersonate@any"
]
}
],
"applications": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"resources": [
{
"name": "string",
"schema": {}
}
],
"custom_resources": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"input": null,
"output": null,
"modules": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
}
],
"modules_metadata": {},
"schema": {}
}
],
"menus": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"placement": "string",
"application": null
},
"routes": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"method": "string",
"url": "string",
"path": "string",
"handler": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"current_build": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"repository": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization": null,
"repository_type": "string",
"volume": null,
"default_branch": "string",
"branches": [
"string"
],
"tags": [
"string"
],
"build_settings": null,
"builds": null
},
"target": null,
"volume": null,
"status": "string",
"errors": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
]
},
"previous_build": null,
"repository": null,
"volumes": null,
"volume_mounts": {},
"status": "string"
},
"application": null
}
],
"organization": null
}
]
},
"groups": null,
"invitation": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"group": null,
"organization": null,
"message": "string",
"user": null
},
"sessions": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"userAgent": "string",
"provider": "string",
"providerToken": "string",
"email": "string",
"user": null,
"token": "string",
"impersonator": "string",
"expiresAt": "string"
}
],
"status": "string",
"reset_at": "string",
"reset_password_token": "string"
}
],
"organization": null,
"permissions": null
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/User"
}
},
"organization": {
"$ref": "#/components/schemas/Organization"
},
"permissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupPermissions"
}
}
},
"required": [
"name",
"organization"
]
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
PUT /api/v1/groups
Update a group
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"users": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"name": "string",
"password": "string",
"is_agent": true,
"organization": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization_type": "string",
"license_info": "string",
"reseller_info": [
"string"
],
"groups": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"users": null,
"organization": null,
"permissions": [
"user#impersonate@any"
]
}
],
"applications": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"resources": [
{
"name": "string",
"schema": {}
}
],
"custom_resources": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"input": null,
"output": null,
"modules": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
}
],
"modules_metadata": {},
"schema": {}
}
],
"menus": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"placement": "string",
"application": null
},
"routes": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"method": "string",
"url": "string",
"path": "string",
"handler": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"current_build": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"repository": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization": null,
"repository_type": "string",
"volume": null,
"default_branch": "string",
"branches": [
"string"
],
"tags": [
"string"
],
"build_settings": null,
"builds": null
},
"target": null,
"volume": null,
"status": "string",
"errors": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
]
},
"previous_build": null,
"repository": null,
"volumes": null,
"volume_mounts": {},
"status": "string"
},
"application": null
}
],
"organization": null
}
]
},
"groups": null,
"invitation": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"group": null,
"organization": null,
"message": "string",
"user": null
},
"sessions": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"userAgent": "string",
"provider": "string",
"providerToken": "string",
"email": "string",
"user": null,
"token": "string",
"impersonator": "string",
"expiresAt": "string"
}
],
"status": "string",
"reset_at": "string",
"reset_password_token": "string"
}
],
"organization": null,
"permissions": null
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/User"
}
},
"organization": {
"$ref": "#/components/schemas/Organization"
},
"permissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupPermissions"
}
}
},
"required": [
"name",
"organization"
]
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
DELETE /api/v1/groups
Delete a group
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
GET /api/v1/groups
List groups
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
[
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"users": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"name": "string",
"password": "string",
"is_agent": true,
"organization": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization_type": "string",
"license_info": "string",
"reseller_info": [
"string"
],
"groups": null,
"applications": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"resources": [
{
"name": "string",
"schema": {}
}
],
"custom_resources": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"input": null,
"output": null,
"modules": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
}
],
"modules_metadata": {},
"schema": {}
}
],
"menus": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"placement": "string",
"application": null
},
"routes": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"method": "string",
"url": "string",
"path": "string",
"handler": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"current_build": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"repository": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization": null,
"repository_type": "string",
"volume": null,
"default_branch": "string",
"branches": [
"string"
],
"tags": [
"string"
],
"build_settings": null,
"builds": null
},
"target": null,
"volume": null,
"status": "string",
"errors": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
]
},
"previous_build": null,
"repository": null,
"volumes": null,
"volume_mounts": {},
"status": "string"
},
"application": null
}
],
"organization": null
}
]
},
"groups": null,
"invitation": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"group": null,
"organization": null,
"message": "string",
"user": null
},
"sessions": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"userAgent": "string",
"provider": "string",
"providerToken": "string",
"email": "string",
"user": null,
"token": "string",
"impersonator": "string",
"expiresAt": "string"
}
],
"status": "string",
"reset_at": "string",
"reset_password_token": "string"
}
],
"organization": null,
"permissions": [
"user#impersonate@any"
]
}
]
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
invitations
POST /api/v1/invitations
Create a invitation
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 201 Created
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"group": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"users": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"name": "string",
"password": "string",
"is_agent": true,
"organization": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization_type": "string",
"license_info": "string",
"reseller_info": [
"string"
],
"groups": null,
"applications": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"resources": [
{
"name": "string",
"schema": {}
}
],
"custom_resources": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"input": null,
"output": null,
"modules": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
}
],
"modules_metadata": {},
"schema": {}
}
],
"menus": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"placement": "string",
"application": null
},
"routes": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"method": "string",
"url": "string",
"path": "string",
"handler": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"current_build": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"repository": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization": null,
"repository_type": "string",
"volume": null,
"default_branch": "string",
"branches": [
"string"
],
"tags": [
"string"
],
"build_settings": null,
"builds": null
},
"target": null,
"volume": null,
"status": "string",
"errors": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
]
},
"previous_build": null,
"repository": null,
"volumes": null,
"volume_mounts": {},
"status": "string"
},
"application": null
}
],
"organization": null
}
]
},
"groups": null,
"invitation": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"group": null,
"organization": null,
"message": "string",
"user": null
},
"sessions": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"userAgent": "string",
"provider": "string",
"providerToken": "string",
"email": "string",
"user": null,
"token": "string",
"impersonator": "string",
"expiresAt": "string"
}
],
"status": "string",
"reset_at": "string",
"reset_password_token": "string"
}
],
"organization": null,
"permissions": [
"user#impersonate@any"
]
},
"organization": null,
"message": "string",
"user": null
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"email": {
"type": "string"
},
"group": {
"$ref": "#/components/schemas/Group"
},
"organization": {
"$ref": "#/components/schemas/Organization"
},
"message": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/User"
}
}
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
users
POST /api/v1/users
Create a user
Response 201 Created
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"name": "string",
"password": "string",
"is_agent": true,
"organization": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization_type": "string",
"license_info": "string",
"reseller_info": [
"string"
],
"groups": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"users": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"name": "string",
"password": "string",
"is_agent": true,
"organization": null,
"groups": null,
"invitation": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"group": null,
"organization": null,
"message": "string",
"user": null
},
"sessions": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"userAgent": "string",
"provider": "string",
"providerToken": "string",
"email": "string",
"user": null,
"token": "string",
"impersonator": "string",
"expiresAt": "string"
}
],
"status": "string",
"reset_at": "string",
"reset_password_token": "string"
}
],
"organization": null,
"permissions": [
"user#impersonate@any"
]
}
],
"applications": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"resources": [
{
"name": "string",
"schema": {}
}
],
"custom_resources": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"input": null,
"output": null,
"modules": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
}
],
"modules_metadata": {},
"schema": {}
}
],
"menus": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"placement": "string",
"application": null
},
"routes": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"method": "string",
"url": "string",
"path": "string",
"handler": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"current_build": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"repository": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization": null,
"repository_type": "string",
"volume": null,
"default_branch": "string",
"branches": [
"string"
],
"tags": [
"string"
],
"build_settings": null,
"builds": null
},
"target": null,
"volume": null,
"status": "string",
"errors": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
]
},
"previous_build": null,
"repository": null,
"volumes": null,
"volume_mounts": {},
"status": "string"
},
"application": null
}
],
"organization": null
}
]
},
"groups": null,
"invitation": null,
"sessions": null,
"status": "string",
"reset_at": "string",
"reset_password_token": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"is_agent": {
"type": "boolean"
},
"organization": {
"$ref": "#/components/schemas/Organization"
},
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Group"
}
},
"invitation": {
"$ref": "#/components/schemas/Invitation"
},
"sessions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Session"
}
},
"status": {
"type": "string"
},
"reset_at": {
"type": "string",
"format": "datetime"
},
"reset_password_token": {
"type": "string"
}
}
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
PUT /api/v1/users
Update a user
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"name": "string",
"password": "string",
"is_agent": true,
"organization": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization_type": "string",
"license_info": "string",
"reseller_info": [
"string"
],
"groups": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"users": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"name": "string",
"password": "string",
"is_agent": true,
"organization": null,
"groups": null,
"invitation": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"group": null,
"organization": null,
"message": "string",
"user": null
},
"sessions": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"userAgent": "string",
"provider": "string",
"providerToken": "string",
"email": "string",
"user": null,
"token": "string",
"impersonator": "string",
"expiresAt": "string"
}
],
"status": "string",
"reset_at": "string",
"reset_password_token": "string"
}
],
"organization": null,
"permissions": [
"user#impersonate@any"
]
}
],
"applications": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"resources": [
{
"name": "string",
"schema": {}
}
],
"custom_resources": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"input": null,
"output": null,
"modules": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
}
],
"modules_metadata": {},
"schema": {}
}
],
"menus": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"placement": "string",
"application": null
},
"routes": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"method": "string",
"url": "string",
"path": "string",
"handler": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"current_build": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"repository": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization": null,
"repository_type": "string",
"volume": null,
"default_branch": "string",
"branches": [
"string"
],
"tags": [
"string"
],
"build_settings": null,
"builds": null
},
"target": null,
"volume": null,
"status": "string",
"errors": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
]
},
"previous_build": null,
"repository": null,
"volumes": null,
"volume_mounts": {},
"status": "string"
},
"application": null
}
],
"organization": null
}
]
},
"groups": null,
"invitation": null,
"sessions": null,
"status": "string",
"reset_at": "string",
"reset_password_token": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"is_agent": {
"type": "boolean"
},
"organization": {
"$ref": "#/components/schemas/Organization"
},
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Group"
}
},
"invitation": {
"$ref": "#/components/schemas/Invitation"
},
"sessions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Session"
}
},
"status": {
"type": "string"
},
"reset_at": {
"type": "string",
"format": "datetime"
},
"reset_password_token": {
"type": "string"
}
}
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
GET /api/v1/users
List users
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
[
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"name": "string",
"password": "string",
"is_agent": true,
"organization": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization_type": "string",
"license_info": "string",
"reseller_info": [
"string"
],
"groups": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"users": null,
"organization": null,
"permissions": [
"user#impersonate@any"
]
}
],
"applications": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"resources": [
{
"name": "string",
"schema": {}
}
],
"custom_resources": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"input": null,
"output": null,
"modules": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
}
],
"modules_metadata": {},
"schema": {}
}
],
"menus": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"placement": "string",
"application": null
},
"routes": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"method": "string",
"url": "string",
"path": "string",
"handler": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"current_build": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"repository": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization": null,
"repository_type": "string",
"volume": null,
"default_branch": "string",
"branches": [
"string"
],
"tags": [
"string"
],
"build_settings": null,
"builds": null
},
"target": null,
"volume": null,
"status": "string",
"errors": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
]
},
"previous_build": null,
"repository": null,
"volumes": null,
"volume_mounts": {},
"status": "string"
},
"application": null
}
],
"organization": null
}
]
},
"groups": null,
"invitation": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"group": null,
"organization": null,
"message": "string",
"user": null
},
"sessions": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"userAgent": "string",
"provider": "string",
"providerToken": "string",
"email": "string",
"user": null,
"token": "string",
"impersonator": "string",
"expiresAt": "string"
}
],
"status": "string",
"reset_at": "string",
"reset_password_token": "string"
}
]
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
audit-items
GET /api/v1/audit-items
List audit-items
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
[
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"recordType": "string",
"recordId": "string",
"data": {}
}
]
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
batch-downloads
POST /api/v1/batch-downloads
Create a batch-download
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 201 Created
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"files": [
{}
],
"action_type": "string",
"action_context": null,
"status": "string",
"download_url": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"files": {
"type": "array",
"items": {
"type": "object"
}
},
"action_type": {
"type": "string"
},
"action_context": {},
"status": {
"type": "string"
},
"download_url": {
"type": "string"
}
},
"required": [
"action_type"
]
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
GET /api/v1/batch-downloads
List batch-downloads
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
[
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"files": [
{}
],
"action_type": "string",
"action_context": null,
"status": "string",
"download_url": "string"
}
]
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
secret-notes
POST /api/v1/secret-notes
Create a secret-note
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 201 Created
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
organizations
POST /api/v1/organizations
Create a organization
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 201 Created
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization_type": "string",
"license_info": "string",
"reseller_info": [
"string"
],
"groups": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"users": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"name": "string",
"password": "string",
"is_agent": true,
"organization": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization_type": "string",
"license_info": "string",
"reseller_info": [
"string"
],
"groups": null,
"applications": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"resources": [
{
"name": "string",
"schema": {}
}
],
"custom_resources": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"input": null,
"output": null,
"modules": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
}
],
"modules_metadata": {},
"schema": {}
}
],
"menus": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"placement": "string",
"application": null
},
"routes": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"method": "string",
"url": "string",
"path": "string",
"handler": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"current_build": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"repository": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization": null,
"repository_type": "string",
"volume": null,
"default_branch": "string",
"branches": [
"string"
],
"tags": [
"string"
],
"build_settings": null,
"builds": null
},
"target": null,
"volume": null,
"status": "string",
"errors": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
]
},
"previous_build": null,
"repository": null,
"volumes": null,
"volume_mounts": {},
"status": "string"
},
"application": null
}
],
"organization": null
}
]
},
"groups": null,
"invitation": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"group": null,
"organization": null,
"message": "string",
"user": null
},
"sessions": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"userAgent": "string",
"provider": "string",
"providerToken": "string",
"email": "string",
"user": null,
"token": "string",
"impersonator": "string",
"expiresAt": "string"
}
],
"status": "string",
"reset_at": "string",
"reset_password_token": "string"
}
],
"organization": null,
"permissions": [
"user#impersonate@any"
]
}
],
"applications": null
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"organization_type": {
"type": "string"
},
"license_info": {
"type": "string"
},
"reseller_info": {
"type": "array",
"items": {
"type": "string"
}
},
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Group"
}
},
"applications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Application"
}
}
}
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
PUT /api/v1/organizations
Update a organization
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization_type": "string",
"license_info": "string",
"reseller_info": [
"string"
],
"groups": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"users": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"name": "string",
"password": "string",
"is_agent": true,
"organization": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization_type": "string",
"license_info": "string",
"reseller_info": [
"string"
],
"groups": null,
"applications": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"resources": [
{
"name": "string",
"schema": {}
}
],
"custom_resources": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"input": null,
"output": null,
"modules": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
}
],
"modules_metadata": {},
"schema": {}
}
],
"menus": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"placement": "string",
"application": null
},
"routes": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"method": "string",
"url": "string",
"path": "string",
"handler": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"current_build": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"repository": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization": null,
"repository_type": "string",
"volume": null,
"default_branch": "string",
"branches": [
"string"
],
"tags": [
"string"
],
"build_settings": null,
"builds": null
},
"target": null,
"volume": null,
"status": "string",
"errors": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
]
},
"previous_build": null,
"repository": null,
"volumes": null,
"volume_mounts": {},
"status": "string"
},
"application": null
}
],
"organization": null
}
]
},
"groups": null,
"invitation": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"group": null,
"organization": null,
"message": "string",
"user": null
},
"sessions": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"userAgent": "string",
"provider": "string",
"providerToken": "string",
"email": "string",
"user": null,
"token": "string",
"impersonator": "string",
"expiresAt": "string"
}
],
"status": "string",
"reset_at": "string",
"reset_password_token": "string"
}
],
"organization": null,
"permissions": [
"user#impersonate@any"
]
}
],
"applications": null
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"organization_type": {
"type": "string"
},
"license_info": {
"type": "string"
},
"reseller_info": {
"type": "array",
"items": {
"type": "string"
}
},
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Group"
}
},
"applications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Application"
}
}
}
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
GET /api/v1/organizations
List organizations
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
[
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization_type": "string",
"license_info": "string",
"reseller_info": [
"string"
],
"groups": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"users": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"name": "string",
"password": "string",
"is_agent": true,
"organization": null,
"groups": null,
"invitation": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"group": null,
"organization": null,
"message": "string",
"user": null
},
"sessions": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"userAgent": "string",
"provider": "string",
"providerToken": "string",
"email": "string",
"user": null,
"token": "string",
"impersonator": "string",
"expiresAt": "string"
}
],
"status": "string",
"reset_at": "string",
"reset_password_token": "string"
}
],
"organization": null,
"permissions": [
"user#impersonate@any"
]
}
],
"applications": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"resources": [
{
"name": "string",
"schema": {}
}
],
"custom_resources": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"input": null,
"output": null,
"modules": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
}
],
"modules_metadata": {},
"schema": {}
}
],
"menus": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"placement": "string",
"application": null
},
"routes": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"method": "string",
"url": "string",
"path": "string",
"handler": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"current_build": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"repository": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization": null,
"repository_type": "string",
"volume": null,
"default_branch": "string",
"branches": [
"string"
],
"tags": [
"string"
],
"build_settings": null,
"builds": null
},
"target": null,
"volume": null,
"status": "string",
"errors": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
]
},
"previous_build": null,
"repository": null,
"volumes": null,
"volume_mounts": {},
"status": "string"
},
"application": null
}
],
"organization": null
}
]
}
]
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
journal-pesees
POST /api/v1/journal-pesees
Create a journal-pesee
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 201 Created
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"dsd": "string",
"ptac": 10.12,
"pesee_type": "string",
"status": "string",
"date_dsd": "string",
"fields": [
null
],
"pesee": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"num_pesee": "string",
"pesee_type": "string",
"order_value": 10.12,
"brut": 10.12,
"tare": 10.12,
"net": 10.12,
"mode": "string",
"ptac": 10.12,
"observation": "string",
"completion_reason": "string",
"completed_at": "string",
"status": "string",
"detail": "string",
"immatriculation": "string",
"client": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"address": "string",
"fields": [
null
],
"contact_details": null,
"badges": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"rfid": "string",
"immatriculation": "string",
"client": null,
"last_activity": "string",
"current_borne": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"lcd1": "string",
"lcd2": "string",
"cycle_pesage": "string",
"cycle_old": "string",
"poids_dsd": 10.12,
"dsd": "string",
"first_date": 10.12,
"last_date": "string",
"nb_fic": 10.12,
"badge_code": "string",
"badge_rfid": "string",
"erreur": "string",
"entry_enabled": true,
"exit_enabled": true,
"entry_ticket_enabled": true,
"exit_ticket_enabled": true,
"minimum_ticket_lines": 10.12,
"transactional_data": {},
"timezone": "string",
"bascule": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"dsd": "string",
"ip_address": "string",
"enabled": true,
"bornes": null,
"dsd_log": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"bascule": null,
"dsd": "string"
}
]
},
"current_badge": null,
"entry_form_schema": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"fields": [
null
],
"ticket_template": "string",
"applies_to": [
"in"
]
},
"exit_form_schema": null,
"ip_address": "string",
"mac_address": "string",
"custom_commands": [
null
],
"pending_commands": [
null
]
},
"fields": [
null
],
"pesees": null,
"status": "string"
}
],
"status": "string"
},
"fields": [
null
],
"entry_schema": null,
"exit_schema": null,
"entries": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"dsd": "string",
"ptac": 10.12,
"pesee_type": "string",
"status": "string",
"date_dsd": "string",
"fields": [
null
],
"pesee": null,
"borne": null
}
],
"badge": null
},
"borne": null
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"brut": {
"type": "number"
},
"dsd": {
"type": "string"
},
"ptac": {
"type": "number"
},
"pesee_type": {
"type": "string"
},
"status": {
"type": "string"
},
"date_dsd": {
"type": "string",
"format": "datetime"
},
"fields": {
"type": "array",
"items": {}
},
"pesee": {
"$ref": "#/components/schemas/Pesee"
},
"borne": {
"$ref": "#/components/schemas/Borne"
}
},
"required": [
"pesee"
]
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
PUT /api/v1/journal-pesees
Update a journal-pesee
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"dsd": "string",
"ptac": 10.12,
"pesee_type": "string",
"status": "string",
"date_dsd": "string",
"fields": [
null
],
"pesee": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"num_pesee": "string",
"pesee_type": "string",
"order_value": 10.12,
"brut": 10.12,
"tare": 10.12,
"net": 10.12,
"mode": "string",
"ptac": 10.12,
"observation": "string",
"completion_reason": "string",
"completed_at": "string",
"status": "string",
"detail": "string",
"immatriculation": "string",
"client": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"address": "string",
"fields": [
null
],
"contact_details": null,
"badges": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"rfid": "string",
"immatriculation": "string",
"client": null,
"last_activity": "string",
"current_borne": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"lcd1": "string",
"lcd2": "string",
"cycle_pesage": "string",
"cycle_old": "string",
"poids_dsd": 10.12,
"dsd": "string",
"first_date": 10.12,
"last_date": "string",
"nb_fic": 10.12,
"badge_code": "string",
"badge_rfid": "string",
"erreur": "string",
"entry_enabled": true,
"exit_enabled": true,
"entry_ticket_enabled": true,
"exit_ticket_enabled": true,
"minimum_ticket_lines": 10.12,
"transactional_data": {},
"timezone": "string",
"bascule": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"dsd": "string",
"ip_address": "string",
"enabled": true,
"bornes": null,
"dsd_log": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"bascule": null,
"dsd": "string"
}
]
},
"current_badge": null,
"entry_form_schema": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"fields": [
null
],
"ticket_template": "string",
"applies_to": [
"in"
]
},
"exit_form_schema": null,
"ip_address": "string",
"mac_address": "string",
"custom_commands": [
null
],
"pending_commands": [
null
]
},
"fields": [
null
],
"pesees": null,
"status": "string"
}
],
"status": "string"
},
"fields": [
null
],
"entry_schema": null,
"exit_schema": null,
"entries": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"dsd": "string",
"ptac": 10.12,
"pesee_type": "string",
"status": "string",
"date_dsd": "string",
"fields": [
null
],
"pesee": null,
"borne": null
}
],
"badge": null
},
"borne": null
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"brut": {
"type": "number"
},
"dsd": {
"type": "string"
},
"ptac": {
"type": "number"
},
"pesee_type": {
"type": "string"
},
"status": {
"type": "string"
},
"date_dsd": {
"type": "string",
"format": "datetime"
},
"fields": {
"type": "array",
"items": {}
},
"pesee": {
"$ref": "#/components/schemas/Pesee"
},
"borne": {
"$ref": "#/components/schemas/Borne"
}
},
"required": [
"pesee"
]
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
GET /api/v1/journal-pesees
List journal-pesees
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
[
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"dsd": "string",
"ptac": 10.12,
"pesee_type": "string",
"status": "string",
"date_dsd": "string",
"fields": [
null
],
"pesee": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"num_pesee": "string",
"pesee_type": "string",
"order_value": 10.12,
"brut": 10.12,
"tare": 10.12,
"net": 10.12,
"mode": "string",
"ptac": 10.12,
"observation": "string",
"completion_reason": "string",
"completed_at": "string",
"status": "string",
"detail": "string",
"immatriculation": "string",
"client": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"address": "string",
"fields": [
null
],
"contact_details": null,
"badges": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"rfid": "string",
"immatriculation": "string",
"client": null,
"last_activity": "string",
"current_borne": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"lcd1": "string",
"lcd2": "string",
"cycle_pesage": "string",
"cycle_old": "string",
"poids_dsd": 10.12,
"dsd": "string",
"first_date": 10.12,
"last_date": "string",
"nb_fic": 10.12,
"badge_code": "string",
"badge_rfid": "string",
"erreur": "string",
"entry_enabled": true,
"exit_enabled": true,
"entry_ticket_enabled": true,
"exit_ticket_enabled": true,
"minimum_ticket_lines": 10.12,
"transactional_data": {},
"timezone": "string",
"bascule": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"dsd": "string",
"ip_address": "string",
"enabled": true,
"bornes": null,
"dsd_log": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"bascule": null,
"dsd": "string"
}
]
},
"current_badge": null,
"entry_form_schema": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"fields": [
null
],
"ticket_template": "string",
"applies_to": [
"in"
]
},
"exit_form_schema": null,
"ip_address": "string",
"mac_address": "string",
"custom_commands": [
null
],
"pending_commands": [
null
]
},
"fields": [
null
],
"pesees": null,
"status": "string"
}
],
"status": "string"
},
"fields": [
null
],
"entry_schema": null,
"exit_schema": null,
"entries": null,
"badge": null
},
"borne": null
}
]
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
pesees
POST /api/v1/pesees
Create a pesee
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 201 Created
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"num_pesee": "string",
"pesee_type": "string",
"order_value": 10.12,
"brut": 10.12,
"tare": 10.12,
"net": 10.12,
"mode": "string",
"ptac": 10.12,
"observation": "string",
"completion_reason": "string",
"completed_at": "string",
"status": "string",
"detail": "string",
"immatriculation": "string",
"client": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"address": "string",
"fields": [
null
],
"contact_details": null,
"badges": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"rfid": "string",
"immatriculation": "string",
"client": null,
"last_activity": "string",
"current_borne": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"lcd1": "string",
"lcd2": "string",
"cycle_pesage": "string",
"cycle_old": "string",
"poids_dsd": 10.12,
"dsd": "string",
"first_date": 10.12,
"last_date": "string",
"nb_fic": 10.12,
"badge_code": "string",
"badge_rfid": "string",
"erreur": "string",
"entry_enabled": true,
"exit_enabled": true,
"entry_ticket_enabled": true,
"exit_ticket_enabled": true,
"minimum_ticket_lines": 10.12,
"transactional_data": {},
"timezone": "string",
"bascule": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"dsd": "string",
"ip_address": "string",
"enabled": true,
"bornes": null,
"dsd_log": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"bascule": null,
"dsd": "string"
}
]
},
"current_badge": null,
"entry_form_schema": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"fields": [
null
],
"ticket_template": "string",
"applies_to": [
"in"
]
},
"exit_form_schema": null,
"ip_address": "string",
"mac_address": "string",
"custom_commands": [
null
],
"pending_commands": [
null
]
},
"fields": [
null
],
"pesees": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"num_pesee": "string",
"pesee_type": "string",
"order_value": 10.12,
"brut": 10.12,
"tare": 10.12,
"net": 10.12,
"mode": "string",
"ptac": 10.12,
"observation": "string",
"completion_reason": "string",
"completed_at": "string",
"status": "string",
"detail": "string",
"immatriculation": "string",
"client": null,
"fields": [
null
],
"entry_schema": null,
"exit_schema": null,
"entries": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"dsd": "string",
"ptac": 10.12,
"pesee_type": "string",
"status": "string",
"date_dsd": "string",
"fields": [
null
],
"pesee": null,
"borne": null
}
],
"badge": null
}
],
"status": "string"
}
],
"status": "string"
},
"fields": [
null
],
"entry_schema": null,
"exit_schema": null,
"entries": null,
"badge": null
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"num_pesee": {
"type": "string"
},
"pesee_type": {
"type": "string"
},
"order_value": {
"type": "number"
},
"brut": {
"type": "number"
},
"tare": {
"type": "number"
},
"net": {
"type": "number"
},
"mode": {
"type": "string"
},
"ptac": {
"type": "number"
},
"observation": {
"type": "string"
},
"completion_reason": {
"type": "string"
},
"completed_at": {
"type": "string",
"format": "datetime"
},
"status": {
"type": "string"
},
"detail": {
"type": "string"
},
"immatriculation": {
"type": "string"
},
"client": {
"$ref": "#/components/schemas/Client"
},
"fields": {
"type": "array",
"items": {}
},
"entry_schema": {
"$ref": "#/components/schemas/FormSchema"
},
"exit_schema": {
"$ref": "#/components/schemas/FormSchema"
},
"entries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JournalPesee"
}
},
"badge": {
"$ref": "#/components/schemas/Badge"
}
},
"required": [
"status",
"immatriculation",
"client"
]
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
PUT /api/v1/pesees
Update a pesee
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"num_pesee": "string",
"pesee_type": "string",
"order_value": 10.12,
"brut": 10.12,
"tare": 10.12,
"net": 10.12,
"mode": "string",
"ptac": 10.12,
"observation": "string",
"completion_reason": "string",
"completed_at": "string",
"status": "string",
"detail": "string",
"immatriculation": "string",
"client": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"address": "string",
"fields": [
null
],
"contact_details": null,
"badges": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"rfid": "string",
"immatriculation": "string",
"client": null,
"last_activity": "string",
"current_borne": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"lcd1": "string",
"lcd2": "string",
"cycle_pesage": "string",
"cycle_old": "string",
"poids_dsd": 10.12,
"dsd": "string",
"first_date": 10.12,
"last_date": "string",
"nb_fic": 10.12,
"badge_code": "string",
"badge_rfid": "string",
"erreur": "string",
"entry_enabled": true,
"exit_enabled": true,
"entry_ticket_enabled": true,
"exit_ticket_enabled": true,
"minimum_ticket_lines": 10.12,
"transactional_data": {},
"timezone": "string",
"bascule": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"dsd": "string",
"ip_address": "string",
"enabled": true,
"bornes": null,
"dsd_log": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"bascule": null,
"dsd": "string"
}
]
},
"current_badge": null,
"entry_form_schema": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"fields": [
null
],
"ticket_template": "string",
"applies_to": [
"in"
]
},
"exit_form_schema": null,
"ip_address": "string",
"mac_address": "string",
"custom_commands": [
null
],
"pending_commands": [
null
]
},
"fields": [
null
],
"pesees": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"num_pesee": "string",
"pesee_type": "string",
"order_value": 10.12,
"brut": 10.12,
"tare": 10.12,
"net": 10.12,
"mode": "string",
"ptac": 10.12,
"observation": "string",
"completion_reason": "string",
"completed_at": "string",
"status": "string",
"detail": "string",
"immatriculation": "string",
"client": null,
"fields": [
null
],
"entry_schema": null,
"exit_schema": null,
"entries": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"dsd": "string",
"ptac": 10.12,
"pesee_type": "string",
"status": "string",
"date_dsd": "string",
"fields": [
null
],
"pesee": null,
"borne": null
}
],
"badge": null
}
],
"status": "string"
}
],
"status": "string"
},
"fields": [
null
],
"entry_schema": null,
"exit_schema": null,
"entries": null,
"badge": null
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"num_pesee": {
"type": "string"
},
"pesee_type": {
"type": "string"
},
"order_value": {
"type": "number"
},
"brut": {
"type": "number"
},
"tare": {
"type": "number"
},
"net": {
"type": "number"
},
"mode": {
"type": "string"
},
"ptac": {
"type": "number"
},
"observation": {
"type": "string"
},
"completion_reason": {
"type": "string"
},
"completed_at": {
"type": "string",
"format": "datetime"
},
"status": {
"type": "string"
},
"detail": {
"type": "string"
},
"immatriculation": {
"type": "string"
},
"client": {
"$ref": "#/components/schemas/Client"
},
"fields": {
"type": "array",
"items": {}
},
"entry_schema": {
"$ref": "#/components/schemas/FormSchema"
},
"exit_schema": {
"$ref": "#/components/schemas/FormSchema"
},
"entries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JournalPesee"
}
},
"badge": {
"$ref": "#/components/schemas/Badge"
}
},
"required": [
"status",
"immatriculation",
"client"
]
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
GET /api/v1/pesees
List pesees
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
[
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"num_pesee": "string",
"pesee_type": "string",
"order_value": 10.12,
"brut": 10.12,
"tare": 10.12,
"net": 10.12,
"mode": "string",
"ptac": 10.12,
"observation": "string",
"completion_reason": "string",
"completed_at": "string",
"status": "string",
"detail": "string",
"immatriculation": "string",
"client": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"address": "string",
"fields": [
null
],
"contact_details": null,
"badges": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"rfid": "string",
"immatriculation": "string",
"client": null,
"last_activity": "string",
"current_borne": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"lcd1": "string",
"lcd2": "string",
"cycle_pesage": "string",
"cycle_old": "string",
"poids_dsd": 10.12,
"dsd": "string",
"first_date": 10.12,
"last_date": "string",
"nb_fic": 10.12,
"badge_code": "string",
"badge_rfid": "string",
"erreur": "string",
"entry_enabled": true,
"exit_enabled": true,
"entry_ticket_enabled": true,
"exit_ticket_enabled": true,
"minimum_ticket_lines": 10.12,
"transactional_data": {},
"timezone": "string",
"bascule": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"dsd": "string",
"ip_address": "string",
"enabled": true,
"bornes": null,
"dsd_log": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"bascule": null,
"dsd": "string"
}
]
},
"current_badge": null,
"entry_form_schema": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"fields": [
null
],
"ticket_template": "string",
"applies_to": [
"in"
]
},
"exit_form_schema": null,
"ip_address": "string",
"mac_address": "string",
"custom_commands": [
null
],
"pending_commands": [
null
]
},
"fields": [
null
],
"pesees": null,
"status": "string"
}
],
"status": "string"
},
"fields": [
null
],
"entry_schema": null,
"exit_schema": null,
"entries": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"dsd": "string",
"ptac": 10.12,
"pesee_type": "string",
"status": "string",
"date_dsd": "string",
"fields": [
null
],
"pesee": null,
"borne": null
}
],
"badge": null
}
]
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
vehicles
POST /api/v1/vehicles
Create a vehicle
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 201 Created
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"immatriculation": "string",
"name": "string",
"tare": 10.12,
"ptac": 10.12
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"immatriculation": {
"type": "string"
},
"name": {
"type": "string"
},
"tare": {
"type": "number"
},
"ptac": {
"type": "number"
}
}
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
PUT /api/v1/vehicles
Update a vehicle
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"immatriculation": "string",
"name": "string",
"tare": 10.12,
"ptac": 10.12
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"immatriculation": {
"type": "string"
},
"name": {
"type": "string"
},
"tare": {
"type": "number"
},
"ptac": {
"type": "number"
}
}
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
DELETE /api/v1/vehicles
Delete a vehicle
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
GET /api/v1/vehicles
List vehicles
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
[
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"immatriculation": "string",
"name": "string",
"tare": 10.12,
"ptac": 10.12
}
]
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
badges
POST /api/v1/badges
Create a badge
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 201 Created
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"rfid": "string",
"immatriculation": "string",
"client": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"address": "string",
"fields": [
null
],
"contact_details": null,
"badges": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"rfid": "string",
"immatriculation": "string",
"client": null,
"last_activity": "string",
"current_borne": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"lcd1": "string",
"lcd2": "string",
"cycle_pesage": "string",
"cycle_old": "string",
"poids_dsd": 10.12,
"dsd": "string",
"first_date": 10.12,
"last_date": "string",
"nb_fic": 10.12,
"badge_code": "string",
"badge_rfid": "string",
"erreur": "string",
"entry_enabled": true,
"exit_enabled": true,
"entry_ticket_enabled": true,
"exit_ticket_enabled": true,
"minimum_ticket_lines": 10.12,
"transactional_data": {},
"timezone": "string",
"bascule": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"dsd": "string",
"ip_address": "string",
"enabled": true,
"bornes": null,
"dsd_log": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"bascule": null,
"dsd": "string"
}
]
},
"current_badge": null,
"entry_form_schema": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"fields": [
null
],
"ticket_template": "string",
"applies_to": [
"in"
]
},
"exit_form_schema": null,
"ip_address": "string",
"mac_address": "string",
"custom_commands": [
null
],
"pending_commands": [
null
]
},
"fields": [
null
],
"pesees": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"num_pesee": "string",
"pesee_type": "string",
"order_value": 10.12,
"brut": 10.12,
"tare": 10.12,
"net": 10.12,
"mode": "string",
"ptac": 10.12,
"observation": "string",
"completion_reason": "string",
"completed_at": "string",
"status": "string",
"detail": "string",
"immatriculation": "string",
"client": null,
"fields": [
null
],
"entry_schema": null,
"exit_schema": null,
"entries": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"dsd": "string",
"ptac": 10.12,
"pesee_type": "string",
"status": "string",
"date_dsd": "string",
"fields": [
null
],
"pesee": null,
"borne": null
}
],
"badge": null
}
],
"status": "string"
}
],
"status": "string"
},
"last_activity": "string",
"current_borne": null,
"fields": [
null
],
"pesees": null,
"status": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"rfid": {
"type": "string"
},
"immatriculation": {
"type": "string"
},
"client": {
"$ref": "#/components/schemas/Client"
},
"last_activity": {
"type": "string",
"format": "datetime"
},
"current_borne": {
"$ref": "#/components/schemas/Borne"
},
"fields": {
"type": "array",
"items": {}
},
"pesees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Pesee"
}
},
"status": {
"type": "string"
}
}
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
PUT /api/v1/badges
Update a badge
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"rfid": "string",
"immatriculation": "string",
"client": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"address": "string",
"fields": [
null
],
"contact_details": null,
"badges": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"rfid": "string",
"immatriculation": "string",
"client": null,
"last_activity": "string",
"current_borne": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"lcd1": "string",
"lcd2": "string",
"cycle_pesage": "string",
"cycle_old": "string",
"poids_dsd": 10.12,
"dsd": "string",
"first_date": 10.12,
"last_date": "string",
"nb_fic": 10.12,
"badge_code": "string",
"badge_rfid": "string",
"erreur": "string",
"entry_enabled": true,
"exit_enabled": true,
"entry_ticket_enabled": true,
"exit_ticket_enabled": true,
"minimum_ticket_lines": 10.12,
"transactional_data": {},
"timezone": "string",
"bascule": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"dsd": "string",
"ip_address": "string",
"enabled": true,
"bornes": null,
"dsd_log": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"bascule": null,
"dsd": "string"
}
]
},
"current_badge": null,
"entry_form_schema": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"fields": [
null
],
"ticket_template": "string",
"applies_to": [
"in"
]
},
"exit_form_schema": null,
"ip_address": "string",
"mac_address": "string",
"custom_commands": [
null
],
"pending_commands": [
null
]
},
"fields": [
null
],
"pesees": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"num_pesee": "string",
"pesee_type": "string",
"order_value": 10.12,
"brut": 10.12,
"tare": 10.12,
"net": 10.12,
"mode": "string",
"ptac": 10.12,
"observation": "string",
"completion_reason": "string",
"completed_at": "string",
"status": "string",
"detail": "string",
"immatriculation": "string",
"client": null,
"fields": [
null
],
"entry_schema": null,
"exit_schema": null,
"entries": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"dsd": "string",
"ptac": 10.12,
"pesee_type": "string",
"status": "string",
"date_dsd": "string",
"fields": [
null
],
"pesee": null,
"borne": null
}
],
"badge": null
}
],
"status": "string"
}
],
"status": "string"
},
"last_activity": "string",
"current_borne": null,
"fields": [
null
],
"pesees": null,
"status": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"rfid": {
"type": "string"
},
"immatriculation": {
"type": "string"
},
"client": {
"$ref": "#/components/schemas/Client"
},
"last_activity": {
"type": "string",
"format": "datetime"
},
"current_borne": {
"$ref": "#/components/schemas/Borne"
},
"fields": {
"type": "array",
"items": {}
},
"pesees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Pesee"
}
},
"status": {
"type": "string"
}
}
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
DELETE /api/v1/badges
Delete a badge
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
GET /api/v1/badges
List badges
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
[
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"rfid": "string",
"immatriculation": "string",
"client": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"address": "string",
"fields": [
null
],
"contact_details": null,
"badges": null,
"status": "string"
},
"last_activity": "string",
"current_borne": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"lcd1": "string",
"lcd2": "string",
"cycle_pesage": "string",
"cycle_old": "string",
"poids_dsd": 10.12,
"dsd": "string",
"first_date": 10.12,
"last_date": "string",
"nb_fic": 10.12,
"badge_code": "string",
"badge_rfid": "string",
"erreur": "string",
"entry_enabled": true,
"exit_enabled": true,
"entry_ticket_enabled": true,
"exit_ticket_enabled": true,
"minimum_ticket_lines": 10.12,
"transactional_data": {},
"timezone": "string",
"bascule": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"dsd": "string",
"ip_address": "string",
"enabled": true,
"bornes": null,
"dsd_log": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"bascule": null,
"dsd": "string"
}
]
},
"current_badge": null,
"entry_form_schema": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"fields": [
null
],
"ticket_template": "string",
"applies_to": [
"in"
]
},
"exit_form_schema": null,
"ip_address": "string",
"mac_address": "string",
"custom_commands": [
null
],
"pending_commands": [
null
]
},
"fields": [
null
],
"pesees": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"num_pesee": "string",
"pesee_type": "string",
"order_value": 10.12,
"brut": 10.12,
"tare": 10.12,
"net": 10.12,
"mode": "string",
"ptac": 10.12,
"observation": "string",
"completion_reason": "string",
"completed_at": "string",
"status": "string",
"detail": "string",
"immatriculation": "string",
"client": null,
"fields": [
null
],
"entry_schema": null,
"exit_schema": null,
"entries": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"dsd": "string",
"ptac": 10.12,
"pesee_type": "string",
"status": "string",
"date_dsd": "string",
"fields": [
null
],
"pesee": null,
"borne": null
}
],
"badge": null
}
],
"status": "string"
}
]
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
settings
POST /api/v1/settings
Create a setting
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 201 Created
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"key": "string",
"data_type": "string",
"resource_type": "string",
"resource_id": "string",
"value": "string",
"comment": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"key": {
"type": "string"
},
"data_type": {
"type": "string"
},
"resource_type": {
"type": "string"
},
"resource_id": {
"type": "string"
},
"value": {
"type": "string"
},
"comment": {
"type": "string"
}
}
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
PUT /api/v1/settings
Update a setting
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"key": "string",
"data_type": "string",
"resource_type": "string",
"resource_id": "string",
"value": "string",
"comment": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"key": {
"type": "string"
},
"data_type": {
"type": "string"
},
"resource_type": {
"type": "string"
},
"resource_id": {
"type": "string"
},
"value": {
"type": "string"
},
"comment": {
"type": "string"
}
}
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
GET /api/v1/settings
List settings
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
[
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"key": "string",
"data_type": "string",
"resource_type": "string",
"resource_id": "string",
"value": "string",
"comment": "string"
}
]
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
dsds
POST /api/v1/dsds
Create a dsd
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 201 Created
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"bascule": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"dsd": "string",
"ip_address": "string",
"enabled": true,
"bornes": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"lcd1": "string",
"lcd2": "string",
"cycle_pesage": "string",
"cycle_old": "string",
"poids_dsd": 10.12,
"dsd": "string",
"first_date": 10.12,
"last_date": "string",
"nb_fic": 10.12,
"badge_code": "string",
"badge_rfid": "string",
"erreur": "string",
"entry_enabled": true,
"exit_enabled": true,
"entry_ticket_enabled": true,
"exit_ticket_enabled": true,
"minimum_ticket_lines": 10.12,
"transactional_data": {},
"timezone": "string",
"bascule": null,
"current_badge": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"rfid": "string",
"immatriculation": "string",
"client": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"address": "string",
"fields": [
null
],
"contact_details": null,
"badges": null,
"status": "string"
},
"last_activity": "string",
"current_borne": null,
"fields": [
null
],
"pesees": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"num_pesee": "string",
"pesee_type": "string",
"order_value": 10.12,
"brut": 10.12,
"tare": 10.12,
"net": 10.12,
"mode": "string",
"ptac": 10.12,
"observation": "string",
"completion_reason": "string",
"completed_at": "string",
"status": "string",
"detail": "string",
"immatriculation": "string",
"client": null,
"fields": [
null
],
"entry_schema": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"fields": [
null
],
"ticket_template": "string",
"applies_to": [
"in"
]
},
"exit_schema": null,
"entries": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"dsd": "string",
"ptac": 10.12,
"pesee_type": "string",
"status": "string",
"date_dsd": "string",
"fields": [
null
],
"pesee": null,
"borne": null
}
],
"badge": null
}
],
"status": "string"
},
"entry_form_schema": null,
"exit_form_schema": null,
"ip_address": "string",
"mac_address": "string",
"custom_commands": [
null
],
"pending_commands": [
null
]
}
],
"dsd_log": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"bascule": null,
"dsd": "string"
}
]
},
"dsd": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"brut": {
"type": "number"
},
"poids_dsd": {
"type": "number"
},
"date_dsd": {
"type": "string",
"format": "datetime"
},
"bascule": {
"$ref": "#/components/schemas/Bascule"
},
"dsd": {
"type": "string"
}
}
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
GET /api/v1/dsds
List dsds
Response 200 OK
[
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"bascule": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"dsd": "string",
"ip_address": "string",
"enabled": true,
"bornes": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"lcd1": "string",
"lcd2": "string",
"cycle_pesage": "string",
"cycle_old": "string",
"poids_dsd": 10.12,
"dsd": "string",
"first_date": 10.12,
"last_date": "string",
"nb_fic": 10.12,
"badge_code": "string",
"badge_rfid": "string",
"erreur": "string",
"entry_enabled": true,
"exit_enabled": true,
"entry_ticket_enabled": true,
"exit_ticket_enabled": true,
"minimum_ticket_lines": 10.12,
"transactional_data": {},
"timezone": "string",
"bascule": null,
"current_badge": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"rfid": "string",
"immatriculation": "string",
"client": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"address": "string",
"fields": [
null
],
"contact_details": null,
"badges": null,
"status": "string"
},
"last_activity": "string",
"current_borne": null,
"fields": [
null
],
"pesees": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"num_pesee": "string",
"pesee_type": "string",
"order_value": 10.12,
"brut": 10.12,
"tare": 10.12,
"net": 10.12,
"mode": "string",
"ptac": 10.12,
"observation": "string",
"completion_reason": "string",
"completed_at": "string",
"status": "string",
"detail": "string",
"immatriculation": "string",
"client": null,
"fields": [
null
],
"entry_schema": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"fields": [
null
],
"ticket_template": "string",
"applies_to": [
"in"
]
},
"exit_schema": null,
"entries": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"dsd": "string",
"ptac": 10.12,
"pesee_type": "string",
"status": "string",
"date_dsd": "string",
"fields": [
null
],
"pesee": null,
"borne": null
}
],
"badge": null
}
],
"status": "string"
},
"entry_form_schema": null,
"exit_form_schema": null,
"ip_address": "string",
"mac_address": "string",
"custom_commands": [
null
],
"pending_commands": [
null
]
}
],
"dsd_log": null
},
"dsd": "string"
}
]
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
bascules
POST /api/v1/bascules
Create a bascule
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 201 Created
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"dsd": "string",
"ip_address": "string",
"enabled": true,
"bornes": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"lcd1": "string",
"lcd2": "string",
"cycle_pesage": "string",
"cycle_old": "string",
"poids_dsd": 10.12,
"dsd": "string",
"first_date": 10.12,
"last_date": "string",
"nb_fic": 10.12,
"badge_code": "string",
"badge_rfid": "string",
"erreur": "string",
"entry_enabled": true,
"exit_enabled": true,
"entry_ticket_enabled": true,
"exit_ticket_enabled": true,
"minimum_ticket_lines": 10.12,
"transactional_data": {},
"timezone": "string",
"bascule": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"dsd": "string",
"ip_address": "string",
"enabled": true,
"bornes": null,
"dsd_log": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"bascule": null,
"dsd": "string"
}
]
},
"current_badge": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"rfid": "string",
"immatriculation": "string",
"client": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"address": "string",
"fields": [
null
],
"contact_details": null,
"badges": null,
"status": "string"
},
"last_activity": "string",
"current_borne": null,
"fields": [
null
],
"pesees": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"num_pesee": "string",
"pesee_type": "string",
"order_value": 10.12,
"brut": 10.12,
"tare": 10.12,
"net": 10.12,
"mode": "string",
"ptac": 10.12,
"observation": "string",
"completion_reason": "string",
"completed_at": "string",
"status": "string",
"detail": "string",
"immatriculation": "string",
"client": null,
"fields": [
null
],
"entry_schema": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"fields": [
null
],
"ticket_template": "string",
"applies_to": [
"in"
]
},
"exit_schema": null,
"entries": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"dsd": "string",
"ptac": 10.12,
"pesee_type": "string",
"status": "string",
"date_dsd": "string",
"fields": [
null
],
"pesee": null,
"borne": null
}
],
"badge": null
}
],
"status": "string"
},
"entry_form_schema": null,
"exit_form_schema": null,
"ip_address": "string",
"mac_address": "string",
"custom_commands": [
null
],
"pending_commands": [
null
]
}
],
"dsd_log": null
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"brut": {
"type": "number"
},
"poids_dsd": {
"type": "number"
},
"date_dsd": {
"type": "string",
"format": "datetime"
},
"dsd": {
"type": "string"
},
"ip_address": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"bornes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Borne"
}
},
"dsd_log": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Dsd"
}
}
}
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
PUT /api/v1/bascules
Update a bascule
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"dsd": "string",
"ip_address": "string",
"enabled": true,
"bornes": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"lcd1": "string",
"lcd2": "string",
"cycle_pesage": "string",
"cycle_old": "string",
"poids_dsd": 10.12,
"dsd": "string",
"first_date": 10.12,
"last_date": "string",
"nb_fic": 10.12,
"badge_code": "string",
"badge_rfid": "string",
"erreur": "string",
"entry_enabled": true,
"exit_enabled": true,
"entry_ticket_enabled": true,
"exit_ticket_enabled": true,
"minimum_ticket_lines": 10.12,
"transactional_data": {},
"timezone": "string",
"bascule": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"dsd": "string",
"ip_address": "string",
"enabled": true,
"bornes": null,
"dsd_log": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"bascule": null,
"dsd": "string"
}
]
},
"current_badge": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"rfid": "string",
"immatriculation": "string",
"client": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"address": "string",
"fields": [
null
],
"contact_details": null,
"badges": null,
"status": "string"
},
"last_activity": "string",
"current_borne": null,
"fields": [
null
],
"pesees": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"num_pesee": "string",
"pesee_type": "string",
"order_value": 10.12,
"brut": 10.12,
"tare": 10.12,
"net": 10.12,
"mode": "string",
"ptac": 10.12,
"observation": "string",
"completion_reason": "string",
"completed_at": "string",
"status": "string",
"detail": "string",
"immatriculation": "string",
"client": null,
"fields": [
null
],
"entry_schema": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"fields": [
null
],
"ticket_template": "string",
"applies_to": [
"in"
]
},
"exit_schema": null,
"entries": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"dsd": "string",
"ptac": 10.12,
"pesee_type": "string",
"status": "string",
"date_dsd": "string",
"fields": [
null
],
"pesee": null,
"borne": null
}
],
"badge": null
}
],
"status": "string"
},
"entry_form_schema": null,
"exit_form_schema": null,
"ip_address": "string",
"mac_address": "string",
"custom_commands": [
null
],
"pending_commands": [
null
]
}
],
"dsd_log": null
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"brut": {
"type": "number"
},
"poids_dsd": {
"type": "number"
},
"date_dsd": {
"type": "string",
"format": "datetime"
},
"dsd": {
"type": "string"
},
"ip_address": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"bornes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Borne"
}
},
"dsd_log": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Dsd"
}
}
}
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
DELETE /api/v1/bascules
Delete a bascule
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
GET /api/v1/bascules
List bascules
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
[
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"dsd": "string",
"ip_address": "string",
"enabled": true,
"bornes": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"lcd1": "string",
"lcd2": "string",
"cycle_pesage": "string",
"cycle_old": "string",
"poids_dsd": 10.12,
"dsd": "string",
"first_date": 10.12,
"last_date": "string",
"nb_fic": 10.12,
"badge_code": "string",
"badge_rfid": "string",
"erreur": "string",
"entry_enabled": true,
"exit_enabled": true,
"entry_ticket_enabled": true,
"exit_ticket_enabled": true,
"minimum_ticket_lines": 10.12,
"transactional_data": {},
"timezone": "string",
"bascule": null,
"current_badge": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"rfid": "string",
"immatriculation": "string",
"client": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"address": "string",
"fields": [
null
],
"contact_details": null,
"badges": null,
"status": "string"
},
"last_activity": "string",
"current_borne": null,
"fields": [
null
],
"pesees": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"num_pesee": "string",
"pesee_type": "string",
"order_value": 10.12,
"brut": 10.12,
"tare": 10.12,
"net": 10.12,
"mode": "string",
"ptac": 10.12,
"observation": "string",
"completion_reason": "string",
"completed_at": "string",
"status": "string",
"detail": "string",
"immatriculation": "string",
"client": null,
"fields": [
null
],
"entry_schema": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"fields": [
null
],
"ticket_template": "string",
"applies_to": [
"in"
]
},
"exit_schema": null,
"entries": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"dsd": "string",
"ptac": 10.12,
"pesee_type": "string",
"status": "string",
"date_dsd": "string",
"fields": [
null
],
"pesee": null,
"borne": null
}
],
"badge": null
}
],
"status": "string"
},
"entry_form_schema": null,
"exit_form_schema": null,
"ip_address": "string",
"mac_address": "string",
"custom_commands": [
null
],
"pending_commands": [
null
]
}
],
"dsd_log": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"bascule": null,
"dsd": "string"
}
]
}
]
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
errors
POST /api/v1/errors
Create a error
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 201 Created
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
GET /api/v1/errors
List errors
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
form-schemas
POST /api/v1/form-schemas
Create a form-schema
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 201 Created
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"fields": [
null
],
"ticket_template": "string",
"applies_to": [
"in"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"fields": {
"type": "array",
"items": {}
},
"ticket_template": {
"type": "string"
},
"applies_to": {
"type": "array",
"items": {
"type": "string",
"enum": [
"in",
"out"
]
}
}
}
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
PUT /api/v1/form-schemas
Update a form-schema
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"fields": [
null
],
"ticket_template": "string",
"applies_to": [
"in"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"fields": {
"type": "array",
"items": {}
},
"ticket_template": {
"type": "string"
},
"applies_to": {
"type": "array",
"items": {
"type": "string",
"enum": [
"in",
"out"
]
}
}
}
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
DELETE /api/v1/form-schemas
Delete a form-schema
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
GET /api/v1/form-schemas
List form-schemas
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
[
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"fields": [
null
],
"ticket_template": "string",
"applies_to": [
"in"
]
}
]
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
options
POST /api/v1/options
Create a option
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 201 Created
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"code": "string",
"value": "string",
"fields": [
null
],
"option_list": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"options": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"code": "string",
"value": "string",
"fields": [
null
],
"option_list": null,
"code_id": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"code": "string",
"option": null
}
}
],
"data_type": "string"
},
"code_id": null
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"code": {
"type": "string"
},
"value": {
"type": "string"
},
"fields": {
"type": "array",
"items": {}
},
"option_list": {
"$ref": "#/components/schemas/OptionList"
},
"code_id": {
"$ref": "#/components/schemas/OptionCode"
}
}
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
PUT /api/v1/options
Update a option
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"code": "string",
"value": "string",
"fields": [
null
],
"option_list": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"options": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"code": "string",
"value": "string",
"fields": [
null
],
"option_list": null,
"code_id": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"code": "string",
"option": null
}
}
],
"data_type": "string"
},
"code_id": null
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"code": {
"type": "string"
},
"value": {
"type": "string"
},
"fields": {
"type": "array",
"items": {}
},
"option_list": {
"$ref": "#/components/schemas/OptionList"
},
"code_id": {
"$ref": "#/components/schemas/OptionCode"
}
}
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
GET /api/v1/options
List options
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
[
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"code": "string",
"value": "string",
"fields": [
null
],
"option_list": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"options": null,
"data_type": "string"
},
"code_id": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"code": "string",
"option": null
}
}
]
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
option-lists
POST /api/v1/option-lists
Create a option-list
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 201 Created
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"options": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"code": "string",
"value": "string",
"fields": [
null
],
"option_list": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"options": null,
"data_type": "string"
},
"code_id": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"code": "string",
"option": null
}
}
],
"data_type": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Option"
}
},
"data_type": {
"type": "string"
}
}
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
PUT /api/v1/option-lists
Update a option-list
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"options": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"code": "string",
"value": "string",
"fields": [
null
],
"option_list": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"options": null,
"data_type": "string"
},
"code_id": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"code": "string",
"option": null
}
}
],
"data_type": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Option"
}
},
"data_type": {
"type": "string"
}
}
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
GET /api/v1/option-lists
List option-lists
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
[
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"options": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"code": "string",
"value": "string",
"fields": [
null
],
"option_list": null,
"code_id": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"code": "string",
"option": null
}
}
],
"data_type": "string"
}
]
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
option-codes
POST /api/v1/option-codes
Create a option-code
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 201 Created
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"code": "string",
"option": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"code": "string",
"value": "string",
"fields": [
null
],
"option_list": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"options": null,
"data_type": "string"
},
"code_id": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"code": "string",
"option": null
}
}
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"code": {
"type": "string"
},
"option": {
"$ref": "#/components/schemas/Option"
}
}
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
PUT /api/v1/option-codes
Update a option-code
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"code": "string",
"option": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"code": "string",
"value": "string",
"fields": [
null
],
"option_list": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"options": null,
"data_type": "string"
},
"code_id": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"code": "string",
"option": null
}
}
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"code": {
"type": "string"
},
"option": {
"$ref": "#/components/schemas/Option"
}
}
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
GET /api/v1/option-codes
List option-codes
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
[
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"code": "string",
"option": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"code": "string",
"value": "string",
"fields": [
null
],
"option_list": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"options": null,
"data_type": "string"
},
"code_id": null
}
}
]
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
bornes
POST /api/v1/bornes
Create a borne
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 201 Created
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"lcd1": "string",
"lcd2": "string",
"cycle_pesage": "string",
"cycle_old": "string",
"poids_dsd": 10.12,
"dsd": "string",
"first_date": 10.12,
"last_date": "string",
"nb_fic": 10.12,
"badge_code": "string",
"badge_rfid": "string",
"erreur": "string",
"entry_enabled": true,
"exit_enabled": true,
"entry_ticket_enabled": true,
"exit_ticket_enabled": true,
"minimum_ticket_lines": 10.12,
"transactional_data": {},
"timezone": "string",
"bascule": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"dsd": "string",
"ip_address": "string",
"enabled": true,
"bornes": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"lcd1": "string",
"lcd2": "string",
"cycle_pesage": "string",
"cycle_old": "string",
"poids_dsd": 10.12,
"dsd": "string",
"first_date": 10.12,
"last_date": "string",
"nb_fic": 10.12,
"badge_code": "string",
"badge_rfid": "string",
"erreur": "string",
"entry_enabled": true,
"exit_enabled": true,
"entry_ticket_enabled": true,
"exit_ticket_enabled": true,
"minimum_ticket_lines": 10.12,
"transactional_data": {},
"timezone": "string",
"bascule": null,
"current_badge": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"rfid": "string",
"immatriculation": "string",
"client": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"address": "string",
"fields": [
null
],
"contact_details": null,
"badges": null,
"status": "string"
},
"last_activity": "string",
"current_borne": null,
"fields": [
null
],
"pesees": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"num_pesee": "string",
"pesee_type": "string",
"order_value": 10.12,
"brut": 10.12,
"tare": 10.12,
"net": 10.12,
"mode": "string",
"ptac": 10.12,
"observation": "string",
"completion_reason": "string",
"completed_at": "string",
"status": "string",
"detail": "string",
"immatriculation": "string",
"client": null,
"fields": [
null
],
"entry_schema": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"fields": [
null
],
"ticket_template": "string",
"applies_to": [
"in"
]
},
"exit_schema": null,
"entries": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"dsd": "string",
"ptac": 10.12,
"pesee_type": "string",
"status": "string",
"date_dsd": "string",
"fields": [
null
],
"pesee": null,
"borne": null
}
],
"badge": null
}
],
"status": "string"
},
"entry_form_schema": null,
"exit_form_schema": null,
"ip_address": "string",
"mac_address": "string",
"custom_commands": [
null
],
"pending_commands": [
null
]
}
],
"dsd_log": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"bascule": null,
"dsd": "string"
}
]
},
"current_badge": null,
"entry_form_schema": null,
"exit_form_schema": null,
"ip_address": "string",
"mac_address": "string",
"custom_commands": [
null
],
"pending_commands": [
null
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"lcd1": {
"type": "string"
},
"lcd2": {
"type": "string"
},
"cycle_pesage": {
"type": "string"
},
"cycle_old": {
"type": "string"
},
"poids_dsd": {
"type": "number"
},
"dsd": {
"type": "string"
},
"first_date": {
"type": "number"
},
"last_date": {
"type": "string",
"format": "datetime"
},
"nb_fic": {
"type": "number"
},
"badge_code": {
"type": "string"
},
"badge_rfid": {
"type": "string"
},
"erreur": {
"type": "string"
},
"entry_enabled": {
"type": "boolean"
},
"exit_enabled": {
"type": "boolean"
},
"entry_ticket_enabled": {
"type": "boolean"
},
"exit_ticket_enabled": {
"type": "boolean"
},
"minimum_ticket_lines": {
"type": "number"
},
"transactional_data": {
"type": "object"
},
"timezone": {
"type": "string"
},
"bascule": {
"$ref": "#/components/schemas/Bascule"
},
"current_badge": {
"$ref": "#/components/schemas/Badge"
},
"entry_form_schema": {
"$ref": "#/components/schemas/FormSchema"
},
"exit_form_schema": {
"$ref": "#/components/schemas/FormSchema"
},
"ip_address": {
"type": "string"
},
"mac_address": {
"type": "string"
},
"custom_commands": {
"type": "array",
"items": {}
},
"pending_commands": {
"type": "array",
"items": {}
}
},
"required": [
"bascule"
]
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
PUT /api/v1/bornes
Update a borne
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"lcd1": "string",
"lcd2": "string",
"cycle_pesage": "string",
"cycle_old": "string",
"poids_dsd": 10.12,
"dsd": "string",
"first_date": 10.12,
"last_date": "string",
"nb_fic": 10.12,
"badge_code": "string",
"badge_rfid": "string",
"erreur": "string",
"entry_enabled": true,
"exit_enabled": true,
"entry_ticket_enabled": true,
"exit_ticket_enabled": true,
"minimum_ticket_lines": 10.12,
"transactional_data": {},
"timezone": "string",
"bascule": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"dsd": "string",
"ip_address": "string",
"enabled": true,
"bornes": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"lcd1": "string",
"lcd2": "string",
"cycle_pesage": "string",
"cycle_old": "string",
"poids_dsd": 10.12,
"dsd": "string",
"first_date": 10.12,
"last_date": "string",
"nb_fic": 10.12,
"badge_code": "string",
"badge_rfid": "string",
"erreur": "string",
"entry_enabled": true,
"exit_enabled": true,
"entry_ticket_enabled": true,
"exit_ticket_enabled": true,
"minimum_ticket_lines": 10.12,
"transactional_data": {},
"timezone": "string",
"bascule": null,
"current_badge": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"rfid": "string",
"immatriculation": "string",
"client": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"address": "string",
"fields": [
null
],
"contact_details": null,
"badges": null,
"status": "string"
},
"last_activity": "string",
"current_borne": null,
"fields": [
null
],
"pesees": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"num_pesee": "string",
"pesee_type": "string",
"order_value": 10.12,
"brut": 10.12,
"tare": 10.12,
"net": 10.12,
"mode": "string",
"ptac": 10.12,
"observation": "string",
"completion_reason": "string",
"completed_at": "string",
"status": "string",
"detail": "string",
"immatriculation": "string",
"client": null,
"fields": [
null
],
"entry_schema": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"fields": [
null
],
"ticket_template": "string",
"applies_to": [
"in"
]
},
"exit_schema": null,
"entries": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"dsd": "string",
"ptac": 10.12,
"pesee_type": "string",
"status": "string",
"date_dsd": "string",
"fields": [
null
],
"pesee": null,
"borne": null
}
],
"badge": null
}
],
"status": "string"
},
"entry_form_schema": null,
"exit_form_schema": null,
"ip_address": "string",
"mac_address": "string",
"custom_commands": [
null
],
"pending_commands": [
null
]
}
],
"dsd_log": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"bascule": null,
"dsd": "string"
}
]
},
"current_badge": null,
"entry_form_schema": null,
"exit_form_schema": null,
"ip_address": "string",
"mac_address": "string",
"custom_commands": [
null
],
"pending_commands": [
null
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"lcd1": {
"type": "string"
},
"lcd2": {
"type": "string"
},
"cycle_pesage": {
"type": "string"
},
"cycle_old": {
"type": "string"
},
"poids_dsd": {
"type": "number"
},
"dsd": {
"type": "string"
},
"first_date": {
"type": "number"
},
"last_date": {
"type": "string",
"format": "datetime"
},
"nb_fic": {
"type": "number"
},
"badge_code": {
"type": "string"
},
"badge_rfid": {
"type": "string"
},
"erreur": {
"type": "string"
},
"entry_enabled": {
"type": "boolean"
},
"exit_enabled": {
"type": "boolean"
},
"entry_ticket_enabled": {
"type": "boolean"
},
"exit_ticket_enabled": {
"type": "boolean"
},
"minimum_ticket_lines": {
"type": "number"
},
"transactional_data": {
"type": "object"
},
"timezone": {
"type": "string"
},
"bascule": {
"$ref": "#/components/schemas/Bascule"
},
"current_badge": {
"$ref": "#/components/schemas/Badge"
},
"entry_form_schema": {
"$ref": "#/components/schemas/FormSchema"
},
"exit_form_schema": {
"$ref": "#/components/schemas/FormSchema"
},
"ip_address": {
"type": "string"
},
"mac_address": {
"type": "string"
},
"custom_commands": {
"type": "array",
"items": {}
},
"pending_commands": {
"type": "array",
"items": {}
}
},
"required": [
"bascule"
]
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
DELETE /api/v1/bornes
Delete a borne
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
GET /api/v1/bornes
List bornes
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
[
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"lcd1": "string",
"lcd2": "string",
"cycle_pesage": "string",
"cycle_old": "string",
"poids_dsd": 10.12,
"dsd": "string",
"first_date": 10.12,
"last_date": "string",
"nb_fic": 10.12,
"badge_code": "string",
"badge_rfid": "string",
"erreur": "string",
"entry_enabled": true,
"exit_enabled": true,
"entry_ticket_enabled": true,
"exit_ticket_enabled": true,
"minimum_ticket_lines": 10.12,
"transactional_data": {},
"timezone": "string",
"bascule": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"dsd": "string",
"ip_address": "string",
"enabled": true,
"bornes": null,
"dsd_log": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"bascule": null,
"dsd": "string"
}
]
},
"current_badge": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"rfid": "string",
"immatriculation": "string",
"client": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"address": "string",
"fields": [
null
],
"contact_details": null,
"badges": null,
"status": "string"
},
"last_activity": "string",
"current_borne": null,
"fields": [
null
],
"pesees": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"num_pesee": "string",
"pesee_type": "string",
"order_value": 10.12,
"brut": 10.12,
"tare": 10.12,
"net": 10.12,
"mode": "string",
"ptac": 10.12,
"observation": "string",
"completion_reason": "string",
"completed_at": "string",
"status": "string",
"detail": "string",
"immatriculation": "string",
"client": null,
"fields": [
null
],
"entry_schema": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"fields": [
null
],
"ticket_template": "string",
"applies_to": [
"in"
]
},
"exit_schema": null,
"entries": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"dsd": "string",
"ptac": 10.12,
"pesee_type": "string",
"status": "string",
"date_dsd": "string",
"fields": [
null
],
"pesee": null,
"borne": null
}
],
"badge": null
}
],
"status": "string"
},
"entry_form_schema": null,
"exit_form_schema": null,
"ip_address": "string",
"mac_address": "string",
"custom_commands": [
null
],
"pending_commands": [
null
]
}
]
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
clients
POST /api/v1/clients
Create a client
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 201 Created
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"address": "string",
"fields": [
null
],
"contact_details": null,
"badges": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"rfid": "string",
"immatriculation": "string",
"client": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"address": "string",
"fields": [
null
],
"contact_details": null,
"badges": null,
"status": "string"
},
"last_activity": "string",
"current_borne": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"lcd1": "string",
"lcd2": "string",
"cycle_pesage": "string",
"cycle_old": "string",
"poids_dsd": 10.12,
"dsd": "string",
"first_date": 10.12,
"last_date": "string",
"nb_fic": 10.12,
"badge_code": "string",
"badge_rfid": "string",
"erreur": "string",
"entry_enabled": true,
"exit_enabled": true,
"entry_ticket_enabled": true,
"exit_ticket_enabled": true,
"minimum_ticket_lines": 10.12,
"transactional_data": {},
"timezone": "string",
"bascule": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"dsd": "string",
"ip_address": "string",
"enabled": true,
"bornes": null,
"dsd_log": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"bascule": null,
"dsd": "string"
}
]
},
"current_badge": null,
"entry_form_schema": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"fields": [
null
],
"ticket_template": "string",
"applies_to": [
"in"
]
},
"exit_form_schema": null,
"ip_address": "string",
"mac_address": "string",
"custom_commands": [
null
],
"pending_commands": [
null
]
},
"fields": [
null
],
"pesees": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"num_pesee": "string",
"pesee_type": "string",
"order_value": 10.12,
"brut": 10.12,
"tare": 10.12,
"net": 10.12,
"mode": "string",
"ptac": 10.12,
"observation": "string",
"completion_reason": "string",
"completed_at": "string",
"status": "string",
"detail": "string",
"immatriculation": "string",
"client": null,
"fields": [
null
],
"entry_schema": null,
"exit_schema": null,
"entries": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"dsd": "string",
"ptac": 10.12,
"pesee_type": "string",
"status": "string",
"date_dsd": "string",
"fields": [
null
],
"pesee": null,
"borne": null
}
],
"badge": null
}
],
"status": "string"
}
],
"status": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"address": {
"type": "string"
},
"fields": {
"type": "array",
"items": {}
},
"contact_details": {},
"badges": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Badge"
}
},
"status": {
"type": "string"
}
},
"required": [
"name"
]
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
PUT /api/v1/clients
Update a client
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"address": "string",
"fields": [
null
],
"contact_details": null,
"badges": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"rfid": "string",
"immatriculation": "string",
"client": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"address": "string",
"fields": [
null
],
"contact_details": null,
"badges": null,
"status": "string"
},
"last_activity": "string",
"current_borne": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"lcd1": "string",
"lcd2": "string",
"cycle_pesage": "string",
"cycle_old": "string",
"poids_dsd": 10.12,
"dsd": "string",
"first_date": 10.12,
"last_date": "string",
"nb_fic": 10.12,
"badge_code": "string",
"badge_rfid": "string",
"erreur": "string",
"entry_enabled": true,
"exit_enabled": true,
"entry_ticket_enabled": true,
"exit_ticket_enabled": true,
"minimum_ticket_lines": 10.12,
"transactional_data": {},
"timezone": "string",
"bascule": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"dsd": "string",
"ip_address": "string",
"enabled": true,
"bornes": null,
"dsd_log": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"bascule": null,
"dsd": "string"
}
]
},
"current_badge": null,
"entry_form_schema": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"fields": [
null
],
"ticket_template": "string",
"applies_to": [
"in"
]
},
"exit_form_schema": null,
"ip_address": "string",
"mac_address": "string",
"custom_commands": [
null
],
"pending_commands": [
null
]
},
"fields": [
null
],
"pesees": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"num_pesee": "string",
"pesee_type": "string",
"order_value": 10.12,
"brut": 10.12,
"tare": 10.12,
"net": 10.12,
"mode": "string",
"ptac": 10.12,
"observation": "string",
"completion_reason": "string",
"completed_at": "string",
"status": "string",
"detail": "string",
"immatriculation": "string",
"client": null,
"fields": [
null
],
"entry_schema": null,
"exit_schema": null,
"entries": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"dsd": "string",
"ptac": 10.12,
"pesee_type": "string",
"status": "string",
"date_dsd": "string",
"fields": [
null
],
"pesee": null,
"borne": null
}
],
"badge": null
}
],
"status": "string"
}
],
"status": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"address": {
"type": "string"
},
"fields": {
"type": "array",
"items": {}
},
"contact_details": {},
"badges": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Badge"
}
},
"status": {
"type": "string"
}
},
"required": [
"name"
]
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
DELETE /api/v1/clients
Delete a client
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
GET /api/v1/clients
List clients
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
[
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"address": "string",
"fields": [
null
],
"contact_details": null,
"badges": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"rfid": "string",
"immatriculation": "string",
"client": null,
"last_activity": "string",
"current_borne": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"lcd1": "string",
"lcd2": "string",
"cycle_pesage": "string",
"cycle_old": "string",
"poids_dsd": 10.12,
"dsd": "string",
"first_date": 10.12,
"last_date": "string",
"nb_fic": 10.12,
"badge_code": "string",
"badge_rfid": "string",
"erreur": "string",
"entry_enabled": true,
"exit_enabled": true,
"entry_ticket_enabled": true,
"exit_ticket_enabled": true,
"minimum_ticket_lines": 10.12,
"transactional_data": {},
"timezone": "string",
"bascule": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"dsd": "string",
"ip_address": "string",
"enabled": true,
"bornes": null,
"dsd_log": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"poids_dsd": 10.12,
"date_dsd": "string",
"bascule": null,
"dsd": "string"
}
]
},
"current_badge": null,
"entry_form_schema": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"fields": [
null
],
"ticket_template": "string",
"applies_to": [
"in"
]
},
"exit_form_schema": null,
"ip_address": "string",
"mac_address": "string",
"custom_commands": [
null
],
"pending_commands": [
null
]
},
"fields": [
null
],
"pesees": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"num_pesee": "string",
"pesee_type": "string",
"order_value": 10.12,
"brut": 10.12,
"tare": 10.12,
"net": 10.12,
"mode": "string",
"ptac": 10.12,
"observation": "string",
"completion_reason": "string",
"completed_at": "string",
"status": "string",
"detail": "string",
"immatriculation": "string",
"client": null,
"fields": [
null
],
"entry_schema": null,
"exit_schema": null,
"entries": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"brut": 10.12,
"dsd": "string",
"ptac": 10.12,
"pesee_type": "string",
"status": "string",
"date_dsd": "string",
"fields": [
null
],
"pesee": null,
"borne": null
}
],
"badge": null
}
],
"status": "string"
}
],
"status": "string"
}
]
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
modules
POST /api/v1/modules
Create a module
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 201 Created
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
},
"source": "string",
"sourceMap": null,
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"status": {
"type": "string"
},
"args": {
"type": "array",
"items": {
"type": "string"
}
},
"env": {
"type": "array",
"items": {}
},
"language": {
"type": "string"
},
"runtime": {
"type": "string"
},
"compiler": {
"$ref": "#/components/schemas/Module"
},
"source": {
"type": "string"
},
"sourceMap": {
"$ref": "#/components/schemas/File"
},
"ast": {
"type": "object"
},
"wasm": {
"type": "string",
"format": "byte"
}
},
"required": [
"name",
"args",
"env",
"language",
"runtime",
"source"
]
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
PUT /api/v1/modules
Update a module
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
},
"source": "string",
"sourceMap": null,
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"status": {
"type": "string"
},
"args": {
"type": "array",
"items": {
"type": "string"
}
},
"env": {
"type": "array",
"items": {}
},
"language": {
"type": "string"
},
"runtime": {
"type": "string"
},
"compiler": {
"$ref": "#/components/schemas/Module"
},
"source": {
"type": "string"
},
"sourceMap": {
"$ref": "#/components/schemas/File"
},
"ast": {
"type": "object"
},
"wasm": {
"type": "string",
"format": "byte"
}
},
"required": [
"name",
"args",
"env",
"language",
"runtime",
"source"
]
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
GET /api/v1/modules
List modules
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
[
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
}
]
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
services
POST /api/v1/services
Create a service
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 201 Created
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"current_build": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"repository": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization_type": "string",
"license_info": "string",
"reseller_info": [
"string"
],
"groups": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"users": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"name": "string",
"password": "string",
"is_agent": true,
"organization": null,
"groups": null,
"invitation": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"group": null,
"organization": null,
"message": "string",
"user": null
},
"sessions": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"userAgent": "string",
"provider": "string",
"providerToken": "string",
"email": "string",
"user": null,
"token": "string",
"impersonator": "string",
"expiresAt": "string"
}
],
"status": "string",
"reset_at": "string",
"reset_password_token": "string"
}
],
"organization": null,
"permissions": [
"user#impersonate@any"
]
}
],
"applications": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"resources": [
{
"name": "string",
"schema": {}
}
],
"custom_resources": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"input": null,
"output": null,
"modules": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
}
],
"modules_metadata": {},
"schema": {}
}
],
"menus": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"placement": "string",
"application": null
},
"routes": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"method": "string",
"url": "string",
"path": "string",
"handler": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"current_build": null,
"previous_build": null,
"repository": null,
"volumes": null,
"volume_mounts": {},
"status": "string"
},
"application": null
}
],
"organization": null
}
]
},
"repository_type": "string",
"volume": null,
"default_branch": "string",
"branches": [
"string"
],
"tags": [
"string"
],
"build_settings": null,
"builds": null
},
"target": null,
"volume": null,
"status": "string",
"errors": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
]
},
"previous_build": null,
"repository": null,
"volumes": null,
"volume_mounts": {},
"status": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"current_build": {
"$ref": "#/components/schemas/Build"
},
"previous_build": {
"$ref": "#/components/schemas/Build"
},
"repository": {
"$ref": "#/components/schemas/Repository"
},
"volumes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Volume"
}
},
"volume_mounts": {
"type": "object"
},
"status": {
"type": "string"
}
},
"required": [
"repository"
]
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
PUT /api/v1/services
Update a service
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"current_build": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"repository": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization_type": "string",
"license_info": "string",
"reseller_info": [
"string"
],
"groups": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"users": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"name": "string",
"password": "string",
"is_agent": true,
"organization": null,
"groups": null,
"invitation": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"group": null,
"organization": null,
"message": "string",
"user": null
},
"sessions": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"userAgent": "string",
"provider": "string",
"providerToken": "string",
"email": "string",
"user": null,
"token": "string",
"impersonator": "string",
"expiresAt": "string"
}
],
"status": "string",
"reset_at": "string",
"reset_password_token": "string"
}
],
"organization": null,
"permissions": [
"user#impersonate@any"
]
}
],
"applications": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"resources": [
{
"name": "string",
"schema": {}
}
],
"custom_resources": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"input": null,
"output": null,
"modules": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
}
],
"modules_metadata": {},
"schema": {}
}
],
"menus": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"placement": "string",
"application": null
},
"routes": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"method": "string",
"url": "string",
"path": "string",
"handler": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"current_build": null,
"previous_build": null,
"repository": null,
"volumes": null,
"volume_mounts": {},
"status": "string"
},
"application": null
}
],
"organization": null
}
]
},
"repository_type": "string",
"volume": null,
"default_branch": "string",
"branches": [
"string"
],
"tags": [
"string"
],
"build_settings": null,
"builds": null
},
"target": null,
"volume": null,
"status": "string",
"errors": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
]
},
"previous_build": null,
"repository": null,
"volumes": null,
"volume_mounts": {},
"status": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"current_build": {
"$ref": "#/components/schemas/Build"
},
"previous_build": {
"$ref": "#/components/schemas/Build"
},
"repository": {
"$ref": "#/components/schemas/Repository"
},
"volumes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Volume"
}
},
"volume_mounts": {
"type": "object"
},
"status": {
"type": "string"
}
},
"required": [
"repository"
]
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
GET /api/v1/services
List services
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
[
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"current_build": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"repository": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization_type": "string",
"license_info": "string",
"reseller_info": [
"string"
],
"groups": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"users": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"name": "string",
"password": "string",
"is_agent": true,
"organization": null,
"groups": null,
"invitation": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"group": null,
"organization": null,
"message": "string",
"user": null
},
"sessions": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"userAgent": "string",
"provider": "string",
"providerToken": "string",
"email": "string",
"user": null,
"token": "string",
"impersonator": "string",
"expiresAt": "string"
}
],
"status": "string",
"reset_at": "string",
"reset_password_token": "string"
}
],
"organization": null,
"permissions": [
"user#impersonate@any"
]
}
],
"applications": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"resources": [
{
"name": "string",
"schema": {}
}
],
"custom_resources": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"input": null,
"output": null,
"modules": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
}
],
"modules_metadata": {},
"schema": {}
}
],
"menus": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"placement": "string",
"application": null
},
"routes": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"method": "string",
"url": "string",
"path": "string",
"handler": null,
"application": null
}
],
"organization": null
}
]
},
"repository_type": "string",
"volume": null,
"default_branch": "string",
"branches": [
"string"
],
"tags": [
"string"
],
"build_settings": null,
"builds": null
},
"target": null,
"volume": null,
"status": "string",
"errors": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
]
},
"previous_build": null,
"repository": null,
"volumes": null,
"volume_mounts": {},
"status": "string"
}
]
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
module-instances
POST /api/v1/module-instances
Create a module-instance
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 201 Created
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"module": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
},
"status": "string",
"stdout": [
"string"
],
"stderr": [
"string"
],
"time_spent": 10.12,
"errors": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"module": {
"$ref": "#/components/schemas/Module"
},
"status": {
"type": "string"
},
"stdout": {
"type": "array",
"items": {
"type": "string"
}
},
"stderr": {
"type": "array",
"items": {
"type": "string"
}
},
"time_spent": {
"type": "number"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Error"
}
}
},
"required": [
"module"
]
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
GET /api/v1/module-instances
List module-instances
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
[
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"module": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
},
"status": "string",
"stdout": [
"string"
],
"stderr": [
"string"
],
"time_spent": 10.12,
"errors": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
]
}
]
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
commands
POST /api/v1/commands
Create a command
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 201 Created
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"command_type": "string",
"command_context": null,
"status": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"command_type": {
"type": "string"
},
"command_context": {},
"status": {
"type": "string"
}
},
"required": [
"command_type"
]
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
GET /api/v1/commands
List commands
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
[
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"command_type": "string",
"command_context": null,
"status": "string"
}
]
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
resources
GET /api/v1/resources
List resources
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
applications
POST /api/v1/applications
Create a application
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 201 Created
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"resources": [
{
"name": "string",
"schema": {}
}
],
"custom_resources": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"input": null,
"output": null,
"modules": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
}
],
"modules_metadata": {},
"schema": {}
}
],
"menus": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"placement": "string",
"application": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"resources": null,
"custom_resources": null,
"menus": null,
"routes": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"method": "string",
"url": "string",
"path": "string",
"handler": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"current_build": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"repository": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization_type": "string",
"license_info": "string",
"reseller_info": [
"string"
],
"groups": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"users": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"name": "string",
"password": "string",
"is_agent": true,
"organization": null,
"groups": null,
"invitation": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"group": null,
"organization": null,
"message": "string",
"user": null
},
"sessions": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"userAgent": "string",
"provider": "string",
"providerToken": "string",
"email": "string",
"user": null,
"token": "string",
"impersonator": "string",
"expiresAt": "string"
}
],
"status": "string",
"reset_at": "string",
"reset_password_token": "string"
}
],
"organization": null,
"permissions": [
"user#impersonate@any"
]
}
],
"applications": null
},
"repository_type": "string",
"volume": null,
"default_branch": "string",
"branches": [
"string"
],
"tags": [
"string"
],
"build_settings": null,
"builds": null
},
"target": null,
"volume": null,
"status": "string",
"errors": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
]
},
"previous_build": null,
"repository": null,
"volumes": null,
"volume_mounts": {},
"status": "string"
},
"application": null
}
],
"organization": null
}
},
"routes": null,
"organization": null
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"resources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Resource"
}
},
"custom_resources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomResource"
}
},
"menus": {
"$ref": "#/components/schemas/Menu"
},
"routes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Route"
}
},
"organization": {
"$ref": "#/components/schemas/Organization"
}
}
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
PUT /api/v1/applications
Update a application
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"resources": [
{
"name": "string",
"schema": {}
}
],
"custom_resources": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"input": null,
"output": null,
"modules": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
}
],
"modules_metadata": {},
"schema": {}
}
],
"menus": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"placement": "string",
"application": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"resources": null,
"custom_resources": null,
"menus": null,
"routes": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"method": "string",
"url": "string",
"path": "string",
"handler": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"current_build": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"repository": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization_type": "string",
"license_info": "string",
"reseller_info": [
"string"
],
"groups": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"users": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"name": "string",
"password": "string",
"is_agent": true,
"organization": null,
"groups": null,
"invitation": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"group": null,
"organization": null,
"message": "string",
"user": null
},
"sessions": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"userAgent": "string",
"provider": "string",
"providerToken": "string",
"email": "string",
"user": null,
"token": "string",
"impersonator": "string",
"expiresAt": "string"
}
],
"status": "string",
"reset_at": "string",
"reset_password_token": "string"
}
],
"organization": null,
"permissions": [
"user#impersonate@any"
]
}
],
"applications": null
},
"repository_type": "string",
"volume": null,
"default_branch": "string",
"branches": [
"string"
],
"tags": [
"string"
],
"build_settings": null,
"builds": null
},
"target": null,
"volume": null,
"status": "string",
"errors": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
]
},
"previous_build": null,
"repository": null,
"volumes": null,
"volume_mounts": {},
"status": "string"
},
"application": null
}
],
"organization": null
}
},
"routes": null,
"organization": null
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"resources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Resource"
}
},
"custom_resources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomResource"
}
},
"menus": {
"$ref": "#/components/schemas/Menu"
},
"routes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Route"
}
},
"organization": {
"$ref": "#/components/schemas/Organization"
}
}
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
GET /api/v1/applications
List applications
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
[
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"resources": [
{
"name": "string",
"schema": {}
}
],
"custom_resources": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"input": null,
"output": null,
"modules": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
}
],
"modules_metadata": {},
"schema": {}
}
],
"menus": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"placement": "string",
"application": null
},
"routes": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"method": "string",
"url": "string",
"path": "string",
"handler": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"current_build": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"repository": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization_type": "string",
"license_info": "string",
"reseller_info": [
"string"
],
"groups": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"users": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"name": "string",
"password": "string",
"is_agent": true,
"organization": null,
"groups": null,
"invitation": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"group": null,
"organization": null,
"message": "string",
"user": null
},
"sessions": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"userAgent": "string",
"provider": "string",
"providerToken": "string",
"email": "string",
"user": null,
"token": "string",
"impersonator": "string",
"expiresAt": "string"
}
],
"status": "string",
"reset_at": "string",
"reset_password_token": "string"
}
],
"organization": null,
"permissions": [
"user#impersonate@any"
]
}
],
"applications": null
},
"repository_type": "string",
"volume": null,
"default_branch": "string",
"branches": [
"string"
],
"tags": [
"string"
],
"build_settings": null,
"builds": null
},
"target": null,
"volume": null,
"status": "string",
"errors": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
]
},
"previous_build": null,
"repository": null,
"volumes": null,
"volume_mounts": {},
"status": "string"
},
"application": null
}
],
"organization": null
}
]
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
menus
POST /api/v1/menus
Create a menu
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 201 Created
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"placement": "string",
"application": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"resources": [
{
"name": "string",
"schema": {}
}
],
"custom_resources": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"input": null,
"output": null,
"modules": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
}
],
"modules_metadata": {},
"schema": {}
}
],
"menus": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"placement": "string",
"application": null
},
"routes": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"method": "string",
"url": "string",
"path": "string",
"handler": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"current_build": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"repository": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization_type": "string",
"license_info": "string",
"reseller_info": [
"string"
],
"groups": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"users": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"name": "string",
"password": "string",
"is_agent": true,
"organization": null,
"groups": null,
"invitation": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"group": null,
"organization": null,
"message": "string",
"user": null
},
"sessions": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"userAgent": "string",
"provider": "string",
"providerToken": "string",
"email": "string",
"user": null,
"token": "string",
"impersonator": "string",
"expiresAt": "string"
}
],
"status": "string",
"reset_at": "string",
"reset_password_token": "string"
}
],
"organization": null,
"permissions": [
"user#impersonate@any"
]
}
],
"applications": null
},
"repository_type": "string",
"volume": null,
"default_branch": "string",
"branches": [
"string"
],
"tags": [
"string"
],
"build_settings": null,
"builds": null
},
"target": null,
"volume": null,
"status": "string",
"errors": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
]
},
"previous_build": null,
"repository": null,
"volumes": null,
"volume_mounts": {},
"status": "string"
},
"application": null
}
],
"organization": null
}
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"placement": {
"type": "string"
},
"application": {
"$ref": "#/components/schemas/Application"
}
}
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
PUT /api/v1/menus
Update a menu
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"placement": "string",
"application": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"resources": [
{
"name": "string",
"schema": {}
}
],
"custom_resources": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"input": null,
"output": null,
"modules": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
}
],
"modules_metadata": {},
"schema": {}
}
],
"menus": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"placement": "string",
"application": null
},
"routes": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"method": "string",
"url": "string",
"path": "string",
"handler": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"current_build": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"repository": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization_type": "string",
"license_info": "string",
"reseller_info": [
"string"
],
"groups": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"users": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"name": "string",
"password": "string",
"is_agent": true,
"organization": null,
"groups": null,
"invitation": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"group": null,
"organization": null,
"message": "string",
"user": null
},
"sessions": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"userAgent": "string",
"provider": "string",
"providerToken": "string",
"email": "string",
"user": null,
"token": "string",
"impersonator": "string",
"expiresAt": "string"
}
],
"status": "string",
"reset_at": "string",
"reset_password_token": "string"
}
],
"organization": null,
"permissions": [
"user#impersonate@any"
]
}
],
"applications": null
},
"repository_type": "string",
"volume": null,
"default_branch": "string",
"branches": [
"string"
],
"tags": [
"string"
],
"build_settings": null,
"builds": null
},
"target": null,
"volume": null,
"status": "string",
"errors": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
]
},
"previous_build": null,
"repository": null,
"volumes": null,
"volume_mounts": {},
"status": "string"
},
"application": null
}
],
"organization": null
}
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"placement": {
"type": "string"
},
"application": {
"$ref": "#/components/schemas/Application"
}
}
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
GET /api/v1/menus
List menus
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
[
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"placement": "string",
"application": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"resources": [
{
"name": "string",
"schema": {}
}
],
"custom_resources": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"input": null,
"output": null,
"modules": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
}
],
"modules_metadata": {},
"schema": {}
}
],
"menus": null,
"routes": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"method": "string",
"url": "string",
"path": "string",
"handler": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"current_build": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"repository": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization_type": "string",
"license_info": "string",
"reseller_info": [
"string"
],
"groups": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"users": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"name": "string",
"password": "string",
"is_agent": true,
"organization": null,
"groups": null,
"invitation": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"group": null,
"organization": null,
"message": "string",
"user": null
},
"sessions": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"userAgent": "string",
"provider": "string",
"providerToken": "string",
"email": "string",
"user": null,
"token": "string",
"impersonator": "string",
"expiresAt": "string"
}
],
"status": "string",
"reset_at": "string",
"reset_password_token": "string"
}
],
"organization": null,
"permissions": [
"user#impersonate@any"
]
}
],
"applications": null
},
"repository_type": "string",
"volume": null,
"default_branch": "string",
"branches": [
"string"
],
"tags": [
"string"
],
"build_settings": null,
"builds": null
},
"target": null,
"volume": null,
"status": "string",
"errors": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
]
},
"previous_build": null,
"repository": null,
"volumes": null,
"volume_mounts": {},
"status": "string"
},
"application": null
}
],
"organization": null
}
}
]
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
routes
POST /api/v1/routes
Create a route
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 201 Created
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"method": "string",
"url": "string",
"path": "string",
"handler": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"current_build": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"repository": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization_type": "string",
"license_info": "string",
"reseller_info": [
"string"
],
"groups": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"users": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"name": "string",
"password": "string",
"is_agent": true,
"organization": null,
"groups": null,
"invitation": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"group": null,
"organization": null,
"message": "string",
"user": null
},
"sessions": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"userAgent": "string",
"provider": "string",
"providerToken": "string",
"email": "string",
"user": null,
"token": "string",
"impersonator": "string",
"expiresAt": "string"
}
],
"status": "string",
"reset_at": "string",
"reset_password_token": "string"
}
],
"organization": null,
"permissions": [
"user#impersonate@any"
]
}
],
"applications": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"resources": [
{
"name": "string",
"schema": {}
}
],
"custom_resources": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"input": null,
"output": null,
"modules": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
}
],
"modules_metadata": {},
"schema": {}
}
],
"menus": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"placement": "string",
"application": null
},
"routes": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"method": "string",
"url": "string",
"path": "string",
"handler": null,
"application": null
}
],
"organization": null
}
]
},
"repository_type": "string",
"volume": null,
"default_branch": "string",
"branches": [
"string"
],
"tags": [
"string"
],
"build_settings": null,
"builds": null
},
"target": null,
"volume": null,
"status": "string",
"errors": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
]
},
"previous_build": null,
"repository": null,
"volumes": null,
"volume_mounts": {},
"status": "string"
},
"application": null
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"method": {
"type": "string"
},
"url": {
"type": "string"
},
"path": {
"type": "string"
},
"handler": {
"$ref": "#/components/schemas/Service"
},
"application": {
"$ref": "#/components/schemas/Application"
}
},
"required": [
"method",
"path",
"handler",
"application"
]
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
PUT /api/v1/routes
Update a route
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"method": "string",
"url": "string",
"path": "string",
"handler": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"current_build": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"repository": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization_type": "string",
"license_info": "string",
"reseller_info": [
"string"
],
"groups": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"users": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"name": "string",
"password": "string",
"is_agent": true,
"organization": null,
"groups": null,
"invitation": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"group": null,
"organization": null,
"message": "string",
"user": null
},
"sessions": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"userAgent": "string",
"provider": "string",
"providerToken": "string",
"email": "string",
"user": null,
"token": "string",
"impersonator": "string",
"expiresAt": "string"
}
],
"status": "string",
"reset_at": "string",
"reset_password_token": "string"
}
],
"organization": null,
"permissions": [
"user#impersonate@any"
]
}
],
"applications": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"resources": [
{
"name": "string",
"schema": {}
}
],
"custom_resources": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"input": null,
"output": null,
"modules": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
}
],
"modules_metadata": {},
"schema": {}
}
],
"menus": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"placement": "string",
"application": null
},
"routes": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"method": "string",
"url": "string",
"path": "string",
"handler": null,
"application": null
}
],
"organization": null
}
]
},
"repository_type": "string",
"volume": null,
"default_branch": "string",
"branches": [
"string"
],
"tags": [
"string"
],
"build_settings": null,
"builds": null
},
"target": null,
"volume": null,
"status": "string",
"errors": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
]
},
"previous_build": null,
"repository": null,
"volumes": null,
"volume_mounts": {},
"status": "string"
},
"application": null
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"method": {
"type": "string"
},
"url": {
"type": "string"
},
"path": {
"type": "string"
},
"handler": {
"$ref": "#/components/schemas/Service"
},
"application": {
"$ref": "#/components/schemas/Application"
}
},
"required": [
"method",
"path",
"handler",
"application"
]
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
GET /api/v1/routes
List routes
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
[
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"method": "string",
"url": "string",
"path": "string",
"handler": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"current_build": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"repository": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization_type": "string",
"license_info": "string",
"reseller_info": [
"string"
],
"groups": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"users": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"name": "string",
"password": "string",
"is_agent": true,
"organization": null,
"groups": null,
"invitation": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"group": null,
"organization": null,
"message": "string",
"user": null
},
"sessions": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"userAgent": "string",
"provider": "string",
"providerToken": "string",
"email": "string",
"user": null,
"token": "string",
"impersonator": "string",
"expiresAt": "string"
}
],
"status": "string",
"reset_at": "string",
"reset_password_token": "string"
}
],
"organization": null,
"permissions": [
"user#impersonate@any"
]
}
],
"applications": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"resources": [
{
"name": "string",
"schema": {}
}
],
"custom_resources": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"input": null,
"output": null,
"modules": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
}
],
"modules_metadata": {},
"schema": {}
}
],
"menus": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"placement": "string",
"application": null
},
"routes": null,
"organization": null
}
]
},
"repository_type": "string",
"volume": null,
"default_branch": "string",
"branches": [
"string"
],
"tags": [
"string"
],
"build_settings": null,
"builds": null
},
"target": null,
"volume": null,
"status": "string",
"errors": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
]
},
"previous_build": null,
"repository": null,
"volumes": null,
"volume_mounts": {},
"status": "string"
},
"application": null
}
]
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
locales
POST /api/v1/locales
Create a locale
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 201 Created
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"lang": "string",
"translation": {}
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"lang": {
"type": "string"
},
"translation": {
"type": "object"
}
}
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
PUT /api/v1/locales
Update a locale
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"lang": "string",
"translation": {}
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"lang": {
"type": "string"
},
"translation": {
"type": "object"
}
}
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
GET /api/v1/locales
List locales
Response 200 OK
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
files
POST /api/v1/files
Create a file
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 201 Created
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": null
}
]
}
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"content": {
"type": "string"
},
"volume": {
"$ref": "#/components/schemas/Volume"
}
},
"required": [
"name",
"volume"
]
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
PUT /api/v1/files
Update a file
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": null
}
]
}
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"content": {
"type": "string"
},
"volume": {
"$ref": "#/components/schemas/Volume"
}
},
"required": [
"name",
"volume"
]
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
GET /api/v1/files
List files
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
[
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
}
]
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
volumes
POST /api/v1/volumes
Create a volume
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 201 Created
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": null
}
]
},
"files": null
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"storage_type": {
"type": "string"
},
"storage_type_metadata": {
"type": "object"
},
"status": {
"type": "string"
},
"readonly": {
"type": "boolean"
},
"from": {
"$ref": "#/components/schemas/Volume"
},
"files": {
"type": "array",
"items": {
"$ref": "#/components/schemas/File"
}
}
},
"required": [
"name",
"storage_type",
"status"
]
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
PUT /api/v1/volumes
Update a volume
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": null
}
]
},
"files": null
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"storage_type": {
"type": "string"
},
"storage_type_metadata": {
"type": "object"
},
"status": {
"type": "string"
},
"readonly": {
"type": "boolean"
},
"from": {
"$ref": "#/components/schemas/Volume"
},
"files": {
"type": "array",
"items": {
"$ref": "#/components/schemas/File"
}
}
},
"required": [
"name",
"storage_type",
"status"
]
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
GET /api/v1/volumes
List volumes
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
[
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": null
}
]
}
]
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
repositories
POST /api/v1/repositories
Create a repository
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 201 Created
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization_type": "string",
"license_info": "string",
"reseller_info": [
"string"
],
"groups": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"users": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"name": "string",
"password": "string",
"is_agent": true,
"organization": null,
"groups": null,
"invitation": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"group": null,
"organization": null,
"message": "string",
"user": null
},
"sessions": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"userAgent": "string",
"provider": "string",
"providerToken": "string",
"email": "string",
"user": null,
"token": "string",
"impersonator": "string",
"expiresAt": "string"
}
],
"status": "string",
"reset_at": "string",
"reset_password_token": "string"
}
],
"organization": null,
"permissions": [
"user#impersonate@any"
]
}
],
"applications": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"resources": [
{
"name": "string",
"schema": {}
}
],
"custom_resources": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"input": null,
"output": null,
"modules": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
}
],
"modules_metadata": {},
"schema": {}
}
],
"menus": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"placement": "string",
"application": null
},
"routes": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"method": "string",
"url": "string",
"path": "string",
"handler": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"current_build": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"repository": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization": null,
"repository_type": "string",
"volume": null,
"default_branch": "string",
"branches": [
"string"
],
"tags": [
"string"
],
"build_settings": null,
"builds": null
},
"target": null,
"volume": null,
"status": "string",
"errors": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
]
},
"previous_build": null,
"repository": null,
"volumes": null,
"volume_mounts": {},
"status": "string"
},
"application": null
}
],
"organization": null
}
]
},
"repository_type": "string",
"volume": null,
"default_branch": "string",
"branches": [
"string"
],
"tags": [
"string"
],
"build_settings": null,
"builds": null
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"organization": {
"$ref": "#/components/schemas/Organization"
},
"repository_type": {
"type": "string"
},
"volume": {
"$ref": "#/components/schemas/Volume"
},
"default_branch": {
"type": "string"
},
"branches": {
"type": "array",
"items": {
"type": "string"
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"build_settings": {},
"builds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Build"
}
}
},
"required": [
"name",
"organization",
"repository_type",
"volume",
"default_branch"
]
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
PUT /api/v1/repositories
Update a repository
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization_type": "string",
"license_info": "string",
"reseller_info": [
"string"
],
"groups": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"users": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"name": "string",
"password": "string",
"is_agent": true,
"organization": null,
"groups": null,
"invitation": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"group": null,
"organization": null,
"message": "string",
"user": null
},
"sessions": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"userAgent": "string",
"provider": "string",
"providerToken": "string",
"email": "string",
"user": null,
"token": "string",
"impersonator": "string",
"expiresAt": "string"
}
],
"status": "string",
"reset_at": "string",
"reset_password_token": "string"
}
],
"organization": null,
"permissions": [
"user#impersonate@any"
]
}
],
"applications": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"resources": [
{
"name": "string",
"schema": {}
}
],
"custom_resources": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"input": null,
"output": null,
"modules": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
}
],
"modules_metadata": {},
"schema": {}
}
],
"menus": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"placement": "string",
"application": null
},
"routes": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"method": "string",
"url": "string",
"path": "string",
"handler": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"current_build": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"repository": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization": null,
"repository_type": "string",
"volume": null,
"default_branch": "string",
"branches": [
"string"
],
"tags": [
"string"
],
"build_settings": null,
"builds": null
},
"target": null,
"volume": null,
"status": "string",
"errors": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
]
},
"previous_build": null,
"repository": null,
"volumes": null,
"volume_mounts": {},
"status": "string"
},
"application": null
}
],
"organization": null
}
]
},
"repository_type": "string",
"volume": null,
"default_branch": "string",
"branches": [
"string"
],
"tags": [
"string"
],
"build_settings": null,
"builds": null
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"organization": {
"$ref": "#/components/schemas/Organization"
},
"repository_type": {
"type": "string"
},
"volume": {
"$ref": "#/components/schemas/Volume"
},
"default_branch": {
"type": "string"
},
"branches": {
"type": "array",
"items": {
"type": "string"
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"build_settings": {},
"builds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Build"
}
}
},
"required": [
"name",
"organization",
"repository_type",
"volume",
"default_branch"
]
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
GET /api/v1/repositories
List repositories
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
[
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization_type": "string",
"license_info": "string",
"reseller_info": [
"string"
],
"groups": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"users": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"name": "string",
"password": "string",
"is_agent": true,
"organization": null,
"groups": null,
"invitation": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"group": null,
"organization": null,
"message": "string",
"user": null
},
"sessions": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"userAgent": "string",
"provider": "string",
"providerToken": "string",
"email": "string",
"user": null,
"token": "string",
"impersonator": "string",
"expiresAt": "string"
}
],
"status": "string",
"reset_at": "string",
"reset_password_token": "string"
}
],
"organization": null,
"permissions": [
"user#impersonate@any"
]
}
],
"applications": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"resources": [
{
"name": "string",
"schema": {}
}
],
"custom_resources": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"input": null,
"output": null,
"modules": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
}
],
"modules_metadata": {},
"schema": {}
}
],
"menus": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"placement": "string",
"application": null
},
"routes": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"method": "string",
"url": "string",
"path": "string",
"handler": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"current_build": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"repository": null,
"target": null,
"volume": null,
"status": "string",
"errors": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
]
},
"previous_build": null,
"repository": null,
"volumes": null,
"volume_mounts": {},
"status": "string"
},
"application": null
}
],
"organization": null
}
]
},
"repository_type": "string",
"volume": null,
"default_branch": "string",
"branches": [
"string"
],
"tags": [
"string"
],
"build_settings": null,
"builds": null
}
]
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
custom-resources
POST /api/v1/custom-resources
Create a custom-resource
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 201 Created
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"input": null,
"output": null,
"modules": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
}
],
"modules_metadata": {},
"schema": {}
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"input": {},
"output": {},
"modules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Module"
}
},
"modules_metadata": {
"type": "object"
},
"schema": {
"type": "object"
}
}
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
PUT /api/v1/custom-resources
Update a custom-resource
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"input": null,
"output": null,
"modules": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
}
],
"modules_metadata": {},
"schema": {}
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"input": {},
"output": {},
"modules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Module"
}
},
"modules_metadata": {
"type": "object"
},
"schema": {
"type": "object"
}
}
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
GET /api/v1/custom-resources
List custom-resources
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
[
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"input": null,
"output": null,
"modules": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
}
],
"modules_metadata": {},
"schema": {}
}
]
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
custom-elements
POST /api/v1/custom-elements
Create a custom-element
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 201 Created
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"designer_ast": {}
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"designer_ast": {
"type": "object"
}
}
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
PUT /api/v1/custom-elements
Update a custom-element
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"designer_ast": {}
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"designer_ast": {
"type": "object"
}
}
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
GET /api/v1/custom-elements
List custom-elements
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
builds
POST /api/v1/builds
Create a build
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 201 Created
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"repository": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization_type": "string",
"license_info": "string",
"reseller_info": [
"string"
],
"groups": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"users": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"name": "string",
"password": "string",
"is_agent": true,
"organization": null,
"groups": null,
"invitation": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"group": null,
"organization": null,
"message": "string",
"user": null
},
"sessions": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"userAgent": "string",
"provider": "string",
"providerToken": "string",
"email": "string",
"user": null,
"token": "string",
"impersonator": "string",
"expiresAt": "string"
}
],
"status": "string",
"reset_at": "string",
"reset_password_token": "string"
}
],
"organization": null,
"permissions": [
"user#impersonate@any"
]
}
],
"applications": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"resources": [
{
"name": "string",
"schema": {}
}
],
"custom_resources": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"input": null,
"output": null,
"modules": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
}
],
"modules_metadata": {},
"schema": {}
}
],
"menus": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"placement": "string",
"application": null
},
"routes": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"method": "string",
"url": "string",
"path": "string",
"handler": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"current_build": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"repository": null,
"target": null,
"volume": null,
"status": "string",
"errors": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
]
},
"previous_build": null,
"repository": null,
"volumes": null,
"volume_mounts": {},
"status": "string"
},
"application": null
}
],
"organization": null
}
]
},
"repository_type": "string",
"volume": null,
"default_branch": "string",
"branches": [
"string"
],
"tags": [
"string"
],
"build_settings": null,
"builds": null
},
"target": null,
"volume": null,
"status": "string",
"errors": null
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"repository": {
"$ref": "#/components/schemas/Repository"
},
"target": {
"$ref": "#/components/schemas/Module"
},
"volume": {
"$ref": "#/components/schemas/Volume"
},
"status": {
"type": "string"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Error"
}
}
},
"required": [
"repository",
"volume"
]
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
PUT /api/v1/builds
Update a build
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"repository": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization_type": "string",
"license_info": "string",
"reseller_info": [
"string"
],
"groups": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"users": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"name": "string",
"password": "string",
"is_agent": true,
"organization": null,
"groups": null,
"invitation": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"group": null,
"organization": null,
"message": "string",
"user": null
},
"sessions": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"userAgent": "string",
"provider": "string",
"providerToken": "string",
"email": "string",
"user": null,
"token": "string",
"impersonator": "string",
"expiresAt": "string"
}
],
"status": "string",
"reset_at": "string",
"reset_password_token": "string"
}
],
"organization": null,
"permissions": [
"user#impersonate@any"
]
}
],
"applications": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"resources": [
{
"name": "string",
"schema": {}
}
],
"custom_resources": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"input": null,
"output": null,
"modules": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
}
],
"modules_metadata": {},
"schema": {}
}
],
"menus": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"placement": "string",
"application": null
},
"routes": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"method": "string",
"url": "string",
"path": "string",
"handler": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"current_build": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"repository": null,
"target": null,
"volume": null,
"status": "string",
"errors": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
]
},
"previous_build": null,
"repository": null,
"volumes": null,
"volume_mounts": {},
"status": "string"
},
"application": null
}
],
"organization": null
}
]
},
"repository_type": "string",
"volume": null,
"default_branch": "string",
"branches": [
"string"
],
"tags": [
"string"
],
"build_settings": null,
"builds": null
},
"target": null,
"volume": null,
"status": "string",
"errors": null
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"repository": {
"$ref": "#/components/schemas/Repository"
},
"target": {
"$ref": "#/components/schemas/Module"
},
"volume": {
"$ref": "#/components/schemas/Volume"
},
"status": {
"type": "string"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Error"
}
}
},
"required": [
"repository",
"volume"
]
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
GET /api/v1/builds
List builds
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
[
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"repository": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"organization_type": "string",
"license_info": "string",
"reseller_info": [
"string"
],
"groups": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"users": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"name": "string",
"password": "string",
"is_agent": true,
"organization": null,
"groups": null,
"invitation": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"email": "string",
"group": null,
"organization": null,
"message": "string",
"user": null
},
"sessions": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"userAgent": "string",
"provider": "string",
"providerToken": "string",
"email": "string",
"user": null,
"token": "string",
"impersonator": "string",
"expiresAt": "string"
}
],
"status": "string",
"reset_at": "string",
"reset_password_token": "string"
}
],
"organization": null,
"permissions": [
"user#impersonate@any"
]
}
],
"applications": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"resources": [
{
"name": "string",
"schema": {}
}
],
"custom_resources": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"input": null,
"output": null,
"modules": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
}
],
"modules_metadata": {},
"schema": {}
}
],
"menus": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"placement": "string",
"application": null
},
"routes": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"method": "string",
"url": "string",
"path": "string",
"handler": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"current_build": null,
"previous_build": null,
"repository": null,
"volumes": null,
"volume_mounts": {},
"status": "string"
},
"application": null
}
],
"organization": null
}
]
},
"repository_type": "string",
"volume": null,
"default_branch": "string",
"branches": [
"string"
],
"tags": [
"string"
],
"build_settings": null,
"builds": null
},
"target": null,
"volume": null,
"status": "string",
"errors": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
]
}
]
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
repls
POST /api/v1/repls
Create a repl
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 201 Created
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"module": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
},
"instance": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"module": null,
"status": "string",
"stdout": [
"string"
],
"stderr": [
"string"
],
"time_spent": 10.12,
"errors": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
]
},
"status": "string",
"stdout": "string",
"stderr": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"module": {
"$ref": "#/components/schemas/Module"
},
"instance": {
"$ref": "#/components/schemas/ModuleInstance"
},
"status": {
"type": "string"
},
"stdout": {
"type": "string"
},
"stderr": {
"type": "string"
}
},
"required": [
"module",
"instance"
]
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
PUT /api/v1/repls
Update a repl
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"module": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
},
"instance": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"module": null,
"status": "string",
"stdout": [
"string"
],
"stderr": [
"string"
],
"time_spent": 10.12,
"errors": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
]
},
"status": "string",
"stdout": "string",
"stderr": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"module": {
"$ref": "#/components/schemas/Module"
},
"instance": {
"$ref": "#/components/schemas/ModuleInstance"
},
"status": {
"type": "string"
},
"stdout": {
"type": "string"
},
"stderr": {
"type": "string"
}
},
"required": [
"module",
"instance"
]
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
GET /api/v1/repls
List repls
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
[
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"module": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
},
"instance": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"module": null,
"status": "string",
"stdout": [
"string"
],
"stderr": [
"string"
],
"time_spent": 10.12,
"errors": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
]
},
"status": "string",
"stdout": "string",
"stderr": "string"
}
]
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
repl-events
POST /api/v1/repl-events
Create a repl-event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 201 Created
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"repl": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"module": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
},
"instance": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"module": null,
"status": "string",
"stdout": [
"string"
],
"stderr": [
"string"
],
"time_spent": 10.12,
"errors": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
]
},
"status": "string",
"stdout": "string",
"stderr": "string"
},
"sender": "string",
"payload": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"repl": {
"$ref": "#/components/schemas/Repl"
},
"sender": {
"type": "string"
},
"payload": {
"type": "string"
}
},
"required": [
"repl",
"sender",
"payload"
]
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
PUT /api/v1/repl-events
Update a repl-event
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"repl": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"module": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
},
"instance": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"module": null,
"status": "string",
"stdout": [
"string"
],
"stderr": [
"string"
],
"time_spent": 10.12,
"errors": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
]
},
"status": "string",
"stdout": "string",
"stderr": "string"
},
"sender": "string",
"payload": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"repl": {
"$ref": "#/components/schemas/Repl"
},
"sender": {
"type": "string"
},
"payload": {
"type": "string"
}
},
"required": [
"repl",
"sender",
"payload"
]
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
GET /api/v1/repl-events
List repl-events
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
[
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"repl": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"module": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"status": "string",
"args": [
"string"
],
"env": [
null
],
"language": "string",
"runtime": "string",
"compiler": null,
"source": "string",
"sourceMap": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"content": "string",
"volume": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"storage_type": "string",
"storage_type_metadata": {},
"status": "string",
"readonly": true,
"from": null,
"files": null
}
},
"ast": {},
"wasm": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
},
"instance": {
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"module": null,
"status": "string",
"stdout": [
"string"
],
"stderr": [
"string"
],
"time_spent": 10.12,
"errors": [
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
]
},
"status": "string",
"stdout": "string",
"stderr": "string"
},
"sender": "string",
"payload": "string"
}
]
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
calls
POST /api/v1/calls
Create a call
Response 201 Created
{
"type": "string",
"name": "string",
"static": true,
"resource_id": "string",
"args": [
{}
],
"stream": null,
"chunk": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ=",
"status": "string",
"ended": true,
"result_type": "string",
"result": {}
}
Schema of the response body
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"name": {
"type": "string"
},
"static": {
"type": "boolean"
},
"resource_id": {
"type": "string"
},
"args": {
"type": "array",
"items": {
"type": "object"
}
},
"stream": {},
"chunk": {
"type": "string",
"format": "byte"
},
"status": {
"type": "string"
},
"ended": {
"type": "boolean"
},
"result_type": {
"type": "string"
},
"result": {
"type": "object"
}
},
"required": [
"status"
]
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
PUT /api/v1/calls
Update a call
Response 200 OK
{
"type": "string",
"name": "string",
"static": true,
"resource_id": "string",
"args": [
{}
],
"stream": null,
"chunk": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ=",
"status": "string",
"ended": true,
"result_type": "string",
"result": {}
}
Schema of the response body
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"name": {
"type": "string"
},
"static": {
"type": "boolean"
},
"resource_id": {
"type": "string"
},
"args": {
"type": "array",
"items": {
"type": "object"
}
},
"stream": {},
"chunk": {
"type": "string",
"format": "byte"
},
"status": {
"type": "string"
},
"ended": {
"type": "boolean"
},
"result_type": {
"type": "string"
},
"result": {
"type": "object"
}
},
"required": [
"status"
]
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
GET /api/v1/calls
List calls
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
[
{
"type": "string",
"name": "string",
"static": true,
"resource_id": "string",
"args": [
{}
],
"stream": null,
"chunk": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ=",
"status": "string",
"ended": true,
"result_type": "string",
"result": {}
}
]
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
flow-graphs
POST /api/v1/flow-graphs
Create a flow-graph
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 201 Created
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"graph": {},
"nodes": [
{}
],
"edges": [
{}
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"graph": {
"type": "object"
},
"nodes": {
"type": "array",
"items": {
"type": "object"
}
},
"edges": {
"type": "array",
"items": {
"type": "object"
}
}
}
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
PUT /api/v1/flow-graphs
Update a flow-graph
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"name": "string",
"graph": {},
"nodes": [
{}
],
"edges": [
{}
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"graph": {
"type": "object"
},
"nodes": {
"type": "array",
"items": {
"type": "object"
}
},
"edges": {
"type": "array",
"items": {
"type": "object"
}
}
}
}
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
GET /api/v1/flow-graphs
List flow-graphs
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key |
Response 200 OK
Other responses
{
"createdAt": "string",
"updatedAt": "string",
"owner": "string",
"ownerGroups": [
"string"
],
"message": "string",
"additional_data": null,
"tags": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"owner": {
"type": "string"
},
"ownerGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"additional_data": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
Schemas
Application
| Name | Type |
|---|---|
createdAt |
string(datetime) |
custom_resources |
Array<CustomResource> |
menus |
Menu |
name |
string |
organization |
Organization |
owner |
string |
ownerGroups |
Array<string> |
resources |
Array<Resource> |
routes |
Array<Route> |
updatedAt |
string(datetime) |
AuditItem
| Name | Type |
|---|---|
createdAt |
string(datetime) |
data |
|
name |
string |
owner |
string |
ownerGroups |
Array<string> |
recordId |
string |
recordType |
string |
updatedAt |
string(datetime) |
Badge
| Name | Type |
|---|---|
client |
Client |
createdAt |
string(datetime) |
current_borne |
Borne |
fields |
Array<> |
immatriculation |
string |
last_activity |
string(datetime) |
name |
string |
owner |
string |
ownerGroups |
Array<string> |
pesees |
Array<Pesee> |
rfid |
string |
status |
string |
updatedAt |
string(datetime) |
Bascule
| Name | Type |
|---|---|
bornes |
Array<Borne> |
brut |
number |
createdAt |
string(datetime) |
date_dsd |
string(datetime) |
dsd |
string |
dsd_log |
Array<Dsd> |
enabled |
boolean |
ip_address |
string |
name |
string |
owner |
string |
ownerGroups |
Array<string> |
poids_dsd |
number |
updatedAt |
string(datetime) |
BatchDownload
| Name | Type |
|---|---|
action_context |
|
action_type |
string |
createdAt |
string(datetime) |
download_url |
string |
files |
Array<> |
owner |
string |
ownerGroups |
Array<string> |
status |
string |
updatedAt |
string(datetime) |
Borne
| Name | Type |
|---|---|
badge_code |
string |
badge_rfid |
string |
bascule |
Bascule |
createdAt |
string(datetime) |
current_badge |
Badge |
custom_commands |
Array<> |
cycle_old |
string |
cycle_pesage |
string |
dsd |
string |
entry_enabled |
boolean |
entry_form_schema |
FormSchema |
entry_ticket_enabled |
boolean |
erreur |
string |
exit_enabled |
boolean |
exit_form_schema |
FormSchema |
exit_ticket_enabled |
boolean |
first_date |
number |
ip_address |
string |
last_date |
string(datetime) |
lcd1 |
string |
lcd2 |
string |
mac_address |
string |
minimum_ticket_lines |
number |
name |
string |
nb_fic |
number |
owner |
string |
ownerGroups |
Array<string> |
pending_commands |
Array<> |
poids_dsd |
number |
timezone |
string |
transactional_data |
|
updatedAt |
string(datetime) |
Build
| Name | Type |
|---|---|
createdAt |
string(datetime) |
errors |
Array<Error> |
owner |
string |
ownerGroups |
Array<string> |
repository |
Repository |
status |
string |
target |
Module |
updatedAt |
string(datetime) |
volume |
Volume |
Call
| Name | Type |
|---|---|
args |
Array<> |
chunk |
string(byte) |
ended |
boolean |
name |
string |
resource_id |
string |
result |
|
result_type |
string |
static |
boolean |
status |
string |
stream |
|
type |
string |
Client
| Name | Type |
|---|---|
address |
string |
badges |
Array<Badge> |
contact_details |
|
createdAt |
string(datetime) |
fields |
Array<> |
name |
string |
owner |
string |
ownerGroups |
Array<string> |
status |
string |
updatedAt |
string(datetime) |
Command
| Name | Type |
|---|---|
command_context |
|
command_type |
string |
createdAt |
string(datetime) |
owner |
string |
ownerGroups |
Array<string> |
status |
string |
updatedAt |
string(datetime) |
CustomElement
| Name | Type |
|---|---|
createdAt |
string(datetime) |
designer_ast |
|
name |
string |
owner |
string |
ownerGroups |
Array<string> |
updatedAt |
string(datetime) |
CustomResource
| Name | Type |
|---|---|
createdAt |
string(datetime) |
input |
|
modules |
Array<Module> |
modules_metadata |
|
name |
string |
output |
|
owner |
string |
ownerGroups |
Array<string> |
schema |
|
updatedAt |
string(datetime) |
Dsd
| Name | Type |
|---|---|
bascule |
Bascule |
brut |
number |
createdAt |
string(datetime) |
date_dsd |
string(datetime) |
dsd |
string |
owner |
string |
ownerGroups |
Array<string> |
poids_dsd |
number |
updatedAt |
string(datetime) |
Error
| Name | Type |
|---|---|
additional_data |
|
createdAt |
string(datetime) |
message |
string |
owner |
string |
ownerGroups |
Array<string> |
tags |
Array<string> |
updatedAt |
string(datetime) |
File
| Name | Type |
|---|---|
content |
string |
createdAt |
string(datetime) |
name |
string |
owner |
string |
ownerGroups |
Array<string> |
updatedAt |
string(datetime) |
volume |
Volume |
FlowGraph
| Name | Type |
|---|---|
createdAt |
string(datetime) |
edges |
Array<> |
graph |
|
name |
string |
nodes |
Array<> |
owner |
string |
ownerGroups |
Array<string> |
updatedAt |
string(datetime) |
FormSchema
| Name | Type |
|---|---|
applies_to |
Array<string> |
createdAt |
string(datetime) |
fields |
Array<> |
name |
string |
owner |
string |
ownerGroups |
Array<string> |
ticket_template |
string |
updatedAt |
string(datetime) |
Group
| Name | Type |
|---|---|
createdAt |
string(datetime) |
name |
string |
organization |
Organization |
owner |
string |
ownerGroups |
Array<string> |
permissions |
Array<GroupPermissions> |
updatedAt |
string(datetime) |
users |
Array<User> |
GroupPermissions
Type: string
Invitation
| Name | Type |
|---|---|
createdAt |
string(datetime) |
email |
string |
group |
Group |
message |
string |
organization |
Organization |
owner |
string |
ownerGroups |
Array<string> |
updatedAt |
string(datetime) |
user |
User |
JournalPesee
| Name | Type |
|---|---|
borne |
Borne |
brut |
number |
createdAt |
string(datetime) |
date_dsd |
string(datetime) |
dsd |
string |
fields |
Array<> |
owner |
string |
ownerGroups |
Array<string> |
pesee |
Pesee |
pesee_type |
string |
ptac |
number |
status |
string |
updatedAt |
string(datetime) |
Locale
| Name | Type |
|---|---|
createdAt |
string(datetime) |
lang |
string |
owner |
string |
ownerGroups |
Array<string> |
translation |
|
updatedAt |
string(datetime) |
Menu
| Name | Type |
|---|---|
application |
Application |
createdAt |
string(datetime) |
name |
string |
owner |
string |
ownerGroups |
Array<string> |
placement |
string |
updatedAt |
string(datetime) |
Module
| Name | Type |
|---|---|
args |
Array<string> |
ast |
|
compiler |
Module |
createdAt |
string(datetime) |
env |
Array<> |
language |
string |
name |
string |
owner |
string |
ownerGroups |
Array<string> |
runtime |
string |
source |
string |
sourceMap |
File |
status |
string |
updatedAt |
string(datetime) |
wasm |
string(byte) |
ModuleInstance
| Name | Type |
|---|---|
createdAt |
string(datetime) |
errors |
Array<Error> |
module |
Module |
owner |
string |
ownerGroups |
Array<string> |
status |
string |
stderr |
Array<string> |
stdout |
Array<string> |
time_spent |
number |
updatedAt |
string(datetime) |
Option
| Name | Type |
|---|---|
code |
string |
code_id |
OptionCode |
createdAt |
string(datetime) |
fields |
Array<> |
option_list |
OptionList |
owner |
string |
ownerGroups |
Array<string> |
updatedAt |
string(datetime) |
value |
string |
OptionCode
| Name | Type |
|---|---|
code |
string |
createdAt |
string(datetime) |
option |
Option |
owner |
string |
ownerGroups |
Array<string> |
updatedAt |
string(datetime) |
OptionList
| Name | Type |
|---|---|
createdAt |
string(datetime) |
data_type |
string |
name |
string |
options |
Array<Option> |
owner |
string |
ownerGroups |
Array<string> |
updatedAt |
string(datetime) |
Organization
| Name | Type |
|---|---|
applications |
Array<Application> |
createdAt |
string(datetime) |
groups |
Array<Group> |
license_info |
string |
name |
string |
organization_type |
string |
owner |
string |
ownerGroups |
Array<string> |
reseller_info |
Array<string> |
updatedAt |
string(datetime) |
Pesee
| Name | Type |
|---|---|
badge |
Badge |
brut |
number |
client |
Client |
completed_at |
string(datetime) |
completion_reason |
string |
createdAt |
string(datetime) |
detail |
string |
entries |
Array<JournalPesee> |
entry_schema |
FormSchema |
exit_schema |
FormSchema |
fields |
Array<> |
immatriculation |
string |
mode |
string |
net |
number |
num_pesee |
string |
observation |
string |
order_value |
number |
owner |
string |
ownerGroups |
Array<string> |
pesee_type |
string |
ptac |
number |
status |
string |
tare |
number |
updatedAt |
string(datetime) |
Repl
| Name | Type |
|---|---|
createdAt |
string(datetime) |
instance |
ModuleInstance |
module |
Module |
owner |
string |
ownerGroups |
Array<string> |
status |
string |
stderr |
string |
stdout |
string |
updatedAt |
string(datetime) |
ReplEvent
| Name | Type |
|---|---|
createdAt |
string(datetime) |
owner |
string |
ownerGroups |
Array<string> |
payload |
string |
repl |
Repl |
sender |
string |
updatedAt |
string(datetime) |
Repository
| Name | Type |
|---|---|
branches |
Array<string> |
build_settings |
|
builds |
Array<Build> |
createdAt |
string(datetime) |
default_branch |
string |
name |
string |
organization |
Organization |
owner |
string |
ownerGroups |
Array<string> |
repository_type |
string |
tags |
Array<string> |
updatedAt |
string(datetime) |
volume |
Volume |
Resource
| Name | Type |
|---|---|
name |
string |
schema |
Route
| Name | Type |
|---|---|
application |
Application |
createdAt |
string(datetime) |
handler |
Service |
method |
string |
owner |
string |
ownerGroups |
Array<string> |
path |
string |
updatedAt |
string(datetime) |
url |
string |
SecretNote
| Name | Type |
|---|---|
createdAt |
string(datetime) |
owner |
string |
ownerGroups |
Array<string> |
secret |
string |
updatedAt |
string(datetime) |
Service
| Name | Type |
|---|---|
createdAt |
string(datetime) |
current_build |
Build |
name |
string |
owner |
string |
ownerGroups |
Array<string> |
previous_build |
Build |
repository |
Repository |
status |
string |
updatedAt |
string(datetime) |
volume_mounts |
|
volumes |
Array<Volume> |
Session
| Name | Type |
|---|---|
createdAt |
string(datetime) |
email |
string |
expiresAt |
string(datetime) |
impersonator |
string |
owner |
string |
ownerGroups |
Array<string> |
provider |
string |
providerToken |
string |
token |
string |
updatedAt |
string(datetime) |
user |
User |
userAgent |
string |
Setting
| Name | Type |
|---|---|
comment |
string |
createdAt |
string(datetime) |
data_type |
string |
key |
string |
owner |
string |
ownerGroups |
Array<string> |
resource_id |
string |
resource_type |
string |
updatedAt |
string(datetime) |
value |
string |
User
| Name | Type |
|---|---|
createdAt |
string(datetime) |
email |
string |
groups |
Array<Group> |
invitation |
Invitation |
is_agent |
boolean |
name |
string |
organization |
Organization |
owner |
string |
ownerGroups |
Array<string> |
password |
string |
reset_at |
string(datetime) |
reset_password_token |
string |
sessions |
Array<Session> |
status |
string |
updatedAt |
string(datetime) |
Vehicle
| Name | Type |
|---|---|
createdAt |
string(datetime) |
immatriculation |
string |
name |
string |
owner |
string |
ownerGroups |
Array<string> |
ptac |
number |
tare |
number |
updatedAt |
string(datetime) |
Volume
| Name | Type |
|---|---|
createdAt |
string(datetime) |
files |
Array<File> |
from |
Volume |
name |
string |
owner |
string |
ownerGroups |
Array<string> |
readonly |
boolean |
status |
string |
storage_type |
string |
storage_type_metadata |
|
updatedAt |
string(datetime) |
Security schemes
| Name | Type | Scheme | Description |
|---|---|---|---|
| ApiKeyAuth | apiKey |