MENU navbar-image

Introduction

This documentation aims to provide all the information you need to work with our API.

<aside>As you scroll, you'll see code examples for working with the API in different programming languages in the dark area to the right (or as part of the content on mobile).
You can switch the language used with the tabs at the top right (or from the nav menu at the top left on mobile).</aside>

Authenticating requests

This API is not authenticated.

AR

GET augmented-realities/create

Example request:
curl --request GET \
    --get "http://localhost/augmented-realities/create" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/augmented-realities/create"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6Ik50YjhxbnlWSDRNZTZWcjZPL1lLZXc9PSIsInZhbHVlIjoicWNmbmtORElLaVk4enJOVy96NUo2MkJnanNjRHVDV3RoWGVaMU5Xam1wTC9wTkoxNENaVW10bDVMNGJsWXNOSUczRG9MUWJVYm5MNGhXMzJnVzBEdjNoeHZYdXcyakNyUU95eTJ1dy9rcVdxdFI4anJKcHI1YkZnTFNvNUtrYlMiLCJtYWMiOiI0NTJlNTI3ZmViMWY2ODMzOTc5ODYyN2IxNjY3Y2NkY2VkNjY0MzIyMWYxNjk5YzUwMWMzNTI5MDE3Y2QzOWFkIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6InA1WE9kNWFuUzFWcEdOYjBKUGliOHc9PSIsInZhbHVlIjoiVCtJYUhkYm5VeG1LbUFvdTFYQ0dtOVh5cDhQdjFUWC8ybXlrYlFXSXdsMVhVZU41aEhNN3NJQllpSG85MWR3QWVrSHU1Z1VSblFWR0dxekJWajlEUndoRFJ4Y0xvQWl2TVZOeGFLcWFvRTZab2lJWVpTRGZDQWU4dVZZVVdCVlAiLCJtYWMiOiJhYTNhN2JmNjRjYWRhNzljMmZmZTExMDhlMWM0NmMwNzFkOTc5NjMxZTk5NTRhYmNjMDQ1YTE5NDQyMTYwNmIyIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET augmented-realities/create

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET augmented-realities/{ar_uuid}

Example request:
curl --request GET \
    --get "http://localhost/augmented-realities/4c51f49a-0e67-4200-aefd-f4a89898f457" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/augmented-realities/4c51f49a-0e67-4200-aefd-f4a89898f457"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6ImlLT0VNZi9hMnZ3RE1MVkQ4MnduR2c9PSIsInZhbHVlIjoiTDVuV010bnNsVFhlZzRPSFVmVzlRZ3VqbU5mZVN0aC9GNC9BOCtwaGg4bHVDWkovNFNDcHM1Y01pclNuZG5BY0V2dUFWc01SWnNqcERtUG11b1I0anIxK3NOMFdBNkRQcWdwbEM4dGUwUU1TN2ozc29UM2tOQmE2V1dGaUxMcGEiLCJtYWMiOiI1NWEzNDhiOTJiYmEwZjAzZWFiMmM5ZDRiYWQ3NmNjMWFmM2ZiNzU3NDBlZmFlOWQ4MjQ1ZGMzMjFhNjJhODRhIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6Ik1PelJFeG9JRkNRNUN6SGttV3l1T2c9PSIsInZhbHVlIjoiRXM4LzUzREdLemZiVm1xemhvdDdPNFBXRXQ2ZzM3Y0pyYzlzL2tQWjFza1hGa0pWYVNFcGh5QXRmWmFtZG1FOWp5UndiY1VJa1praFdaZitLN2ZOYjlXMTFKM2NPbVhGMWVOUUxhUDVWNEFYS3FXZzFMYkZaZmF4ekU4Z3BtbXYiLCJtYWMiOiIwNWQyMWViZDMwOTU0OWVhZGRiNTE2Y2IwN2Y5ZDlmMWJiMDA3ZGJiNTBmMDZmYjlmYzY3MTY1MDRkYzc1NzE2IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET augmented-realities/{ar_uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

ar_uuid   string   

Example: 4c51f49a-0e67-4200-aefd-f4a89898f457

GET augmented-realities/{ar_uuid}/edit

Example request:
curl --request GET \
    --get "http://localhost/augmented-realities/4c51f49a-0e67-4200-aefd-f4a89898f457/edit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/augmented-realities/4c51f49a-0e67-4200-aefd-f4a89898f457/edit"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6IjMyakRBL29FT1p5d0paK29Ibktnc0E9PSIsInZhbHVlIjoiT1IxRHJ0SkZ0dFhtNU9oaUR6STZsZklOdHFDb1pFelc5T2FSRmRuSVFxTWlrME50SU9rRm5QR3R3ZHNxTFpBb2w5T3dnd2llZEpZS0JmTzllU3k4VFV0cG5PeXgzQzNVQXk0UjZWK1FqeDZ1RXhkSDdUTm1tUnpGUm1oQUxKVmMiLCJtYWMiOiIwZGE5MTFjMmVlNTZjZDBmN2JkY2MyMWRlNmY3ZTBjYTY2NDkyZjBmOWYzYzAwNTFhZTNjZWE4MDQ3ZjY0ZTUxIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6InBZallLdmlRdEVCRTdHTysxc0xzcEE9PSIsInZhbHVlIjoiaHh0elREcE1nemVZN053bDh5cmFSR1ZMYXBlODcvT1IwWjd2TGJRZmZGMVRHQUh5L1pwNE5yS3RMSU80SU80U3M3RUpNNGVrbUlsc0E5VkFJak5HNFhaMGdhZE5lbG9QeFJ2OUNvclNBOXhlTmxNa3p1Y09OR0pQNGl1UXgyanIiLCJtYWMiOiI4OTY0NDNkOWM4NjEwMDIxOGQ1NjRhNzhiMmYzNjE2NDRhMDYxZmFhZDM4NjgxZDNjZTY0MDc3MzIzZjhlZGRhIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET augmented-realities/{ar_uuid}/edit

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

ar_uuid   string   

Example: 4c51f49a-0e67-4200-aefd-f4a89898f457

PATCH augmented-realities/{ar_uuid}

Example request:
curl --request PATCH \
    "http://localhost/augmented-realities/4c51f49a-0e67-4200-aefd-f4a89898f457" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"architecto\"
}"
const url = new URL(
    "http://localhost/augmented-realities/4c51f49a-0e67-4200-aefd-f4a89898f457"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "architecto"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH augmented-realities/{ar_uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

ar_uuid   string   

Example: 4c51f49a-0e67-4200-aefd-f4a89898f457

Body Parameters

name   string   

Example: architecto

description   string  optional  

DELETE augmented-realities/{ar_uuid}

Example request:
curl --request DELETE \
    "http://localhost/augmented-realities/4c51f49a-0e67-4200-aefd-f4a89898f457" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/augmented-realities/4c51f49a-0e67-4200-aefd-f4a89898f457"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE augmented-realities/{ar_uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

ar_uuid   string   

Example: 4c51f49a-0e67-4200-aefd-f4a89898f457

POST augmented-realities/{ar_uuid}/upload

Example request:
curl --request POST \
    "http://localhost/augmented-realities/4c51f49a-0e67-4200-aefd-f4a89898f457/upload" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/augmented-realities/4c51f49a-0e67-4200-aefd-f4a89898f457/upload"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request      

POST augmented-realities/{ar_uuid}/upload

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

ar_uuid   string   

Example: 4c51f49a-0e67-4200-aefd-f4a89898f457

GET augmented-realities/{ar_uuid}/GetAR

Example request:
curl --request GET \
    --get "http://localhost/augmented-realities/4c51f49a-0e67-4200-aefd-f4a89898f457/GetAR" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/augmented-realities/4c51f49a-0e67-4200-aefd-f4a89898f457/GetAR"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6Ill3cFMxOFNlNGxzSlA2VHJUeGV5MUE9PSIsInZhbHVlIjoiam5XZk1VL1B3NVY3cGRhOXUxRGN2SXpRckwwMFhJaEwzS1pHSXZuT2R0c3hpVmt3SlczQ04yVlB3Nm1xdDdGQmZ3cXRmQWllaExDaGRhNnBNN1NCRVRoQ25KMzJnaG5uRXRKcnUwUGg0dDhmY2YrZEdSamRHK2M5Y3NKY1NyRWIiLCJtYWMiOiIwMWUwZWNhZDFkNmRkZDViNmQwZjhiZjA3ZGY4ODBmODU0MTI2ZGJjMWRmMzk4Zjc0YmFhY2ZjNDg5OGEwNzVlIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6ImlKRHMzSXNML1JUTC8rMmI2Qm4zWHc9PSIsInZhbHVlIjoiczZkNFlwMkkrbmNKNHFlOTdTZU1PRVllSHE3NDhIU2pjeVFKcVFiRFJFWnJObTF0dVVQajR1S1lYTWNzTWJIaEIvVHB6Wk5ycWRlZFdiVWlWR2dyYnlCdkREQyt3U0JuRUpNR1Rjc0dtSmUwUWZobk5oUTNoZk9kVDhNMXZxSGUiLCJtYWMiOiI2ZmNiZDQxODMyMTFiYjM0OTgyNTJkY2Y2MjZlNGRhNzFjMzg5Y2VhNzgyNGE0NTY3YjYxMzNjYzA5YTlkNWRkIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET augmented-realities/{ar_uuid}/GetAR

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

ar_uuid   string   

Example: 4c51f49a-0e67-4200-aefd-f4a89898f457

Broker

GET brokers/create

Example request:
curl --request GET \
    --get "http://localhost/brokers/create" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/brokers/create"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6Im9KTHJkYXVQTWhpL3hFYjNrWVJDWmc9PSIsInZhbHVlIjoibUlPM244THpRQUwvajI4N2Z3SnhuM2xCU1M5TndGcjhiZVY1QnZmNmtXckQ5TXhueUJMa1BEa0dCazY1V09GcGhXaTVNZnB6UUlNaHNMSXNreFpKVmlwTDJxU2dCd2x5WUxFeW9jVHAwenl6Ykc5Nyt1bW5SVStKbWhEQ1ZCcisiLCJtYWMiOiI2MDMzYjAxYjFhN2U0NzRjZmMwNTIwZmVmZGEzOTFiYmY2YmRlZjc5MTZmNGExMzVmNjIyNTFiZWI1ZTc2ZmNhIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6Im53OU9DQUpjL1g1NHY0djZNNWNBV2c9PSIsInZhbHVlIjoiWXRpdmI5Ym1uTHptVTdxellrWmJUVVZhRDRCYUQ5dEhWMDR0U1JrcGx0MDlGNFFBREplZlA3MVl5dFduUE5QSGN2cHFHRlFkTnFEYmpmL3dWcUZFYXlUUmZ0OGEvSzV2OGtadWo0SUdnSk50T1NzNVI4RTdRYmZKMENwNk9aSFMiLCJtYWMiOiJiYmYyZmMwNDJlMTQxNmY1N2I4ZTEwMzgzMDE4OGE3ODU5ZmM5ODFkYjIwNGQ5NDUwNWUwYWNiMzY5YWNlNmFkIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET brokers/create

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET brokers/{uuid}

Example request:
curl --request GET \
    --get "http://localhost/brokers/628b1ad6-c30c-4904-968c-c3e49920fbad" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/brokers/628b1ad6-c30c-4904-968c-c3e49920fbad"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6IkhJM25jTHRYUkoxK0J3UmthMm1IVEE9PSIsInZhbHVlIjoieWMrMzJZOUp1QVc1TG5BZGZraFBEeFhtejBXVXhYMnpPZnAxbUlKeG1SM3hkQ3N5THArU1RKNWd4MEVVbWV5bVUrSjVYd2Y3UnVzd3J1N3NsdFgxbXZSVysvMHpldElXYy9oYlExOVZPT3RUWWs0WlBleXZXS3lRWGhIQ3NvWGciLCJtYWMiOiI5ZWQ2MDI2OGE5NTBjNDMyNzI3NGZiYWU4Yzg4NjI3NDAzZTNkZTBlMzg4NDNiMmQ2OWE0YjM4Y2E1NWJhNzY5IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6Im9iMG5FOW9XTjd5a2NZY3hIdEFnTHc9PSIsInZhbHVlIjoidUdJR0p1anNpOTFzNUZQZTQ0TFVzZmhMYThxWTdMdUxyS1poZmk4TWtqR0JvOGgvVHNSL1hXOVMvOEVyTFdVNjUvVE8yZWp0ckxEOUw0b1hOREFzUjdSekpVd2E5U2szYjQxWUEwN0t6dXpEWVR3VXBpSTdxNEtSUGdNd3c4SVciLCJtYWMiOiJkY2NhYWNiYjIyYzY0MTg0Mjg4YmMzN2RkN2EzZDVlMGI3ZDYxNWExOWY2YTdhNzU3MjliNmM3NjM0ODM5YmU4IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET brokers/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: 628b1ad6-c30c-4904-968c-c3e49920fbad

GET brokers/{broker_uuid}/edit

Example request:
curl --request GET \
    --get "http://localhost/brokers/628b1ad6-c30c-4904-968c-c3e49920fbad/edit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/brokers/628b1ad6-c30c-4904-968c-c3e49920fbad/edit"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6InpnQTVrc01mMVVtZUxMZVE5Rk45WUE9PSIsInZhbHVlIjoib3YyWG53bzN3Q2hTRURlYi9TbEFHM3Z3SEZtaWhBa2w2RHpWczNxWVpyVmxKUjNGYTlkSksvUTBQMG1Vc0FDNkNpRVFuY3Rkd0FBdWhSTnZlTVp3aTJOVExQaTArVTlzekRZajI5QklPZzFnTUZUZ1JyZ09TeVR1V2xrNStVYjciLCJtYWMiOiJjMTA5ZDUyNTVjZjgwMDgzZjhhNmJjZjk0Mzg3MmQ3NzY1YzM3ZDY5MGMwNzQ3ZTAyZjY2NThiZWI5NjliZGQ5IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6IkxGM2phTHZ2VEVYZS9iQWJCczkvdnc9PSIsInZhbHVlIjoiU1lmd1lIVXZISk15aVlIcm9VdHpHZ0F4bXlUaGVZUnl1bTdyNk5icVFjT2ZhL1pOZCt1MHpjbWtQd0k4MjRTZG8rNmxwWTROV25pdm5JZ2Vrckp2V21vNk1uSStNbDNWbElyNUhOYmI4THQ0Rnp2aDI2dlVyR3pWeGlVMTFTaXoiLCJtYWMiOiI2MzI5NTYxYjkxYzhkNGRmYmUyMjNhNzljZWFmOTExMzFmZDM2ZTMzYjAwN2RjYzc5NjViYmE1YTYxNmYzOWIwIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET brokers/{broker_uuid}/edit

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

broker_uuid   string   

Example: 628b1ad6-c30c-4904-968c-c3e49920fbad

PATCH brokers/{uuid}

Example request:
curl --request PATCH \
    "http://localhost/brokers/628b1ad6-c30c-4904-968c-c3e49920fbad" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"architecto\",
    \"host\": \"architecto\",
    \"port\": 4326.41688
}"
const url = new URL(
    "http://localhost/brokers/628b1ad6-c30c-4904-968c-c3e49920fbad"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "architecto",
    "host": "architecto",
    "port": 4326.41688
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH brokers/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: 628b1ad6-c30c-4904-968c-c3e49920fbad

Body Parameters

name   string   

Example: architecto

host   string   

Example: architecto

port   number   

Example: 4326.41688

DELETE brokers/{uuid}

Example request:
curl --request DELETE \
    "http://localhost/brokers/628b1ad6-c30c-4904-968c-c3e49920fbad" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/brokers/628b1ad6-c30c-4904-968c-c3e49920fbad"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE brokers/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: 628b1ad6-c30c-4904-968c-c3e49920fbad

Category

GET categories/create

Example request:
curl --request GET \
    --get "http://localhost/categories/create" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/categories/create"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6Ii9BdFlLNnpSeXVyQlllcWFJdmZPNnc9PSIsInZhbHVlIjoiVXVCcEQwQmVHZHlMSS9kc1BhRmxyeGdIbnkrRXRXSkRRd3FPUG5kZ1g0OUZxaXdwdE5DMXZkekZvOHNNV3RzT2loYVNoUnVDL0ZGVGlEQVFQNlYrdFFlb3ZERjE5RHpsc2k4WXZWWFRlQWdBSkowaUtvd05JWStib0l1REdlVFkiLCJtYWMiOiJjYjgxZjU0OWM3OTE4NGM2ZjU2NWUzMWFmMzdlYzkwZTBiMjE5MThjYmY3M2YyYWUyYjY4ZGMzZmFkNWNkNjIxIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6ImFXNmdyaVNUd2piV0ZmemlMQjJGRnc9PSIsInZhbHVlIjoibnNmVFQyTHJMblFPNityM1VHWTdyZmF5WG9QQTBSNVg2bWl1MGV0aXFrVENUMmR2clY1WTdsSlJOUFNFUmdJMzdlSGkvaGg3VVhYYjBVUkM2a2kyd3RyVytOS0x0V2c3UXRFaFczMEltS1pJWnVYVjJ3NWdWemkvTDF6L3ZTdWwiLCJtYWMiOiI3YzQxMDMxZDEwMWJhNjRjNDNjMjJhZjExZTZlODEzZmJhOWM4OThmZDk1ZDY0NzNkYWRkN2ZlN2Q3ZjQ5ZWQxIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET categories/create

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET categories/{uuid}

Example request:
curl --request GET \
    --get "http://localhost/categories/4f23a17b-2152-47a7-89d9-e0a7146565a0" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/categories/4f23a17b-2152-47a7-89d9-e0a7146565a0"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6IkxPalUyNHc0Q0dvY2dqR2Rqd0RKYmc9PSIsInZhbHVlIjoiMDRITWdCMXhLaXlkdkg4M3NuOXRGV29KVGpRejk4UGhDMWlsbTZFWVdicUhrelZsbngrN0VYRFdpWjFZMmVZZXREMHpFV1ljbWx3Z0hMbmRuOUJIOTNJbmIxRVBqR3pYWUlTcVlFSlZ2K2VyOXJuMThVNkpIR2ZyelZVbnNHZWgiLCJtYWMiOiI0ZjRmOGYwMDYyNWI1YTkxY2MzNTVjN2FhNjgyZDhkMDEwOGRlODY3OTgzNjlmOGQ0Y2Y4YTQ3YWQ1Y2JkOTg3IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6ImdRVzE0Qzd0dkNicWdGYit2Z3FlTEE9PSIsInZhbHVlIjoiNHFFS29tRk54R2N0Nmt5RFJzU1BibVVzY1JWNTJqcEpwbkcyanJXcG90QWdmZjRFNkwxZ2pKTTJtMi85bm1rQ3A2S3hMckxkN3BubCtoUll5YldUd2lteTFzaDJJSGRPNVJ4MTVzVkc4QUJHYW1SempuclpsT0xOTUZPdXlLUGQiLCJtYWMiOiIyZjA3OTA0ZGVhOGZiMzUwNDQxNTBiZDc4OGVhYmZjMzExMGViNmI5NWY3NzlmZDJkYjI5MzFjNGE3MmRjNzBmIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET categories/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: 4f23a17b-2152-47a7-89d9-e0a7146565a0

GET categories/{category_uuid}/edit

Example request:
curl --request GET \
    --get "http://localhost/categories/4f23a17b-2152-47a7-89d9-e0a7146565a0/edit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/categories/4f23a17b-2152-47a7-89d9-e0a7146565a0/edit"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6IkhrZ2F3YTFJNjVocyt1UzhLSDdDMlE9PSIsInZhbHVlIjoiUVlHd3ozUDgxSnZZMTR0MXpTVURYVjNRYWFueU4weUo0VXlkcjNZNHNVRVZRVy9EUWc2WjE5T2dhRUlKOEk0RHBJVHlMM0J5RjVlUi9jbFoydXFXMUlEc2Vxb3ByTm1wMGVRT2VzSmRmeTRpdzN0VDFXRDFjTVM4NzVubEZ4QzMiLCJtYWMiOiJkZGMyNDFhMmViYzBkOWZmNzliMjU5NjNkMmY0YjkyMzJhZmI5M2Q4ODk1YjVhYzI3ZWMzMzhhNDY0ZGUwMjEwIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6ImV5QWRiOHY5U1pUdGgwKzE2YStOQnc9PSIsInZhbHVlIjoibHBpb1NJdkNDUjh1VjNOaVk4dlZtSHNaMGRQNzdYdHJVTzBKK29EZThHUmYvSVZpTWZUTWpCemhOT0dYcUZIZWF4TFQ3SE4yNTJHOUVHYkRtM0VaNjJBUXR2anpQQ1ZaSVI1am1uczZQcUF0QloyR2xDekZBbHF1eGZod29zT0MiLCJtYWMiOiI5MTMwNTcyODhjMGZhMzRjZTI5NjU5NDg0ZDM1ZmM2NjE5YjE3MTg2Zjk1MWJlMzEzMTdjZmU3YjhmMjY5NjQyIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET categories/{category_uuid}/edit

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

category_uuid   string   

Example: 4f23a17b-2152-47a7-89d9-e0a7146565a0

PATCH categories/{uuid}

Example request:
curl --request PATCH \
    "http://localhost/categories/4f23a17b-2152-47a7-89d9-e0a7146565a0" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"architecto\",
    \"description\": \"Eius et animi quos velit et.\",
    \"access\": \"public\",
    \"type\": \"None\"
}"
const url = new URL(
    "http://localhost/categories/4f23a17b-2152-47a7-89d9-e0a7146565a0"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "architecto",
    "description": "Eius et animi quos velit et.",
    "access": "public",
    "type": "None"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH categories/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: 4f23a17b-2152-47a7-89d9-e0a7146565a0

Body Parameters

title   string   

Example: architecto

description   string  optional  

Example: Eius et animi quos velit et.

access   string   

Example: public

Must be one of:
  • public
  • private
type   string   

Example: None

Must be one of:
  • None
  • Files
  • Forms

DELETE categories/{uuid}

Example request:
curl --request DELETE \
    "http://localhost/categories/4f23a17b-2152-47a7-89d9-e0a7146565a0" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/categories/4f23a17b-2152-47a7-89d9-e0a7146565a0"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE categories/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: 4f23a17b-2152-47a7-89d9-e0a7146565a0

City

GET cities/create

Example request:
curl --request GET \
    --get "http://localhost/cities/create" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/cities/create"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6IjM3T0tFUk5QSklXWnl0cnZxb2NUdnc9PSIsInZhbHVlIjoiSnkzR2lXRWZ0ZmZOU0hoUEtqbWpIZHdlMmRCNnYrOS91bzlzUXduMWZMWWE5S1hQdjNiVnhOUWVJU1cxM1lvWEtBMno1Sm5rb0xLTjdIMDVSYVBtenVnRlRFVUFRa0MrT3I4Q3dCeTNhdGZiTUdBY2FMOHJjT3kwOWoxUC9UeSsiLCJtYWMiOiI2NzJkZDM2YThkNjhiYWFjNDU1MzBlY2IwNWZlMWRiNGY5YjhiN2ViNmM1ZWYzYTc5MjAzNjcyNTU2ZWY4ZjgwIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6IlhtejZYTHIrU0UrZDhRcVJLcE9NZUE9PSIsInZhbHVlIjoiSVRuZmgrNUtBb1lNczVBVTlaQjNHRk9WcVY5aXVBNng1YXZOajh5LzFyVnJiN2piR2FkRWFzcVhPRUhyd2pzVWZzZ1VqYkR1VE0vcklZVG1kZnBMNC9BNlpNbjVjOVl2VTlnOUIxTXBybzh2Q0dFejY1d0pJNGYrTjFRV3lzMVkiLCJtYWMiOiIxNDE0YmFkYmMyNTEwMmI3ZTU0OWE0Yjk2YTRjNWY1MzQ2ODY3ZjlkYzU0MGI0Njg0ZjM0YTY5ZmM4NGE2Nzc0IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET cities/create

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET cities/{uuid}

Example request:
curl --request GET \
    --get "http://localhost/cities/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/cities/1"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6IjY4b1F2dVVOWitzcUpwYlhSbHZnZlE9PSIsInZhbHVlIjoiOTEycGdzOE9CTi9pT0JwbkFSeXltYi9oMFZMVDUrTWd0WGVTa2NESCtBOHJWTzlGRDB6MnMzS2tlUlFoNHlHZGRRM0gwenhSL1BiMFlIci9GTm9SMGQ2UjlUQ1pJVks4NGYzNm9iZ0hwR3hINlREMk5MTFQ3WnhJQWI1NXpoVmIiLCJtYWMiOiIzM2VhNTQ1M2UwZTU0MDNjMDFkNDU0NTdmZmQ2OWIzZGExYjk2NzRhOWE5MWViYmUwN2M1OGMxZDJlZGNiMDIwIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6IkZKNkJ4NmxYd3AyU1B6elNtRXQxNnc9PSIsInZhbHVlIjoiOHdpZFppbDNWZGhBaC9BRWJ0eDh2TjNiWkNzTUJsWmpGYjEvOCtBSnBYdkFvSjNERjFQalI4aWtRcFhpSVl3VFUxWmgycDhBZDl6Z0p4ZGRJQURld3lWQzIyWjB5ejZ1UG9KY2NPNGE0cHVvU1pLZHJ2bGdEVkxwWVdsOHF0VWkiLCJtYWMiOiI3ZmQ1OWJmMDc5MDUxYzdiMmM0MWVkMTc1MzYxYWM3Y2EyYzRkOGIxMTQwOWVkOGY0MGFlNjFiZDFlODlkZDVlIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET cities/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   integer   

Example: 1

GET cities/{city_uuid}/edit

Example request:
curl --request GET \
    --get "http://localhost/cities/1/edit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/cities/1/edit"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6IlJGbzBpbG1DUTl0RHcyY1NxSVRUamc9PSIsInZhbHVlIjoiMGFtOTFQNUFwNFZLTXFBUkFZY25EcCtFQzFyRFQ3VjhvM1ZoRkNicHpvZWtUUmxzSVRaTjhvR1pHMDBKRGVNUnNCdEpFUkRLYWZJV2pTUG1ucDIrNlFoVTJyTThVUnZ3R2JleXg2L2QreWhyVVVaNEZPeW9vKzNySXZJRDdpOWciLCJtYWMiOiI0Y2M3ZTBmZDBiZDgxYjI2MTZiZTA5YmQyNDFkMDBlMjc2ZDMyYWNlYzJhODM0NDkyOTJjZDQxOWVjYWM3MmNjIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6Ii9XUUhKeUMvdVNQVHl6dWhKODE3MUE9PSIsInZhbHVlIjoiaGRjcnJVNTV0dmR5aUs3emx6ckE0SlZzRnZPaVVSaW16eTBOWExhNlQrSCtDZHZVdnhhQ1BxamJGYUJlRndvdSt2cXcrODlTVkQyUFhBRmNOc2d4Y1NrK1A3SXlZdUNZMXgwZ0Fod2FmdjFEV05uNWlxQnhjajkvNjA1ZkZLQisiLCJtYWMiOiJiYWI5MTU1NjM0YzI2NmY3MTkzODFhNTIwZDllNTEzOTJmZTk0ZWE2MTViN2NiZmE1MWMwNmEyMjg0NmJkYzJlIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET cities/{city_uuid}/edit

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

city_uuid   integer   

Example: 1

PATCH cities/{uuid}

Example request:
curl --request PATCH \
    "http://localhost/cities/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"country\": \"architecto\",
    \"name\": \"architecto\"
}"
const url = new URL(
    "http://localhost/cities/1"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "country": "architecto",
    "name": "architecto"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH cities/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   integer   

Example: 1

Body Parameters

country   string   

Example: architecto

name   string   

Example: architecto

DELETE cities/{uuid}

Example request:
curl --request DELETE \
    "http://localhost/cities/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/cities/1"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE cities/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   integer   

Example: 1

Connection

GET connections/create

Example request:
curl --request GET \
    --get "http://localhost/connections/create" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/connections/create"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6InBoQTZ4eHpPSnBBQ0N3b2NjYlBCaGc9PSIsInZhbHVlIjoiS0N6QXJRQXNrTUM3U1BTRFJqeXVDenBJMFFWSFJpUHVWOEcwU0JHcXF4N1hwWUJMb2phUEphVTFjUXo0Y2VMeFVUV2tWWHlFTStITUlpdUpsZ0RLdTZmei8rTDZreFkvdkJXRzE3OVhIKzVpSW90S0pmOE9qdkk1RWd4eTVQS3AiLCJtYWMiOiIyMGM3ZTFiODJjNDQxN2RmZWNhMmUxNGM0YjdjMDZjYWIwMjg3ZGEzMDJhOGJmZjBhMDBiMmYwYmM3ZmY5MDhlIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6IkJPUUVVbHgrcEREZW92SitHVno4L1E9PSIsInZhbHVlIjoiQVI2SW5YR1poeTF1dzVMNFBwd2JGUHU3RlZWM2ZQTHZXdENLMXZ5dmpTR1Y5eVV5d05rYXV1SVBxcXFDTDFQQjlDSWw3UFQ5MGhHOGltcVZQY2lISlFYN05XeGlUR3dvYnJ5ZjdJZzZRSWtnOUU5N3UzeTlrS2Y2SUV4Mm9qL0YiLCJtYWMiOiI1MjRiN2IxOTNkYWNkMTY0MTA1YTVhZTBhYmQ2ZDY5ZjA1ODQyNTlmOTQ0ZjQ3ZDQxYjIyNDEzZmY3YjQ2NmNhIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET connections/create

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET connections/{uuid}

Example request:
curl --request GET \
    --get "http://localhost/connections/3da5b6f0-55b3-49ab-9f9d-3ab403f93172" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/connections/3da5b6f0-55b3-49ab-9f9d-3ab403f93172"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6Ik0zazdicVFEUG0yLzdmSXVlU1F3c0E9PSIsInZhbHVlIjoiVVdWdFVqWlVVZlZxUEd2NzNjLy9WTE5MbHZKSnVCclVJS3hpYmdJenFEN0drbktPcVRBYzR4akxibWNWNGlBOWk3bjBMOTVsazJ4dkVqcklvem1JWk1EdWJrL1FLZ1BTckFNRDZpZXFvY3orZW5iRDNQaHVYbGU4YVI0RTVDR1ciLCJtYWMiOiIyMTk2M2Q0OTU0MTdjMThmMTE2NGEwMjFlYTEwMDE0NTExYjljMTM5ZTlhYzIzMmJhNDk5MDI4YzM2YTM3YmY3IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6IlJORVVjaVF0UlVDcmVkR1FDczNMclE9PSIsInZhbHVlIjoidHRjKytGcmpEUEdmOU9LaStDOGZuREFjRTBRdCtDeTF3dUI4THhTNXh4V0hvL1dHZkN2dzZ6d09oNy9wT3JVZEp3MWRGK0lXQ2lZdy9XTnhrdnUzaFRRN1lwKyt1OHNLQ3VXK2UwYUw1SzNYQXgzNmMyN05nQW1PNWsxcmFjVG8iLCJtYWMiOiI2OTA3YTc1NmJhZjY3MmFjZTVlODQ4MWEzOGEyMGIyZDQ4MzRlNjBiZjRjOWJmMTc1MjNiMTA2ODJiNTU5OGM5IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET connections/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: 3da5b6f0-55b3-49ab-9f9d-3ab403f93172

GET connections/{connection_uuid}/edit

Example request:
curl --request GET \
    --get "http://localhost/connections/3da5b6f0-55b3-49ab-9f9d-3ab403f93172/edit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/connections/3da5b6f0-55b3-49ab-9f9d-3ab403f93172/edit"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6InJzS09ReUxSMzdGcEJUbE1ZZi91aXc9PSIsInZhbHVlIjoiUk9QMGxpK01CQzVrVHpOSi80WnZmbUpQWTZJMVZPWmdwaVVrRmJKN0RBZFJGbkRwZTMwSmNXMkpYY2loakpEem96M1I5VFdGSzY3enpSb2NESXhsNERLWExoeUNmLzdvYm5zVjVqOWliQ0JzaXhsaTJCUStiNkZRN0NwQWl1RWoiLCJtYWMiOiIyZDViZGQyZDUyMzdkNWQ5NTZjNDRkOWI1OTVlMDc3MWIzMzRkY2I2NGE4ZDBmODk4YjQzMzU4ZDg3NGZjNTk1IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6InBPejJRcWxuVklOeWZyVnNObld3ZEE9PSIsInZhbHVlIjoiRkNSdDExUCtvRDlBOFhDTTVXbFVmanFoKzVWdmhSeXBYb0tnUDcxdGVYODNxMXNzKzVGbVNJRWJYOHVEa2pEbnlXbTVwbzdndm5rRURhZEo3Zk02L2F4aEZOdDZHUHlQNEN6MDc1RTdEd1NreGtkaXFhYlJPanovQ016MlJ3bGoiLCJtYWMiOiI4N2EwMWEwMzU1ZTk3OWU5YzNlZWUyMzhmOTJmNTEwYzg1YmEwYTlkZTY0ODc0ODE3NDdhYmU4ZjI2NmRiMzc4IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET connections/{connection_uuid}/edit

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

connection_uuid   string   

Example: 3da5b6f0-55b3-49ab-9f9d-3ab403f93172

PATCH connections/{uuid}

Example request:
curl --request PATCH \
    "http://localhost/connections/3da5b6f0-55b3-49ab-9f9d-3ab403f93172" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"architecto\",
    \"broker\": \"architecto\",
    \"topics\": [
        \"architecto\"
    ],
    \"permissions\": [
        \"rw\"
    ]
}"
const url = new URL(
    "http://localhost/connections/3da5b6f0-55b3-49ab-9f9d-3ab403f93172"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "architecto",
    "broker": "architecto",
    "topics": [
        "architecto"
    ],
    "permissions": [
        "rw"
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH connections/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: 3da5b6f0-55b3-49ab-9f9d-3ab403f93172

Body Parameters

name   string   

Example: architecto

username   string  optional  
password   string  optional  
client_id   string  optional  
broker   string   

The id of an existing record in the brokers table. Example: architecto

topics   string[]  optional  
permissions   string[]  optional  
Must be one of:
  • rw
  • r
  • w
  • d

DELETE connections/{uuid}

Example request:
curl --request DELETE \
    "http://localhost/connections/3da5b6f0-55b3-49ab-9f9d-3ab403f93172" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/connections/3da5b6f0-55b3-49ab-9f9d-3ab403f93172"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE connections/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: 3da5b6f0-55b3-49ab-9f9d-3ab403f93172

Device

GET devices/create

Example request:
curl --request GET \
    --get "http://localhost/devices/create" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/devices/create"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6IlJhNnhIM29OZGtpN3BkaDlORXpnaGc9PSIsInZhbHVlIjoiOVhDbUdRNlhQVllsVHJJd3ZKQW5iZUsyQ1pCWm81VElsMjRqMlEvRFlrWGNhS293ZHdLNSswbHZGUmlSQWpSY2pWVnl6aCs4cWQrOXoxc0FseU0zb1hDbjJmY0ZhU3BqVVVYRTQwNVl5eXNmTW9BdzREZjlEdjlMOVpkTU5XN2EiLCJtYWMiOiIyODcwNGJkMWEyNjYwNmJlZGI1NzlkMDUyYWE4MWUxMDE0MmE3OGJlZGIzOTg4ZTVmYTFiYzRiZGY5YWMwOWE0IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6ImRDMWE2T3FXVW81cXlJNGtxY055Rmc9PSIsInZhbHVlIjoiSTNLNzBlcEVJVWVTOHR6YTl3TTBLSHlVTkZ2MHBxK0hNbHBlY2dGMWF2dWpieU4vVnIza1g2dzZRWU0ya211ejIyMnJPYndqTWEzUnRMeHliR2RPQk1VLzhjTXAwcG9BV2NGVUlBTFhUTE04ZkxCb2Z0OUpFVW1MTVZXZXZqbmciLCJtYWMiOiI0OTA2N2ExNDhkOTNkNzc2Mzg0MjE0MmE4MTJiYTk3ZjAwYmZhNGE4OTQ1MTBmM2E2NGVjNTM1ZWQ1ZjU5NTNiIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET devices/create

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET devices/{uuid}

Example request:
curl --request GET \
    --get "http://localhost/devices/656355e9-2e31-45d8-bb36-c488384e3310" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/devices/656355e9-2e31-45d8-bb36-c488384e3310"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6Ik9LVHc1L2l0RDM4ejFoY3EzZHVXc1E9PSIsInZhbHVlIjoiYkdaOGdVVC9oYnJmbkMybEF0UFNsenhOYXBaV0I2UjJiOXZMZmlMSlYvQUxWaHA5elVOZ21uZU9MN2R2V290MW5KalFwRW1Ybm0rbElSWkVhdTYyUSs5aEVjckkzZzJpK1VUSHByb01KWXFNc0VZUjNLSEtKc0ZPWldSV2ltRFYiLCJtYWMiOiI3NWIxZjVlZTAxYTgxMWRmOTUwMWU0MDlkNTg0NTA3YjhlYWY0MzRiMTNmODdiZWE5YmMwMjQ4MzBmZDdhODAyIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6IlduZHlETURYZm1Dck9rV3pqRXNacnc9PSIsInZhbHVlIjoic3dKSHh6NGtqQTB4TFhZZGJKMHZFcXVXZlo5N25sVG1qN1BPcW9MTGtGMm1tbzI3WEpSOW80eWd4Sk9xS2t1WmpyV1RkTkswbVVKSmNiQ3d0RFU4akpGV1BldkZOWVcwQlpKS1J4OWRJM0FFK1FOYTlzNE82MTVRb1dRQWVOVUwiLCJtYWMiOiI4OTIxY2M4MWUxZWQyN2RmNjlmMDcxNTVjY2VhYzk0ODlhNDcwMzZlOTZmZTRlMDc2MGFjY2FjOTdjOGEzYjRkIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET devices/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: 656355e9-2e31-45d8-bb36-c488384e3310

GET devices/{device_uuid}/edit

Example request:
curl --request GET \
    --get "http://localhost/devices/656355e9-2e31-45d8-bb36-c488384e3310/edit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/devices/656355e9-2e31-45d8-bb36-c488384e3310/edit"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6IkFjUnNHL3MweVZsQlNEUVkxendXaFE9PSIsInZhbHVlIjoidUhsUHROUzl6a2tMV0FkUEtqc2YwUTBVNVZPRlBIekVTazJ6Y0RXcUpvUlNOcEZiQVJDdmUzTU9iTUkvSDMrNjNHNnpkSEs0N3JBcENmbXdncE9Ia2g4b01zekpjRzlhQ1pzdUxBVUdoQlVRaFE1Vzc1YnZBa0xGekxJdkxrSHUiLCJtYWMiOiIwMDFmNWU5ZjQ1ZWJmMDJlMWUyMGUyNzEzN2I3MjJmYThmOGJjN2MwMzczYzc4NjZmOTZiYjc1NTU0YWExNTdlIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6InZEZzBsZjFqZC9Hcm9raWJLd1NIWWc9PSIsInZhbHVlIjoiRTFqdHh1WDlLeDVQUXBxQUc1NHlHeFdzOFBLbmxNcVdoRVB0dGo1Wk5iNjRmM0VhK2x5TkRnV0YxN05pWWJtRW9NOXJ4UGcrdzNka3lWdUNuV1kxOWVNd2t0b285VjhObjBIdzVsbXpUaWRzQmFIemp6ZmdyLzBMek5UK3lQZGMiLCJtYWMiOiI1YWRlYTAzMDM0YWQ2ZGQ0ZDhlYTM3YzRiMjY3YTMxZGFkZDJiNTEzMTVhNjBhNzI4ZDExZjhmOWQ1ZjA0NDJlIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET devices/{device_uuid}/edit

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

device_uuid   string   

Example: 656355e9-2e31-45d8-bb36-c488384e3310

PATCH devices/{uuid}

Example request:
curl --request PATCH \
    "http://localhost/devices/656355e9-2e31-45d8-bb36-c488384e3310" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"architecto\",
    \"topic\": \"architecto\",
    \"connection\": \"architecto\"
}"
const url = new URL(
    "http://localhost/devices/656355e9-2e31-45d8-bb36-c488384e3310"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "architecto",
    "topic": "architecto",
    "connection": "architecto"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH devices/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: 656355e9-2e31-45d8-bb36-c488384e3310

Body Parameters

lan   string  optional  
wifi   string  optional  
name   string   

Example: architecto

board   string  optional  
brand   string  optional  
model   string  optional  
topic   string   

Example: architecto

connection   string   

Example: architecto

description   string  optional  

GET devices/{device_uuid}/chart

Example request:
curl --request GET \
    --get "http://localhost/devices/656355e9-2e31-45d8-bb36-c488384e3310/chart" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/devices/656355e9-2e31-45d8-bb36-c488384e3310/chart"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6IkxTTTVjU1lTNFMxY0xuWWNXWk5SM3c9PSIsInZhbHVlIjoiaTNSeFBQc1BZRlBqYUZNZ0N1UzZSV241bFo4OTFDZmk1aVJ5MjBQQ2xyZkZPSXpDeTBKYUdwd1N2djV3eVhmNS9rQWF5Zndzb1poY2tTZXR6VFFzd3hNQldmS3hMdG9neUJibXlMUTZyTHM1a21DZXc4eGtFR1dkenhjWWM0MW8iLCJtYWMiOiJhOTVkYTAyYzRjN2NiNWZiNTMwMTliZTgzNTFkOThlMThlNmFiODYwNmJlMGRlN2NmZGMyNTgxZjFjYjE5ZjkzIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6IjVFb3Q2OVl2UnF6ek84Y3BoTnM5VEE9PSIsInZhbHVlIjoia3lEVzRLT0FNZitJMTd6TEdrT1g2QldZQXNqOXVUaDJUb3U0V0UrWnovcnJCMTlib1I0MW5weGIvQTNOZUd0bFlIK1hpSnRBQno0WHgydEF3d09nb2YzQXZTSkpPU0VzZjlCVlVaSmRYNURvWGJ4TStvaWJnMHlkVVo0VmhOTU8iLCJtYWMiOiIzNGNjMjJmNWRmM2IyNTM2ZTQyZTAyZjlhZjU0NWUzOGM3ZTc3OTlhZDBkZGQyZmI1MjdhNTQ0ODA5ZGY5MGM3IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET devices/{device_uuid}/chart

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

device_uuid   string   

Example: 656355e9-2e31-45d8-bb36-c488384e3310

DELETE devices/{uuid}

Example request:
curl --request DELETE \
    "http://localhost/devices/656355e9-2e31-45d8-bb36-c488384e3310" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/devices/656355e9-2e31-45d8-bb36-c488384e3310"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE devices/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: 656355e9-2e31-45d8-bb36-c488384e3310

Ensemble

GET ensembles/create

Example request:
curl --request GET \
    --get "http://localhost/ensembles/create" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/ensembles/create"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6ImoxTFNjNExOallMUGk0V3ZENWlRdHc9PSIsInZhbHVlIjoiVDBlbWpUdlpudENxYjhwTGdmWHVjMGZvbEdCU3pSUkNJNTJXNTRCSWxVZmM3cEdKL2l0czFsQkVTRm41RDZmNlNqNm16elVlYmdNZzZUU0d4Y1EwUmw4empGaGJTQ2dYdVR1Mkp2WlJIR0VVMWc5QlMwY2RVdkJGVjAyTlh1cEwiLCJtYWMiOiI3YWRlMjk2MTdiZDAxNjkyYjQxNzIzODlhNmU2NTZkNmI1MzQzYmY0Yjg3NTFiNTY5ZjFhMjA4NjA0MjJiNWYyIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6IlVROGJsaE1RNFpzVWFUYXNlQjh4dXc9PSIsInZhbHVlIjoiSFFaUDBZSytJTGI3R2lwcGM5SzlhQnV5eEdtNzFPZXFxK0U1Ymx3MytGcUsrMGRhaGMzR0FyQ2xsWm5TWFJuVm5tNDFqelpGdU1udGxnWHZaVWFLUzRUV1Ayajd0QjlLVlFDQmpuRk9ZbzFPTzRWNTZDbUMxQXl4N0JTZHJjV3EiLCJtYWMiOiJhMzE3YmM2MmFkYjY1NjczYjgwNjRjY2I1NTRiOWUwNWM5NGRhNTFkMzI5MGQ4NjhiZThkMmRiYzM3ZTgxMDVmIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET ensembles/create

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET ensembles/AddRegister

Example request:
curl --request GET \
    --get "http://localhost/ensembles/AddRegister" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/ensembles/AddRegister"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6IlpLRUdSL0hiMWJkYkhIcFI4U284UkE9PSIsInZhbHVlIjoieER1V2wvc3ZuYmRFZHMzMGZYRWdCVEYxZDEyM0pGUUxwZGJmV0NHeGNNOXpvcW1JSml1dXAwdDRhcWpGTzNXdUZ4eEVGSWI4ZGt4RU9paVFERjgrSEJWUmFqaEswU0QxRXA4TmlZQS9BbHhPSmpNM1I0NkpLL2QvaE5waFFqeWIiLCJtYWMiOiI2NzUzOWI0NjQwMzFjMWI5Yjc3MDVjYzE0M2MzYzk3ZWE2M2I5NDgzNTQ2NTMwNjFjNTIwMjYwZTJlYmE3NjhmIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6Ik85VGtGeWZtTlJGc09xVThxeU5mdmc9PSIsInZhbHVlIjoiSHRNalB6M0JHaWVVeGU0c0o0aURYdUMrSFdrRnZONDd5bFhLOG11UzA2UFZrNis0dFExMXZGOG9aTkJFK2IyTStGeDBYbGgxTVF2cS9nZVBING9SbE9NRmJlZzk4VHhXbUIwQk1RN3NuMXc2NkhWcnY0NzM3UHI0dWVPS3dKOWIiLCJtYWMiOiIzY2UzYTJiZTQ3MDI5ZDZlOTlkMzAyNzcwZjU3ZDQ3MTgwNWQxM2EyMDQ5M2E5N2ZjNTE1NDRiZGY5NjIyNDEyIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET ensembles/AddRegister

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET ensembles/{uuid}

Example request:
curl --request GET \
    --get "http://localhost/ensembles/00b38797-f288-424f-8cbb-6b723626c782" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/ensembles/00b38797-f288-424f-8cbb-6b723626c782"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6ImNzQytXcXB1SDlEQ0FGdS9mVDNHY2c9PSIsInZhbHVlIjoiSHMzT2M1a3hkT09WZy9pNWxNTE9paGxvNkJyVGxVYWRCbkpQNmFjQlJ2eVBoZTZsUE55TnJYVTd0VjBGelpzeDRTTzlxeENyNFVNUlJxdjlQOTZCRFcrZk1OYTBoMDFWVnVCTTErcFhJY0JRa0J1V0RDQzNUSlgxSVhYOVkyMU4iLCJtYWMiOiI3ZjVmZmM5YWM1MjViOWExOTk0YmI4NTJiMmQ2YWU4OTJmMzY4NWZjZGM1MGYzYjBkNjQ3MjJkODdhNDhmMjE2IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6Ik9xV1NFT2IyZzB0UXg2VjRBNTlIL3c9PSIsInZhbHVlIjoiMC9LV0FZTjh6UWZiN2w4amtsL2N6c1JadmVuTG5YZWtxUFhFQWZMYmV1azVPS1JsZW9ROUl0T0FpdXJqUHgvQ1FIMHFpSmIyNGVVM1FNemlqdXV4ZGJUQjNObW04Ui9FcVZnZHRHSWd2WGJkNFhFbThVVHl5ZXRZbmwyT1hzUXQiLCJtYWMiOiI0NDQyNDNiZTdkMjRjOTA5ZTIwNjFjNmFlOWNmYWRkMmVlZThlZTg4NWU4NDg2MDM0Mjk2ZTg1YjA1ZjNhYTE2IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET ensembles/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: 00b38797-f288-424f-8cbb-6b723626c782

GET ensembles/{ensemble_uuid}/GetData

Example request:
curl --request GET \
    --get "http://localhost/ensembles/00b38797-f288-424f-8cbb-6b723626c782/GetData" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/ensembles/00b38797-f288-424f-8cbb-6b723626c782/GetData"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6IlV1Z1FHNjhCaDM2L01EUUVFZW5uaFE9PSIsInZhbHVlIjoiK1dWZ0tobnhyQnJaYWVnWkNQay9KSWs2aDBFNlNyOHFhRW5yRmx0azNSTmpzT3ZoVFdQK2lFUlFieXIvRTdvVmJwM2x1by96T3BtYXZjZWZ6bmRpa0pBOVIwVkZNeDhCNVRkaVlzMWVNN1ZJQ3dpVHFYOXFzSFJPL0x4UnhRLysiLCJtYWMiOiJkNTBjMGFkZDhhMzM4YmVmNjQzMzZiZDlhYzExYTE1NjUwOTRkYTcwYzE3ODYyOGZlYTQyNTA4NTEzNDM3ODQ3IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6IjY2MEZYMGJGcTByNU9teXR1T2tKQ1E9PSIsInZhbHVlIjoidEhCdUIzVlYvZ2hOUUZiRlBmSlZzc1k4YVl5TWRVbGhXYVJ4WUlRTVdoTkNJSWhYWCtNUC9oWkJ1cUZYUWZKK21nSzc1bHJTTFZUZkxYUWIzZEc5RUVQbE54cU1ueVY5dStRaDFJblZUa3FKaDRmU3pBUDQycVVxUXM2Wis4bVIiLCJtYWMiOiI5ZmE5NzI0NWEzOWU5M2U5ODQxNDk2NGIxNjMyMmMxYTg5OTk5ZjY1M2U0ZmFmYTlkYzExNWNhOWUzNWZmOWNjIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET ensembles/{ensemble_uuid}/GetData

POST ensembles/{ensemble_uuid}/GetData

PUT ensembles/{ensemble_uuid}/GetData

PATCH ensembles/{ensemble_uuid}/GetData

DELETE ensembles/{ensemble_uuid}/GetData

OPTIONS ensembles/{ensemble_uuid}/GetData

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

ensemble_uuid   string   

Example: 00b38797-f288-424f-8cbb-6b723626c782

GET ensembles/{ensemble_uuid}/edit

Example request:
curl --request GET \
    --get "http://localhost/ensembles/00b38797-f288-424f-8cbb-6b723626c782/edit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/ensembles/00b38797-f288-424f-8cbb-6b723626c782/edit"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6InJKSTYwOE1KdXZLRmVQV05lU3cyUHc9PSIsInZhbHVlIjoiNElGZFN4ZnFJSFRrQjBvTFBwd3V1K1hUalh2L29lNVpYeEE1YmJvNnZwVlJQRGhNRjU5QWlrc21tSk10bHhEUFQ0WHZET1pwaHpqa25GUEVJRkYrb1FsU3NXR2EyL1JGZEpSR3ZRa00yTSt3R2FQMGdkYlpNYTQ0T1pqQ2hMQUEiLCJtYWMiOiJlZmU1ZGE5YjcyZmYyOTgwY2NlYzJmNDlmZDVmNTY0M2FjZGYyOWYxNzA3NjIyNTVjZGJhYTRiYTkyNWRhZjA2IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6ImJhblhWZjhQT25QRmlvNVVoS3lmaXc9PSIsInZhbHVlIjoibndIR0VDSVU4MER2MHUwQ3g0MEV5UXMzTzV3SWdCeXhtNFdYdmpabGxOWThhalY5M2wvSVkyK2JlNUYrVC90Uk5abGtMelVYVzZ4RFJvWEgyRnIzTy8xL0hFY0djU0xIcFhpYjRVUVpwWU85MVkwYlRDNXFUOVBNL3BydlZQdGoiLCJtYWMiOiJhNjdlYzVhNzMwMTFmOGUzMDQ2ZmI1ZTE3ZWIyNTcyNDNmMzg1N2RjNTliOTFkYzBlYTg5ZmJhYzUyNGNkYTQ1IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET ensembles/{ensemble_uuid}/edit

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

ensemble_uuid   string   

Example: 00b38797-f288-424f-8cbb-6b723626c782

PATCH ensembles/{uuid}

Example request:
curl --request PATCH \
    "http://localhost/ensembles/00b38797-f288-424f-8cbb-6b723626c782" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"architecto\",
    \"username\": \"architecto\",
    \"password\": \"|]|{+-\",
    \"description\": \"Eius et animi quos velit et.\",
    \"registers\": [
        \"architecto\"
    ]
}"
const url = new URL(
    "http://localhost/ensembles/00b38797-f288-424f-8cbb-6b723626c782"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "architecto",
    "username": "architecto",
    "password": "|]|{+-",
    "description": "Eius et animi quos velit et.",
    "registers": [
        "architecto"
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH ensembles/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: 00b38797-f288-424f-8cbb-6b723626c782

Body Parameters

name   string   

Example: architecto

username   string  optional  

Example: architecto

password   string  optional  

Example: |]|{+-

description   string  optional  

Example: Eius et animi quos velit et.

registers   string[]   

The id of an existing record in the registers table.

DELETE ensembles/{uuid}

Example request:
curl --request DELETE \
    "http://localhost/ensembles/00b38797-f288-424f-8cbb-6b723626c782" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/ensembles/00b38797-f288-424f-8cbb-6b723626c782"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE ensembles/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: 00b38797-f288-424f-8cbb-6b723626c782

Error

POST errors/{error_uuid}/set

Example request:
curl --request POST \
    "http://localhost/errors/e64bdc0b-e0fd-443b-b751-2c0d5be6d741/set" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": \"architecto\"
}"
const url = new URL(
    "http://localhost/errors/e64bdc0b-e0fd-443b-b751-2c0d5be6d741/set"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "status": "architecto"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST errors/{error_uuid}/set

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

error_uuid   string   

Example: e64bdc0b-e0fd-443b-b751-2c0d5be6d741

Body Parameters

status   string   

Example: architecto

POST errors/{error_uuid}/report

Example request:
curl --request POST \
    "http://localhost/errors/e64bdc0b-e0fd-443b-b751-2c0d5be6d741/report" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"report\": \"architecto\"
}"
const url = new URL(
    "http://localhost/errors/e64bdc0b-e0fd-443b-b751-2c0d5be6d741/report"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "report": "architecto"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST errors/{error_uuid}/report

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

error_uuid   string   

Example: e64bdc0b-e0fd-443b-b751-2c0d5be6d741

Body Parameters

report   string   

Example: architecto

Form

GET forms/create

Example request:
curl --request GET \
    --get "http://localhost/forms/create" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/forms/create"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6IkFtMFFIWXRGNGxnSTJhOE5qNWRiaVE9PSIsInZhbHVlIjoiMGhYckF1WWI3VnE4eHpXMVVNN1djSUdSWmZaTlFvSm9iMTh6L210dnl2MEY2L0FwQnVrTElDMFBPMUk2aUMyN2UrY0FMRjlsNm1JdFc0eHEzNkp4bEMyb0Vja0dYUFZwYWJoREpLcUVScGdLK0NMZzY3WVRKTDRDamtXcFJCL0MiLCJtYWMiOiJmNjUyOGMyYzg5MzQ2ZDIwNWNhMzlmZjQ3Mzg1MjczMDdhODI5NTJmNmM1ZGFkZmZhNTQ3ZGU0ZGIzZmVjZTJjIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6ImhxTUVhb3Boa1dVVmJZTHJLWHZuMlE9PSIsInZhbHVlIjoibGVKMXVOK3I3a21namRlVTMrL3M0dXNYcmhhRHZtUUVkdmdreHNrOGhRa01xci9nQWEySlRJNWczSk92dC9zVnhmTEJkYnYzMU1UZG81QlFCU2hpcVZpdmRkUmZoSld3d2FuMDByS0RwNk4vTlFFYVIwbGtFd3dNdFdoS1U4elgiLCJtYWMiOiJiYmYzYjJjMGU3M2Q2YTIzNTEzYTc4Y2NlZDg1NWU4MDNiNDBkZTc0NzY1NTAwNTE0NTM0Y2Q4ZWQ5NmE5OWU1IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET forms/create

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET forms/{uuid}

Example request:
curl --request GET \
    --get "http://localhost/forms/72c348ca-95e2-49fd-9450-869d8c23c350" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/forms/72c348ca-95e2-49fd-9450-869d8c23c350"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6Ik1mdGFvaFY5b3Q4UGU1MWtYeVNwL1E9PSIsInZhbHVlIjoiTUxUdHl0aEtSbUl0NDBPenAvcU1TNTR5ejcvZmJ0N0JmZDcwcnR0QWx1amlHRXp1aEMwV3I2eDZXakJHd0E0MXBYZTQxY2VOVkczaEJZdHAxQ3BpMkVveVlOaVdPUG1xUzFlVDBhbk1rZjltUVVsMDJBU2kxVjFETk9CRzhSenoiLCJtYWMiOiIyYWIzOWM1MjU0MzIyY2EwMzE1OWM2NDYzNTdlMTcyODAxNDI0ZjZiYzM4NmQ5YTE3NWQxYWRkMTdhYTQ4Yjk4IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6Imt4Z0JNU1NBMUVXaUxaczVid0lTMXc9PSIsInZhbHVlIjoiZGNnTjdINE9TSTNZUVg0eXpwK1dJR0ljWFlka3NoNnA4RzQyYzNrNTZERnRjZG1YVUhTN0ErOEFnQ2psOEJYQUlRMy9iVnpKcitpVW9XT1FqejlRa0lOMXBzRCt0dGljWmhLOWFzSHA2a2pITG5LV0FqSEIycG9oRU01a3kwU2kiLCJtYWMiOiIzMWJiZWVlNzFmODRlNjNkZTNlMDE4NmIwZjhhYTY0ZDdhMzA3ZDhlMjdjM2RlOGEwNDg2ZDhmMTQzZDgzYWZjIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET forms/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: 72c348ca-95e2-49fd-9450-869d8c23c350

GET forms/{form_uuid}/edit

Example request:
curl --request GET \
    --get "http://localhost/forms/72c348ca-95e2-49fd-9450-869d8c23c350/edit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/forms/72c348ca-95e2-49fd-9450-869d8c23c350/edit"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6ImtJN2tZb0pBVi9tTVR3Z0g1V1cxa1E9PSIsInZhbHVlIjoibTlJNHZ5cDVCbHpLQ0dqQWJRd0hYNURrTDZMUlI2RnozQTI1ZEdOMVJKdzVwVWE0NE9pUlFxN3hxY1ZnVFZtOEVVb09TaFRZTmNVeFFvM2EzZ1VjMjJmRkE4RUNwZCtaMGladU1LSWxiMGJnWGRpczBleFhQNENVNU9INFg5dHIiLCJtYWMiOiJmYTIwNDdiMTlhNmU5YzAzZDMyYjU0ZTA4ZjY2NzFjYzZhZDc5MjYyMjUyZjhkOTY3MzFjNDQzMTBiOTU3ZDdkIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6IkhweFBjZCtQT0o3Ri9DUlArL1Bidnc9PSIsInZhbHVlIjoieEc4b2dBeVVGaXRCbGdtUG9QWEtqWDRtTldaYUVHN0VPdjBUY01ZOVdZZTAwdHZnaFhTUm5aeVlHdmxvdlQvanlkc3B4YUtuNy9IR1dseHdCcW9lQlE3Q2hGTkpGU0FLeVUxWVkxeWVaU2V5Zk9DMGRNZzFId0U2K1RNdE9PekkiLCJtYWMiOiJmZjBjYTUzZGJmMmQyN2E3M2IwNjEwM2ZmYzRmN2RmYjU2MWYyOGU5NmM5M2ZmZWQyYzg5MGE5YjA5OGEwOGJjIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET forms/{form_uuid}/edit

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

form_uuid   string   

Example: 72c348ca-95e2-49fd-9450-869d8c23c350

PATCH forms/{uuid}

Example request:
curl --request PATCH \
    "http://localhost/forms/72c348ca-95e2-49fd-9450-869d8c23c350" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/forms/72c348ca-95e2-49fd-9450-869d8c23c350"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request      

PATCH forms/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: 72c348ca-95e2-49fd-9450-869d8c23c350

DELETE forms/{uuid}

Example request:
curl --request DELETE \
    "http://localhost/forms/72c348ca-95e2-49fd-9450-869d8c23c350" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/forms/72c348ca-95e2-49fd-9450-869d8c23c350"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE forms/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: 72c348ca-95e2-49fd-9450-869d8c23c350

GET forms/{form_uuid}/content

Example request:
curl --request GET \
    --get "http://localhost/forms/72c348ca-95e2-49fd-9450-869d8c23c350/content" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/forms/72c348ca-95e2-49fd-9450-869d8c23c350/content"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6IncxKzdrMEUxa3BxU002ZEhhaUQ2TGc9PSIsInZhbHVlIjoieE5QQ2pJeFMwYnBmVVFpaEJUMVoxVEF6VE9TL095eFI5d1I0VHFxVnloQW5WYkRNa1Mrb2p0a21YUms0aDZ0VTZ3cnQzcER4cW5VN0RpWDdXTExCSHM2RmM1NWRRQXVKWGZsNmtCdGlxL2t4R2ZaYXl0aWZMd2RheUZhQUQzbUkiLCJtYWMiOiJiMmM3NThkM2E1ZjRjNDk3NDNiYzE0M2JjOTFlNzBmNmUyMTY4N2E2NzlhNGRlMmVjZTQ0NjQxOWEzMWI4YWJhIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6ImE1OTdhRFdJbEs1WTVnSWlXTGlaVnc9PSIsInZhbHVlIjoiUlQxS1J6SEVlL2ZiMmc1eTlmQWVScFZoejBMOWFsVlZsS3FhNHl3bWtLcHg0M0RXNWlRUVkzNFZHdUN4TU1kdm0ram8xa09LQ3FQbDBZdkZiWWdKYzdkbmtndjczQ2g2NGh5Vk52WDNoZlBxM3huTDZ3MHhMRWZWaWJDdVdZU0wiLCJtYWMiOiIzMzJjN2RlYjA1MjMwNzVlZmExMmM0OTZlZDFmNTNiN2JiMWUwOWYxZTAyZjQ2ZDY3YzFkNmZjMzVhMTBhZWJlIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET forms/{form_uuid}/content

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

form_uuid   string   

Example: 72c348ca-95e2-49fd-9450-869d8c23c350

NeuralNetwork

GET NeuralNetworks/add

Example request:
curl --request GET \
    --get "http://localhost/NeuralNetworks/add" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"property\"
}"
const url = new URL(
    "http://localhost/NeuralNetworks/add"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "type": "property"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6IlBEZlg1OXM1TDlYVzlBS2l0VjVGVkE9PSIsInZhbHVlIjoiaE9GdDdrNDRtMXJxOWJGY1Q2dGx2NVhmWkZFZThObCtSdVNzV1VFZ1lGMVIzZ3BxWi9CWGlQN3B1UFdEZlN0aTQwaVBDVWx4cmp0NXlTY1hFeCtqL0dTNitNc05oenlHS3FnQkhNaW1CcTVJL0RNSlJXNGgwTEJhYnFPc1VlTXAiLCJtYWMiOiI4NjVhODQyOWFjYTQ0ODU3NmY4NDI1NmViYmVkN2Y2NWY0ZDZmOTViZWZlNjcxMThlMmU1NmYwMDlhNzlhZjYwIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6IjVYbndRSjBqM21mUlIxM3hxVVVDN0E9PSIsInZhbHVlIjoiZEhpT2NZRlJ6bnFUMnF0eklJMWZTOFJWSVNyNzFoWXYwMGVBOGp5cXBZU0NNS0xQZzBlQ3NyYTRVTFYrRGhtNXVMS3VrTE9WT0N0QkUyaFBibnRGcHBjU0VzYUtiQ3MwZVIwYjV3RHM5UTExKzQ0NUlFU0x6RlA2ZUFNZ1MzRisiLCJtYWMiOiI4NjkyZmEwOTVlYjI2OWIxYTNiNjU1NzEzMGY0OTUwZWFlYjNmZTBmNDcyODA5ZGM4NWY0NzhhZDE0NGY4N2M5IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET NeuralNetworks/add

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

type   string  optional  

Example: property

Must be one of:
  • register
  • property

GET NeuralNetworks/create

Example request:
curl --request GET \
    --get "http://localhost/NeuralNetworks/create" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/NeuralNetworks/create"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6Ik5MVE1kVU1vQ1NaNmdjSjdiM2Flanc9PSIsInZhbHVlIjoiempYQWtDREdrYm5SNHdHK25Bd1RJYzZGMk9GRmo1RUZCMVJranNmS3FFd3FmM3JjWFJFbnB4Wm1HcTdISGRJaUJoMWdtVytKN096SXdzL1lwcFJpbzNXdUlRci82Z09TNTUxZkhjSmQ1L3laS2JLL0s1dDhHYTFxVTlDdnlxSVAiLCJtYWMiOiIyY2VjNTE2ZWZjM2QyZGViNGZiMjc1MTg2YTkwYzhhMDBhNjM4N2NkYmZiYjZiMWM3YWRmNjc1YzI4NDE5NGZlIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6ImxWS3c5eVYrYjVzYzYzZ2UzaUlPbGc9PSIsInZhbHVlIjoiVTVQS3RQVnlFZDNHU2xzcytMK01IbDV3SDRCQU9kamxCbld0ZldFdER4dmpjUkFOeS9xa2VmRHFMNFpOYXVub2Z4QndNd1ZYQUlGdGhmNmxEQlZRUXVQMVViVzJ3Wm0veWZXT0FJL2JZQ0FzUFFGUTN1RzlhV3NIN3RPZExoeS8iLCJtYWMiOiI0OTQwNWQ1ZGU2NzUzM2E2OTU3Nzc1MTg3YTRhZWYwN2UwYTRkZTNhOTA4MWYzNGY5NjgxNjdjYTEwYTBjYjgxIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET NeuralNetworks/create

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET NeuralNetworks/{uuid}

Example request:
curl --request GET \
    --get "http://localhost/NeuralNetworks/f4d375a7-1b15-475a-8a7b-8171794c0429" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/NeuralNetworks/f4d375a7-1b15-475a-8a7b-8171794c0429"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6ImdkeWNQbEx6TDNraFZBU1dQSldsN2c9PSIsInZhbHVlIjoicm40NlJzb2xqNlVnUm5GYkZOSmVxZ2lNQndFc3FraWhjTnpYY0NyL0k3eG4ydE1SNk1hRit1WFpZVFBIQjZoMlphMjluNUFmK1llWnVzU01OQnBCWG0vbHJ4TDhIeUZneWxCRklZY3Y3ZXNKSWZ3dlF0ZmtmR1VNdE1ZSGNwT1AiLCJtYWMiOiJkOGZjMmZjZWM3OTAzMWVhNGY1OTNkZDk1ZTBiYjdmYTVmODgyYzk4OTllODExMGZhMGU3M2Q0MDNkNGI4NGMyIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6IkRWSnM5RTRKM1ZOdDZLaXZheVBmOEE9PSIsInZhbHVlIjoibHJhK0NwVFFjZ0R5bDVoU0ZyVEVRVkpzZEtFSGIxZ1VaZ1A0NHFuMVpOSWVQRXQ5TUhCbzYzMzlKVmttT1R0d0JySWdwUnJPVzhlNXNwR21hWGN2WEp1d3hvcHdNd1dDOVpMNWlyTDAxUFdOWEpXL2tyUmRxY01iVXBxZS9lVmIiLCJtYWMiOiJlYjRiNzNiMzVjNjkzNjA2ODJiZGFmNzAxZjQyYzQ4MzEzOWNkZjJiMTk3NThiZjM5NjUxNDMxMTY1MWM3ZTM4IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET NeuralNetworks/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: f4d375a7-1b15-475a-8a7b-8171794c0429

GET NeuralNetworks/{NeuralNetwork_uuid}/edit

Example request:
curl --request GET \
    --get "http://localhost/NeuralNetworks/f4d375a7-1b15-475a-8a7b-8171794c0429/edit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/NeuralNetworks/f4d375a7-1b15-475a-8a7b-8171794c0429/edit"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6InZuWldhUnJ6aXlHdzlkZmFMTXh3RHc9PSIsInZhbHVlIjoidmZENVlnaThJRFRVdHo2Zy9nS2Z6VEtSYlNqaitVaXIrTjlSN3Zqb3FwNHRBcjJDK3pQNkNtb2JvaE5CMjlQUGE2REhiODJkQU1GTkRSbWZlVkxET3N4VW5lUTBCbTgrR0RtZ1hzbVFTUzdWbzd0RHU1OWx1aVF0K2NSb09yU0UiLCJtYWMiOiJlMzQxMmRlNmEzZGM3Y2QzNWYwZTEyMmZmNTZiODBhYjNlOWI1MWFjMDQ1MGM4ZTQ5ODdkMTNjMmM1MjY1N2MzIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6IkpzeEd5YnE5TVZvTGhUS3dEZWcyaUE9PSIsInZhbHVlIjoiOXhHY2hBZDViYy8xL3ZUQytURmNKSkdmTzBxM2NSSGFBYll2cTUvckRsWXk2K2ZPako3VlBRN1lSdUQ1QUJFL09OZkhUWE40d0lWSjNNMEp6MFk4WjdBQUZTL1FiM2dFd0J3YldNcGVudURZaEV3VlhKV3NhQWlIUEkxNnFBdFUiLCJtYWMiOiIzOGJmZjg5YTYxODQwYzYwYWE0NThkYTJmMGZmNjhmMzNmODMxN2I5NTBiMmEzY2UwNzc2MGQxN2I0YWI2N2MxIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET NeuralNetworks/{NeuralNetwork_uuid}/edit

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

NeuralNetwork_uuid   string   

Example: f4d375a7-1b15-475a-8a7b-8171794c0429

PATCH NeuralNetworks/{uuid}

Example request:
curl --request PATCH \
    "http://localhost/NeuralNetworks/f4d375a7-1b15-475a-8a7b-8171794c0429" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"architecto\",
    \"registers\": [
        \"architecto\"
    ],
    \"entry\": [
        \"architecto\"
    ],
    \"weight\": [
        22
    ]
}"
const url = new URL(
    "http://localhost/NeuralNetworks/f4d375a7-1b15-475a-8a7b-8171794c0429"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "architecto",
    "registers": [
        "architecto"
    ],
    "entry": [
        "architecto"
    ],
    "weight": [
        22
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH NeuralNetworks/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: f4d375a7-1b15-475a-8a7b-8171794c0429

Body Parameters

name   string   

Example: architecto

description   string  optional  
registers   string[]   

The id of an existing record in the registers table.

entry   string[]   
weight   number[]   

Must be at least 1. Must not be greater than 100.

DELETE NeuralNetworks/{uuid}

Example request:
curl --request DELETE \
    "http://localhost/NeuralNetworks/f4d375a7-1b15-475a-8a7b-8171794c0429" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/NeuralNetworks/f4d375a7-1b15-475a-8a7b-8171794c0429"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE NeuralNetworks/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: f4d375a7-1b15-475a-8a7b-8171794c0429

Notification

GET notifications/modal

Example request:
curl --request GET \
    --get "http://localhost/notifications/modal" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/notifications/modal"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6IjJ5UjlvL2N5Q3JXSXpzdU1ucDIwR3c9PSIsInZhbHVlIjoieHN3UUZWR1V2MGJTRzhyL3VRNUxGT1pFYnVINEREZlMwR1Ird1lvajRzUGprR0xKa00rNGxvSHo1MGlvZGM3RXRNRlkrTEJweE5qOVFKLzVHMzhTei9DZGtNOGtaY2l2dkFPTnIycW52OG8vMmJNbGZnMk41LzhmSEI4UVNBVnUiLCJtYWMiOiIxY2UyZTkyZWFiNDgyYTU4OGMzYzhjZTdiYjYzNmE2NWVhMjU0YmJlZmQzZWViYzdjN2E4ZjRlNzI2ZWJkYWMxIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6ImlOTlM0NmxFS1ZiMytWcjlnOEg0bWc9PSIsInZhbHVlIjoiTzhPQnpYNElyV0xEOWJGWWNibGErQThUMnQrKzJGTGhZVzFRZDNERzBKd3JSRFhPTlZHRXUyakhMVXE3b1dqUmZ4bTVLaDJWR0hjWFA4YlVnL3lPOXhueWh6Zm8wbm1ydFhXMk83emlBMTVVMGY0Ynh2R3VJUGZ1TUlVaktLTU4iLCJtYWMiOiI4NWUzNDA4ZWI3YjM0NzYwZjI0MjczNTNjZGY5ZTY4YzRkNjNiYjQwNzc3YWY3NWI4Y2M5ZDRiZTA4NzM4MmNiIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET notifications/modal

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET notifications/create

Example request:
curl --request GET \
    --get "http://localhost/notifications/create" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/notifications/create"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6IkNxcUs3UEh5cmJjU0dSWUQya0dqVmc9PSIsInZhbHVlIjoiM2RXaDUyRWpKUkFxNi9TblRTSFNvUlg0cFRxY1BZa2p2RVBEWDBLMXFkWU9veTRJVHFSUDlLcEFRVGhNbVQ3WGY3azR2UkFmT2NOSTArOTBtVHJVNjh2K3NyQldwNExPUkNBYmp0Wmp4QVVYZTR2WVpFTVZYekU3K1YxQ1lVS2oiLCJtYWMiOiIzNDZmNzRkZWFiMmQ4NTI1Mjg0NjY2MTE1Zjg3MDY2NjM5ZWQ0MjkwZWJmMTM1MDY3Yjg1ZjU0ZTIxMTkwNjc0IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6Im9qQTgwQ01KYWl5TEZKOG1SNHNNN3c9PSIsInZhbHVlIjoiYmtBUS9HSGN4L1dsdHNIRXVacExIeEtRYmlncXBFSSsxVXVxdkY2a3lWMFFwSEN6MmRzc0JaZjkwNU5qbFF1bzc1RVlBdGZEUlZpZ2M5UWZHTVA2ZldFL1pURitmL3BLMnk4SG56Yjg3S1RaYlE5aHdxNVV2YWtYcWMrOTdFVVQiLCJtYWMiOiJlMTdhNmEyZTc5OWEyY2RkOWY2NGE5OWM0ZDg3NTMzZmU0OTI1M2FmNTM5MmQxYjg0NDIwOTU4OTMyMmFkNzdiIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET notifications/create

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET notifications/{uuid}

Example request:
curl --request GET \
    --get "http://localhost/notifications/09988ffb-308e-414b-83d6-e6e61e88d4ab" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/notifications/09988ffb-308e-414b-83d6-e6e61e88d4ab"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6IjU1YURQV01FUTZTSFR2Y1ozYkNuelE9PSIsInZhbHVlIjoiZFlROVRFQXN5V1RubWZiZ2ZYTUdCZy9keGs0ODBGNDhHbE1qVDBic1NwVUZkNjhzSHFlSGl0YVc2akhOdzhIRjNpNkxsODJvb29ScEEvdm1wVDZxUXQyTExRUXJrV05lZ0NDWjE0RUtMUWxlSjhwYVdub3MvL2hoanFnVGZRRDQiLCJtYWMiOiJkNTNlZDM0OGYxMDYwMWQyMzhkNjU1NmUwMTU2YjRjOWExNzVhNTNmZTBkNWMyMGNkZGM0MTNmYzAyNjlmZTVhIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6InpVOE9DNVd4RTRFNkRIVU8xYkdNaEE9PSIsInZhbHVlIjoiQ2VDaVBYajZUOU5JMy9nU2pURVd0Tnd4YmQ5ZU10enp4eGorSGJQY3RScjVFU2FVK21mKzNrbGpLa1NaNFRLaEh3ZjJDMzJVeGV0NCs4NlpuaFNueGdNWnhKc0l4TFJ5OVQrbXpwcHRDMTlsVmVpM05OTzlFS3UzZVhBenFqNU4iLCJtYWMiOiJjYjI0NTYzNzM2MDk2ZjhmNDg3NDJmMWUxMTliYjgwNWI5M2NiOTJhZmI2MmIzNmU4YjVmYjlkN2Q5NzEwNzgwIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET notifications/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: 09988ffb-308e-414b-83d6-e6e61e88d4ab

GET notifications/{notification_uuid}/edit

Example request:
curl --request GET \
    --get "http://localhost/notifications/09988ffb-308e-414b-83d6-e6e61e88d4ab/edit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/notifications/09988ffb-308e-414b-83d6-e6e61e88d4ab/edit"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6IkRPNXZyeE9MbFlsOFZSbWVUS24zcWc9PSIsInZhbHVlIjoiQWFTcG42WEg2YithSnNSS2pSdnpreGhueXhNMjlEWkc5bkZWOG9FSlhISytMdG8ycGxhRk5IYzdzME03Nnp2THdhbkdjaFNra0xLOUdNOG1ydGNRMGk5UWwrNVFVZ3FRR0Z5YjllcjJtK2ZvSmVwczd0U0kyNU9JUDVmRUpNb00iLCJtYWMiOiIyYmRmNmIyOTdlOTRiYjNkYjhlYzMyNzZlMjUyNzNkMjdhNzAzYjAwYTAwMmY3NTQ5NjRiYTUzNmQwYjdiYzRmIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6InVnU3lKUnY0VlFHcHF0cUZhSnJVQVE9PSIsInZhbHVlIjoiTy9QUDBnc25rK2x2bll0VnN5OHdnSSsyUVRxTm94ZiswR29nOUR5RzdWQ1ZISEtuRnBOZWlBVU4zbDQ2aTZyM3hPNnFUa1JoMkluSjdOSGgyd2hWclo2cGZGRlJxS0RRYUNwc2pZRXpCYThQUk1ieTZWTnZ5cm1JZHZSTXFKTFciLCJtYWMiOiI5OWY1YzYyNTBkM2U4OTcyNTkzMTIyMDNmYWFjMDhiYTZmZjBkYmUwOWVjNjQ3NWY3ZjU0OWQzYzQ0YjQwZGRkIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET notifications/{notification_uuid}/edit

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

notification_uuid   string   

Example: 09988ffb-308e-414b-83d6-e6e61e88d4ab

PATCH notifications/{uuid}

Example request:
curl --request PATCH \
    "http://localhost/notifications/09988ffb-308e-414b-83d6-e6e61e88d4ab" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"architecto\",
    \"body\": \"architecto\",
    \"title\": \"architecto\",
    \"description\": \"Eius et animi quos velit et.\",
    \"type\": \"Warning\",
    \"users\": [
        \"architecto\"
    ]
}"
const url = new URL(
    "http://localhost/notifications/09988ffb-308e-414b-83d6-e6e61e88d4ab"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "architecto",
    "body": "architecto",
    "title": "architecto",
    "description": "Eius et animi quos velit et.",
    "type": "Warning",
    "users": [
        "architecto"
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH notifications/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: 09988ffb-308e-414b-83d6-e6e61e88d4ab

Body Parameters

name   string   

Example: architecto

body   string   

Example: architecto

title   string   

Example: architecto

description   string  optional  

Example: Eius et animi quos velit et.

type   string   

Example: Warning

Must be one of:
  • Info
  • Warning
  • Success
  • Error
users   string[]   

The id of an existing record in the users table.

DELETE notifications/{uuid}

Example request:
curl --request DELETE \
    "http://localhost/notifications/09988ffb-308e-414b-83d6-e6e61e88d4ab" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/notifications/09988ffb-308e-414b-83d6-e6e61e88d4ab"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE notifications/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: 09988ffb-308e-414b-83d6-e6e61e88d4ab

POST notifications/{notification_uuid}/notify

Example request:
curl --request POST \
    "http://localhost/notifications/09988ffb-308e-414b-83d6-e6e61e88d4ab/notify" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/notifications/09988ffb-308e-414b-83d6-e6e61e88d4ab/notify"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request      

POST notifications/{notification_uuid}/notify

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

notification_uuid   string   

Example: 09988ffb-308e-414b-83d6-e6e61e88d4ab

POST notifications/{notification_uuid}/dismiss

Example request:
curl --request POST \
    "http://localhost/notifications/09988ffb-308e-414b-83d6-e6e61e88d4ab/dismiss" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/notifications/09988ffb-308e-414b-83d6-e6e61e88d4ab/dismiss"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request      

POST notifications/{notification_uuid}/dismiss

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

notification_uuid   string   

Example: 09988ffb-308e-414b-83d6-e6e61e88d4ab

Project

GET projects/create

Example request:
curl --request GET \
    --get "http://localhost/projects/create" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/projects/create"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6IlVVZjZ1MWJzSFdXanNDT0FTT0RuQnc9PSIsInZhbHVlIjoiMmdxVWFaT2IxT05lKzJ5bGhFSGQxSzZPV0lsQzZoQVVOaXlVREZrMVArTXVpT0h2Ym9IUVdVcnMrc2lpdzVRTU9QRjhsQ3Zta3h1RGZzZ3JVT3BFYkZZVUhiQXNQZ1BsT2Yza2xBc0d1dzIxalI4aVJvWjJDZlNuNkRGaDdWRFQiLCJtYWMiOiI3Y2M5NDZlYzZjYTQ0MGYxZWRmN2Y5NjVhY2ZkNmEwMzQ1ODMwOWNkOTc4NmFmOWI5NTg4MmExOGRjZTk0YWQ1IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6IkhmQmR6TXRzQmhiQVBKejd6KzRWNWc9PSIsInZhbHVlIjoiM1h1UHpuWnlFSkcvYUJvWE9zeEY5dklHVE1WMHZxcEtmOTBDeENjczh5b1ArTFFzT0dkRGp0Yk0yeFFZajQ4dU9rVmt5K3pyOEh6MGlMdEF5YUlJNEV1a1pMYzFPZ0hDaEhDYXZoNzZFS3R0SWg2OGFzYWwxSUhzWCt0ZmFSZWgiLCJtYWMiOiI0NzBiM2MwMmRlMmFhM2U1NjAxZTkyZjMzZjYzZmQwOGEwYTE4NDJkNTQzY2E1ZDJmN2I0ZWY0NTJiMjZkNTRiIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET projects/create

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET projects/{uuid}

Example request:
curl --request GET \
    --get "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6ImZmZnM0cHFWdk9rVkg1VnBONm9ITEE9PSIsInZhbHVlIjoiUHhpZ3lOQnI1bldvWGl0TDVLdzBxcEVHZE5MampDRCtOYkk4ZHI3MTdDMzhrZkZmSzJTaExwbjBFWGdZOWQxQTJXcWl1RmY3eWhpUFQ5MVZ5M0I5TGNQalZPYVozbDBsUVlJM2ZZcWpNRWRKSGtpQi9hM2RYSHZvSEFHQ1lZbWsiLCJtYWMiOiI5NjliOWFkMWFhNTdiMTFiYWQ1NDY5NjM0Mzk5MTIzNGJkMjRlOGUwODdiMzAxODQyZDdjNTE2MjZhNWZiMzcwIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6InRXWHJFcThlY0lpZzhOdU5WaHlsb0E9PSIsInZhbHVlIjoiU0RiUE1zKy82T2prOXJsMHplbXp0dXRHZUlScm5Md2ZQUUJKcmxXRU5kdDQ4OUYxbFUyNVprV3pIaTZVMSsrNjIzZVVlV2JlNVZSd1h2ZlB5THVWZWVSSjIxZUNoRjhyTDBBWVAvZzZPKzNNbXVNVVdlcjRvV2pmNEg3clh4WngiLCJtYWMiOiI1ZDg3YjU1YTM2MGJmZGY0YWM4ODA2ZDRiY2FlNjIzZjBmNTBmYTIyM2M1ZDYyMGQ3YTkzNmY1NTM1YzNmNjAyIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET projects/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: bc09e9a9-4805-4988-8a9e-46e3673b1731

GET projects/{project_uuid}/edit

Example request:
curl --request GET \
    --get "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731/edit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731/edit"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6Ikh5dFdGK0JJemU3N3ZwM0wyVkM2Rmc9PSIsInZhbHVlIjoiQWJhWEl2SzdWMXNjL3Y5WDZOalM1WVhtY0FwTTlGY0VWNUpMU1NJZ3FxdytUVWtmRUZCVVlncTB4MEhTSWlDQlRoS2d4aUl0OHlvUzN3dndkVGJZM3ZsMW44WEVORHFxSTlRblRRZEVkaE9LeEtoK3dFdVNYNm85WkhKU2EvcDgiLCJtYWMiOiIxOWM2ODM1NmE0NWFhNGU1OWY5MWVkOGFiNGNiZWEyMzQ0YzM0NjlmNWIxODhjZWVlMWEzZDRhYTE5NTBkN2JhIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6IitDMWRNYWVkeG1HWGxqTkFjMWYwQmc9PSIsInZhbHVlIjoieGVjUUNwdnVCTnlDNk0rRlVjKzdHZ0Z3cGtRdE12UXlVR21EUWFEQ3RCOVJNNkx0VEU3elVKLzlhaUhzd1dYQXhhM0ZPTG5nUnNkYm5zVmFwUm94REVzdmJ1RE9KdUJoVmliQ1ZFc25sU3U3ZkdmVHN6VzJKQmZkejdhdmJ4Ym0iLCJtYWMiOiJmMTllNjFiMWJhYjUyNDM1NzI4ZTY1NzBjMzA2NzkzMGM1YjhiNTljNjA0ZWVhYmRmOTBiMjhkMGE3Y2VhMGJkIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET projects/{project_uuid}/edit

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project_uuid   string   

Example: bc09e9a9-4805-4988-8a9e-46e3673b1731

PATCH projects/{uuid}

Example request:
curl --request PATCH \
    "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"architecto\",
    \"city\": \"architecto\"
}"
const url = new URL(
    "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "architecto",
    "city": "architecto"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH projects/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: bc09e9a9-4805-4988-8a9e-46e3673b1731

Body Parameters

name   string   

Example: architecto

address   string  optional  
description   string  optional  
user   string  optional  

The id of an existing record in the users table.

city   string   

The id of an existing record in the cities table. Example: architecto

devices   string[]  optional  

The id of an existing record in the devices table.

DELETE projects/{uuid}

Example request:
curl --request DELETE \
    "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE projects/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: bc09e9a9-4805-4988-8a9e-46e3673b1731

Register

POST devices/{device_uuid}

Example request:
curl --request POST \
    "http://localhost/devices/656355e9-2e31-45d8-bb36-c488384e3310" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"unit\": \"architecto\",
    \"title\": \"architecto\",
    \"permission\": \"ReadOnly\",
    \"type\": \"unit8_t\"
}"
const url = new URL(
    "http://localhost/devices/656355e9-2e31-45d8-bb36-c488384e3310"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "unit": "architecto",
    "title": "architecto",
    "permission": "ReadOnly",
    "type": "unit8_t"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST devices/{device_uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

device_uuid   string   

Example: 656355e9-2e31-45d8-bb36-c488384e3310

Body Parameters

key   string  optional  
unit   string  optional  

Example: architecto

title   string   

Example: architecto

permission   string  optional  

Example: ReadOnly

Must be one of:
  • ReadOnly
  • ReadWrite
type   string  optional  

Example: unit8_t

Must be one of:
  • none
  • int
  • float
  • bool
  • string
  • binary
  • unit8_t
  • unit16_t

GET devices/{device_uuid}/create

Example request:
curl --request GET \
    --get "http://localhost/devices/656355e9-2e31-45d8-bb36-c488384e3310/create" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/devices/656355e9-2e31-45d8-bb36-c488384e3310/create"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6InRZdWxobmhMY2FyZkdIbGlLaVpPa1E9PSIsInZhbHVlIjoiL2ZuMFVYek81T2VuZ3FTQWVodWNHVUZVNW9aOGMvNmhRQ0JranBpeGxGOGcrZXpteTJlV0x4amFkTmtpMDdObVRqYm9TS1NNSldnWjRtZzd6MEVIQVhMdE41a250ajZ5THZjL3k0bHJDNmRxR25uR2thOUVBdE9ZK3ZlY0g3MEgiLCJtYWMiOiI4MWM5OTYxMWQ2NjU3MWNhZDJhZTNkNzljMTNkY2U1NzFlMTc5NDM4ZTNkNDM0ZmFkMThkNWNmY2RjMmZmNGM5IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6ImV0SVI3NEVaZE4xYmVmL2RrSERxTlE9PSIsInZhbHVlIjoiY1NORHZOQ1BJaW5NY0RvQko2Mm1mcWRWREdLdXNpWFo3cGdINUJ4US9qVHo1RmZXamp4S0J6Vlo0RkQyT04rNHN5a1QxbXQ2K1M4LzdDcW9FWnV5c3NuYjRxb2pRcHRybFNQb29VOURZdURUaEEyRFFZS2kzdGR0UXF4WWI3OHkiLCJtYWMiOiIwMWMwMWViOThkYzM2NGM0N2YyZmNmZDU3NmQxYmE2OTQ5YTlhZWE3OTNjZjI3MzJlNTZjNTBhN2JkNWM3NTBmIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET devices/{device_uuid}/create

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

device_uuid   string   

Example: 656355e9-2e31-45d8-bb36-c488384e3310

GET registers/{uuid}

Example request:
curl --request GET \
    --get "http://localhost/registers/9960e64e-d627-4dac-9d2f-bd0debb65c9a" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/registers/9960e64e-d627-4dac-9d2f-bd0debb65c9a"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6InYyTHh6RkN4dmRVRkNuaUlwMWtCa1E9PSIsInZhbHVlIjoiYXlwaEFmdGlwZTVxaW5KclNpYkRCUGw5eUpzUVRRdTdXVkFicGtWWS9jd3lvQnhTTjF3bi9PT1M2N0lSQlhYSjE0Q1lCalppbis1dndjTDA3N21xV1BoWWVXZU1NVVBIanpMeUdkVm5zdURzcGJnYk9zUkNwU21ZNDhIb0c1WjUiLCJtYWMiOiIyYjUwMzg5NWI5ZTFiNjEwMWQ3MTY0NTg1YWVkNzM2NzBkNWNhZjAxN2Q3YzAzZTE0MDgyZjgyYTQ4NjU5ZDYxIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6IjJ2ZWxmWUIyMGNSYzA4azVOSjd6dWc9PSIsInZhbHVlIjoidnJPbEsrQ1hYMURYNTUrSWU5T3Y5a0ZJcXNxZ3hFczYzV256aHcySVBjRTdOR29yQUNZQm85bjlnTVcxaFk0alI1T3RYMjRSclVwZW9XTk5rOTFTV3hVQXZsejV6b09rOUdIK1BNUGZxOGNOanZtUmdHTTFSM2JvbDVScGkxZ1EiLCJtYWMiOiIxMjk3NGM1NDc3ODE1ZDcwNDEwM2M4ZDFmYTMyN2Y3ZmZmZmM2YzE3YWQ0ZGNjNjM4NWVhNmNhMTRlMDg4MTZlIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET registers/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: 9960e64e-d627-4dac-9d2f-bd0debb65c9a

GET registers/{register_uuid}/edit

Example request:
curl --request GET \
    --get "http://localhost/registers/9960e64e-d627-4dac-9d2f-bd0debb65c9a/edit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/registers/9960e64e-d627-4dac-9d2f-bd0debb65c9a/edit"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6Ik5qVy9keTZqcGFpdk1XSVQwaCt4OGc9PSIsInZhbHVlIjoiNW1EWGVBMTV1blZzL0RBOGN0WC92dkkyL0lvdFc4OXNuQUd0b0JVQitTSkZaSzNUdlRaRCtpMjdRV0VrU09qQ3lwaUQ1T3AxaHN5NjZhMDROTEU2N2xaY1dndXhDZHZCRFFYeVlGa0VzRndLcnJYUnM0ZkVCU2tLL1FPL2YrakEiLCJtYWMiOiIwMDFjYzA0YTg3YzQ1OWMyNTg1ZThjZjc5NDc2Yjc0ZDNlN2E3NjIzYjA1ZTZiZWYyN2QzYjQyNjNkMjU0MzY0IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6IndPaG9HYjFER2F5Qjd1cDFvcFBueWc9PSIsInZhbHVlIjoicW9qYnVsRXYrTVFPRE1yL2gzNTRUMlM2OU80dzNLUHJHTHBKOW1JM2RWQ2ZmRjBlT3pBSndzTG5tTWRQN3NreU9mMDF4ZVl3RzBuZmxCMGswUHlpWlVHb2pGdjZqdytKTFNGV0dvWVNYZ0h1R2M5WGhQQlZDaFF2WEdJRysrZ3UiLCJtYWMiOiJhYzM3N2ZkNmM5NzFlZWY1ZjQwMTg0MWE5NTc5N2VkYjFlNjExOWMwOWFjODllMDFjNWIzZjM2MTU1ZTMzMTg0IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET registers/{register_uuid}/edit

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

register_uuid   string   

Example: 9960e64e-d627-4dac-9d2f-bd0debb65c9a

PATCH registers/{uuid}

Example request:
curl --request PATCH \
    "http://localhost/registers/9960e64e-d627-4dac-9d2f-bd0debb65c9a" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"unit\": \"architecto\",
    \"title\": \"architecto\",
    \"permission\": \"ReadWrite\",
    \"type\": \"bool\"
}"
const url = new URL(
    "http://localhost/registers/9960e64e-d627-4dac-9d2f-bd0debb65c9a"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "unit": "architecto",
    "title": "architecto",
    "permission": "ReadWrite",
    "type": "bool"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH registers/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: 9960e64e-d627-4dac-9d2f-bd0debb65c9a

Body Parameters

key   string  optional  
unit   string  optional  

Example: architecto

title   string   

Example: architecto

permission   string  optional  

Example: ReadWrite

Must be one of:
  • ReadOnly
  • ReadWrite
type   string  optional  

Example: bool

Must be one of:
  • none
  • int
  • float
  • bool
  • string
  • binary
  • unit8_t
  • unit16_t

DELETE registers/{uuid}

Example request:
curl --request DELETE \
    "http://localhost/registers/9960e64e-d627-4dac-9d2f-bd0debb65c9a" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/registers/9960e64e-d627-4dac-9d2f-bd0debb65c9a"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE registers/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: 9960e64e-d627-4dac-9d2f-bd0debb65c9a

POST registers/{register_uuid}/publish

Example request:
curl --request POST \
    "http://localhost/registers/9960e64e-d627-4dac-9d2f-bd0debb65c9a/publish" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"command\": \"architecto\",
    \"type\": \"architecto\"
}"
const url = new URL(
    "http://localhost/registers/9960e64e-d627-4dac-9d2f-bd0debb65c9a/publish"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "command": "architecto",
    "type": "architecto"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST registers/{register_uuid}/publish

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

register_uuid   string   

Example: 9960e64e-d627-4dac-9d2f-bd0debb65c9a

Body Parameters

command   string   

The id of an existing record in the commands table. Example: architecto

value   string  optional  
type   string   

Example: architecto

GET registers/{register_uuid}/commands

Example request:
curl --request GET \
    --get "http://localhost/registers/9960e64e-d627-4dac-9d2f-bd0debb65c9a/commands" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/registers/9960e64e-d627-4dac-9d2f-bd0debb65c9a/commands"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6IkY0bTFrYWM0Q0xHR0IreTdvZ09XR2c9PSIsInZhbHVlIjoiN0t4YjhMSkxXV0lzZk5zNlRGS3BsZldBNVBmQU83RUtsM1B1ZE1EZzJneE5vc2NRd05IcUJPdWxzMTN6byt6YzMzZTdUK0NIbDlFKzNTOXBwbEYxVFZBRGt6WWFOL0lMZ1pCTkdKLzdRV2NXcVBZWG84d2JLbG1Ub2p1YjdDY3IiLCJtYWMiOiI1MDNlMDA4MjU1MDQ3YWI0NzE5OTY4ZDE5NDdlMGM2Y2FmM2ZhYmJhNTc4ODNjYjUxODAzMGI3NjhjNDRhOWM0IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6IjE5ZUtuT1Q0eWIxRnFYdUtQdGw4MHc9PSIsInZhbHVlIjoiRmo4bGR6Y0FvSjk1N0RmOTdHbDBvMjVNVHYzWjN2RkxBWmtnUEVvMDEzaDRuYUhLY2J1blBVQ1pLaDVldU5wN2lwTTdmRlF0RnUwM0ZLV29ldFpPMG9uNHVIWW54bG43cVRLSzNhNGxTaXNNcW44cTduOWNoK2k2b3dlcmpjS28iLCJtYWMiOiIwNmU2ZGE1OWU1ZjU5ZTUxYmYxYTkwMDAyYjA0MWU3ZjAyMjQwMjlhOGU5ZGU4Y2ZhY2QzOTNhMDljOWZlZTJhIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET registers/{register_uuid}/commands

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

register_uuid   string   

Example: 9960e64e-d627-4dac-9d2f-bd0debb65c9a

GET registers/{register_uuid}/logs

Example request:
curl --request GET \
    --get "http://localhost/registers/9960e64e-d627-4dac-9d2f-bd0debb65c9a/logs" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/registers/9960e64e-d627-4dac-9d2f-bd0debb65c9a/logs"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6IjVicGxIb3ZMbjRVRlUwUUZsVU4zTVE9PSIsInZhbHVlIjoiU1BzM1lXMk1NWHl4blY2c3o2TjVkMmFPNGxzZDNnb2dQaEF4MTBPWktKSHRTcXJqOWdTdGVEbldCaEp0UkNmcnhqQnBCSHF2UmlBTTNPSUtzQmM5Zll6c2czd0pWcVpGVFFTTDZxWElaMmFZRTZTcVJwVkgwTTBnMVE5M0o0WHgiLCJtYWMiOiIxODZkMmI5ZDMwNjQ2M2MwYzNiZjQ1ODAwMzM0MDJmOTA0MDk0NzViZDViOTY5YzU1YTA3ODRmNzNmOTE1YmExIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6IkE5OCtBcmRYY3ppdG9odUV6alYvSXc9PSIsInZhbHVlIjoiTXkvVDdjMm0zeTgzTWxTRnpsQXNvMkdjQisxY202M1kzMGNVUGxYRUxNcVhDVm16WUQ3ZTVUZTBUN1ZOdys2cjNwMWxXN3dQM2U3TlB3Zi9Pbzg4RWZYUmxLVE1FWEJBZFdUYm04N1NXU2xRdis4VWtVVFVaSkRkS0I1b0ZVcXoiLCJtYWMiOiI4YWVhYzEyNWUwNjI1ODg2ODM3ZmU3NjY0NDE3NWJlNDE2ZjViMWUwODM3M2VmYmVhODljZmUxMjY0YmMzZWQ4IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET registers/{register_uuid}/logs

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

register_uuid   string   

Example: 9960e64e-d627-4dac-9d2f-bd0debb65c9a

GET registers/{register_uuid}/export

Example request:
curl --request GET \
    --get "http://localhost/registers/9960e64e-d627-4dac-9d2f-bd0debb65c9a/export" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/registers/9960e64e-d627-4dac-9d2f-bd0debb65c9a/export"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6IjBMc3NiNGF6NnlOcFNCZEFNN1hlZ0E9PSIsInZhbHVlIjoibDVFc2o0bnRQNU94UDk0RjZBQmFuR2pselVGVVRvUlo0eTJQZWN5YjZ5Q0RXUGdyZ1lTZUtiVUpOUGI2d0VzV1dPQWl2d2poWWFxaHl6RE95TGcyRHpOU091cnBhbklrckVFdnNaYldGL2I1Vm1NZS91TFRSNlAxd2xZbVRaeGYiLCJtYWMiOiJhMDg5Y2FmYmIxOWYzYzU4N2JhZjNjMzZiZDZkZTJiMDcwZTAzYWNjZTliZDNiNzgwYTIwOGQzZTBlZmJhY2U1IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6IkNMc2NYZkVJcHFTTWIvV2FUYmR2RUE9PSIsInZhbHVlIjoiLzRWTGl0Q3BqU0JLV2cvNFJWaWI5UmxXbk9ITCtOZzdiS1hMMkNVTmJ6RVY0cHlzcVVxeGZoTDJCOXZnNTlUZkRWakk4U0l3R0liSkVNNkcrM2FLSWdkTlNyRkRNaXBhOWlOa2o1aVRweFZneGNxaUU2L25rSVNvcncrQUM2UksiLCJtYWMiOiI1OTcwZTQxMWM5ZDAyMDgwOTYwYjU4ZGMyM2Q1ZTgzMTE2MGE4ZjQzMzZmNzhmNzFiODJmYWE1Zjk1MjkxYzY2IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET registers/{register_uuid}/export

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

register_uuid   string   

Example: 9960e64e-d627-4dac-9d2f-bd0debb65c9a

GET devices/{device_uuid}/registers

Example request:
curl --request GET \
    --get "http://localhost/devices/656355e9-2e31-45d8-bb36-c488384e3310/registers" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/devices/656355e9-2e31-45d8-bb36-c488384e3310/registers"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6ImQ5QlE4ZEtaeCtES1ZtL01FR1VIZlE9PSIsInZhbHVlIjoidFNjT2hYTVlBY0RtK2lWbTdkZlRQeUFESm15dVdJRllpcy9TZnVTY0U2Tmo2Snp2QUk5aU9YMWI4VVA1YmtmMHhHZ2NvcFNRbDJxVU5WaXRyMmxJMmx5NjVPanVoR3JRTmhJdC9GSUQ2eUNRZitTOTJTOFhSc04zcThCa2dIMU4iLCJtYWMiOiIwMmQzOWYzMjAwZTcyNjk2NzBkMzY4MTAyYzYxOGUyN2VhNzhiNDM3ZDg1MWNmMDk2M2ZmNDMxY2FjMWRlOGU5IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6InVEcXBmL2trZmlmWlZyaVU3cFlUeHc9PSIsInZhbHVlIjoiNnFmblJNM0lPZFZpakpRTHNmSXZnWTFEbGY1Z1dRMmsydThUd3JFbVRQNEQ1RUJnMUE3azNrVVc3MUFJOFpnUG9MNzh4aWJyS0ZlMFZCOWV0K1J6clJFNEZhSGppREJVR29IU2YwMHdWZXkwZnVZVVBnOGp2RkxnR1NCOThIUmUiLCJtYWMiOiJjZDI2ODg1ZGNjODMxMzk2ZGNjMzQ3MmE1YmFkMDA5NzkxMGU4ZWFjZDliZGJjY2NmYzc3ZGQwZTIyZDE0OTU5IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET devices/{device_uuid}/registers

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

device_uuid   string   

Example: 656355e9-2e31-45d8-bb36-c488384e3310

POST registers/{register_uuid}/fire

Example request:
curl --request POST \
    "http://localhost/registers/9960e64e-d627-4dac-9d2f-bd0debb65c9a/fire" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"token\": \"architecto\"
}"
const url = new URL(
    "http://localhost/registers/9960e64e-d627-4dac-9d2f-bd0debb65c9a/fire"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "token": "architecto"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST registers/{register_uuid}/fire

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

register_uuid   string   

Example: 9960e64e-d627-4dac-9d2f-bd0debb65c9a

Body Parameters

token   string   

Example: architecto

ScheduledTask

GET tasks/create

Example request:
curl --request GET \
    --get "http://localhost/tasks/create" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/tasks/create"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6Im4xaWRMa3AxWjZRK0JkbXFNazZkREE9PSIsInZhbHVlIjoiREc4eWwzVlpjTTlUd2VkSXUxR0gyM3lqL1ZLQU5JdkQveFdWaXRUT24xVlJQdXNJUWVOZmRTQWp3ZU1zQnlJUlV2OUsyNVRFS250ZkR6clViQnRUdFdwaFlhWG9acnBwc2FjVlM3R1prNDkwMEJ6bmg1Mjc4bzloaFk1UnI4L2EiLCJtYWMiOiI0YjU3MjgzMWM5Mzg2ZDk4OWRhODYxMjQyYmE0ZjM0MGUwYzBkMDY0MzZmMmEyMmJjMmI0NjkyOWI5MzJiOTYyIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6IkgzRUltbGFCRlFYVVFpa3N5djN0TlE9PSIsInZhbHVlIjoiRGFiWWsvSDJqQ0haZG1oRG9wNVlmeWRVSnZId2Uzci8xaXlpOFVhMTBtSm1jZlJsRWc3MGVWNTdhYmFqUUphYng5aHk4ZDMxSFZuUUppOHZYczA1bXBrWjFVLytBQTVvUmhwK2FxZ2xLNkxGUk1Od282b1hoT1pDTUYvb1g5Wm8iLCJtYWMiOiI3YTRjNDhmZTMxODVjYWQ3ZTc5YThjN2M2ODcwOWJiZjZmZWZmNTEzODFmMjJlNGM1NmYzMDlkOTY4MDk5MTk5IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET tasks/create

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET tasks/GetRegisters

Example request:
curl --request GET \
    --get "http://localhost/tasks/GetRegisters" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"device\": \"architecto\"
}"
const url = new URL(
    "http://localhost/tasks/GetRegisters"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "device": "architecto"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6IksxUHJjbjFXcm9LbkZqeWJsLytJd0E9PSIsInZhbHVlIjoid0w4ZnAwQmUva2RDNVJmbnBwWEZZOEhFZ0FwVmszaEt0RnhESWcyOEJ1dVlYNXovOTBiSDdTUFRpZzBDa3VJL01RNkd0V09hYVJvV29EbG1NNVpWbVZFZllBNVFxUzJ1dDhDSjZNTlBIeXFMYXRPY1dwbUFzSVJieE1mOVc2QTkiLCJtYWMiOiI1ZmU4MDUwZWQ2YmQ4MTdiZmJhNWE0ZGRhYjVlZjZiY2IxMWY4ZmZlZjFmYzk2M2RkNDA0OTIwN2RhZDAxOTg0IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6InBTOXZPSlZUb1BsdXBSUVF3VTBJRUE9PSIsInZhbHVlIjoiRGNQTU12TDdqbndZQ0w2UC9nemxiQXVac0hqcFdvWWZ1Rk81ZzRla3hwcS9iRXVkeTZ3YWJpU2doVDhOeEdqRFBZT0xUZTdROHdUdWFEZ0JDU2YvbiszbUdDejFlTEVCSjkyYTVZVTM2WGJ3bEtkNVZRS09IZ3BzeUdaUDhwNkoiLCJtYWMiOiJiYjNmYTA5MzI4NDU5OTRmMGVlMmFmOWVjMjFlZTMwMmI4MDZlNDg4NzUwMmQ2NzlhODdiYjNhM2JkOTQ0MjI5IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET tasks/GetRegisters

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

device   string   

The id of an existing record in the devices table. Example: architecto

GET tasks/GetCommands

Example request:
curl --request GET \
    --get "http://localhost/tasks/GetCommands" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"register\": \"architecto\"
}"
const url = new URL(
    "http://localhost/tasks/GetCommands"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "register": "architecto"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6IlM5ZTBIRVZzdi9vOTFOb3R1WkRFN3c9PSIsInZhbHVlIjoiMjVTM3ZUeThVUkFRNE1JRkdjRDFBRjc3UUxUYlRsMDlhU1Ezcks2Q0xCNzVnMFYxTnhrVGNuT2VLMnErRTVTWjQ0TmFRem13ZmhhODVIcTc0dWd2MHY2c1hKRkxUUm1ZQXNEc1MvaFE3VHl2TWVjMzhmaXhjOVJ2U1c4Z0R0emsiLCJtYWMiOiJjM2NjZmUwNjliZDYwNDQ2ZjY2MDdjN2IwMzMyOTA0YjA3YTJjMjVkMTA3YmRmN2M1NjhkMzRhMzkxZjJjNWNhIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6IkFMdm4xOFI1bjlnT1NCSlZhanhHRnc9PSIsInZhbHVlIjoiUXNhaHByendnUEVPRGwvRUw5MDZZQjNWU1JmVjRoMmpJaThkWW1lcGxoNlI3R3pLQ2tKSWVValFQaXg2WFdqYVhaRk1HVGZ0N1JGR2NudDM4Y25JVGFUWHZhc0xySFNwcldPaE52OHZGSVhtbXgzK2UyVlczY0V1eGNmNTJUVUoiLCJtYWMiOiJlMjNmMzU3ZjA0MmU0M2M1NWNhNjAxZWI2ZmUyZjk4MGJhZmVlYTg5OWNjNjZmNDEwZDBlNDcxMTQ0YjI3ZTZlIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET tasks/GetCommands

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

register   string   

The id of an existing record in the registers table. Example: architecto

GET tasks/AddTask

Example request:
curl --request GET \
    --get "http://localhost/tasks/AddTask" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/tasks/AddTask"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6InoyUDlLc1Z3S1NIK2VML29JSkJTMkE9PSIsInZhbHVlIjoiSVZxaE9RTEI3WElSQmxSZGw2aUk5eVc3Z1ZoMDZZSGIyOUl6NFc5dyt4U0VZdzFEd28zUHF2TVc4WjVNM1pUU2xsZ1BZOTlMM293YTRMMEs0RDJyUEl1NkEyR1p0djZWblJkZzZNaFZCTXlNWnpjK2VyNjdrR0NyblVLZWRaaGsiLCJtYWMiOiI1OWFmMDY0MTk1YjgzYTkwNDc2MWYwYzVhOTMwMWQ4ZDdmYzRkMTFkNGQ5NmRhZTRmZTI5YTRjN2EwY2Y5NTgxIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6InpxTkZRUmFZWDFKdXRUeXB2S3NzU1E9PSIsInZhbHVlIjoiWGNsdUEwRDQyNTA4SXFpK1N1d2lVVGxQNFltbkJvVVNXaVpHQWtJb1FaeFdSaDN3LzcwZXd6OTEzM09iSEk0dEFhblNqUGJxYm8wR1pyU2k0UTVVQkxMMnQ0cGx2ZEtXUFkyVlVqcFlWamh2MDZzdS9WV29XUmg4Y0JqTjJWTk8iLCJtYWMiOiJmZTc0NjJmZmI1NDhlMjU0MGViNjU2ZmI3MmI1MGNlNDQyODNmYjczZjNiNmIyOWFlMTY2NDI3N2Y0NjhhZTRjIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET tasks/AddTask

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET tasks/{uuid}

Example request:
curl --request GET \
    --get "http://localhost/tasks/8d871722-407e-4534-8ab9-5aefcdfa932e" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/tasks/8d871722-407e-4534-8ab9-5aefcdfa932e"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6IndQV2ZpS213ZUtSczhQVW52dXpRU3c9PSIsInZhbHVlIjoianJHbE9IL3JkUnlCT3NzeHF1b0JqUXA3UlVDNXJGK21GZXcyaE1YajI2K29BU1pOSHFNQVVMcnM2V3pqb3B0ZFA4QXBybktLQVRpNG45cThXbjVuRldrdlFzMXNJMXVNR3YyS1JWYzJKanlYaVZMcllQMnhSOFp5RUo5dkRXVmoiLCJtYWMiOiI5Mjk5YTcxZmQzZjRjNTkyMTdmODBlNDcyMTRmOTEyOWIyYWQ2YTM1Y2JkNjNjMDQzMDhmOTMzYTMzZWUzZjMzIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6IkYrQkZNeUVxNmUyNzAzNU52czUyK3c9PSIsInZhbHVlIjoicDl4RGlvRmdPQ3g2cEZuQU52OURIa0dCRHp5a3pSQ0FLWlhpUnF0bUxGYktVRDg3VVpLYWY4cUNuTzh6YW1QaWdhL2xyVzlyL0crNklmT28xd2NuSDZCNkUvOC92bU1vY2cxck5sTGZ3K0hySHd3anBlN1lubks4TGE1ZDd4TXoiLCJtYWMiOiIxZjU1MTFjNzI4M2RjZGZmNTk3Yzc0YWIxOThmZDMyOWMxYTI1ZGIwMGE5OTE2ZGIwOTkwOTQwMjUyMmJmY2E0IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET tasks/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: 8d871722-407e-4534-8ab9-5aefcdfa932e

GET tasks/{task_uuid}/edit

Example request:
curl --request GET \
    --get "http://localhost/tasks/8d871722-407e-4534-8ab9-5aefcdfa932e/edit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/tasks/8d871722-407e-4534-8ab9-5aefcdfa932e/edit"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6Ik1LNDdQSE1MZWphbXFqSFA4bVJTaFE9PSIsInZhbHVlIjoibXpiQitHMUhEajUxQm5tRjJobG5wNXVlRHAvTUhhWW5jSXVub1ljRlN0Z1pub2Z2bXlyNzNtUUtqUDBFNW5MSy9MeGorcXB3YTI2eUpScDBubjMzaXVDUTdzY0xLVHhQeU50QlBIQXBlM1Y3WkNEWHloQ2tBT2NiMlByNU93cTYiLCJtYWMiOiI0YjE5MmViNGUzZjU0NmE2M2YwODNlZmQ0ZjUxZWY5ODE1YzUxZThlYTk0NmNkYmFiMzlmYjlkNGQwNmQzMzllIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6Ikwyb3dGdEdLSjVPaGdGa0c3QkJhUVE9PSIsInZhbHVlIjoiOGJJYjNwY2JLQlBjWkt1UlY2SjF4U1pwUjZld09mRmdIVHoyQlU0N25MOG5rdEMyem54QXNnUisrWldSYmJubjlKTDdodWRUVVZ4U0oxVFhObjlzUDVuUGJDcDN1bDArUGlic3k0czFjL2RqMU9VaitBVlgxMXlSRE9oSEFKT2siLCJtYWMiOiJjYmMwY2VhMTIxMTAzMTc2NGI0OTkxMDIwYjRiODY4NzE0YTFiNmM1YTMzMTAyOWYwMDQxMGU2YzNlM2JiNzFiIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET tasks/{task_uuid}/edit

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

task_uuid   string   

Example: 8d871722-407e-4534-8ab9-5aefcdfa932e

PATCH tasks/{uuid}

Example request:
curl --request PATCH \
    "http://localhost/tasks/8d871722-407e-4534-8ab9-5aefcdfa932e" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"architecto\",
    \"start\": \"architecto\",
    \"device\": [
        \"architecto\"
    ],
    \"run\": [
        \"end\"
    ],
    \"type\": [
        \"log\"
    ],
    \"count\": [
        22
    ]
}"
const url = new URL(
    "http://localhost/tasks/8d871722-407e-4534-8ab9-5aefcdfa932e"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "architecto",
    "start": "architecto",
    "device": [
        "architecto"
    ],
    "run": [
        "end"
    ],
    "type": [
        "log"
    ],
    "count": [
        22
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH tasks/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: 8d871722-407e-4534-8ab9-5aefcdfa932e

Body Parameters

name   string   

Example: architecto

start   string   

Example: architecto

end   string  optional  
device   string[]   

The id of an existing record in the devices table.

run   string[]   
Must be one of:
  • start
  • hourly
  • daily
  • weekly
  • monthly
  • end
  • count
  • custom
type   string[]   
Must be one of:
  • command
  • log
count   number[]  optional  

Must be at least 1.

DELETE tasks/{uuid}

Example request:
curl --request DELETE \
    "http://localhost/tasks/8d871722-407e-4534-8ab9-5aefcdfa932e" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/tasks/8d871722-407e-4534-8ab9-5aefcdfa932e"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE tasks/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: 8d871722-407e-4534-8ab9-5aefcdfa932e

SharedRecord

GET share/modal

Example request:
curl --request GET \
    --get "http://localhost/share/modal" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"architecto\",
    \"url\": \"architecto\",
    \"title\": \"architecto\",
    \"class\": \"architecto\"
}"
const url = new URL(
    "http://localhost/share/modal"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "id": "architecto",
    "url": "architecto",
    "title": "architecto",
    "class": "architecto"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6IjNJWlllRjRDRDF0c09RcHRZbnFlclE9PSIsInZhbHVlIjoid0JwVjNZY1lpU1B6STVjTi8wTkV5U3MwT3pYUlYwdWM1VEFKSkdjbzdJSVVjbG80K3YxUXlyL0FDNnZuUWg0Ni9yTEREYW1uK0lvQkVDNGRyYTVtNnZVVmNkaDVobk4wVUVjSG9TUFVPUnJmQjhxcEtKN2o4SHJ1c2Z3Qm55RkQiLCJtYWMiOiJmMDNjMDFjMjFkN2IxNGMyNmI1MzI1MDYyYWI3OWEyYzdjZGM5MTE1NGQ2MmQyZjNhMThiNDU4MmM2YTk5Nzg4IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6Ik03M1l0L29LMW5UNEVJUW9IM3E3ekE9PSIsInZhbHVlIjoibmE5ZnplZnNObjZ0MmRMZzJvUWNwYUpvQkRpU2QwcDV3QTJDQWhNWEs3VGREY1ZhcnJSbmw2ald1QVNDMUZsYkd4eld2UnlHQUxtVFhybytTdjIvYWJkdUZPYnNnNm5HMFZkdndLVFVxbUNaY2tPNWgxMmlLd2E2azdiQzl3WkQiLCJtYWMiOiJjNDJkNWEzZWExMjIyMDA4ODYwOTVmZjAzYmQ3ODExYTA3ZDljMDEwNzg0ZTRlOGIwNGNlOGJkOWNhZjJmNDdmIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET share/modal

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

id   string   

Example: architecto

url   string   

Example: architecto

title   string   

Example: architecto

class   string   

Example: architecto

POST share/submit

Example request:
curl --request POST \
    "http://localhost/share/submit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"architecto\",
    \"class\": \"architecto\",
    \"users\": [
        \"architecto\"
    ]
}"
const url = new URL(
    "http://localhost/share/submit"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "id": "architecto",
    "class": "architecto",
    "users": [
        "architecto"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST share/submit

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

id   string   

Example: architecto

class   string   

Example: architecto

users   string[]   

The id of an existing record in the users table.

SubProject

GET projects/{project_uuid}/subs

Example request:
curl --request GET \
    --get "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731/subs" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731/subs"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6IlowZEwveGxwODEwNW5rU3NTckhYbVE9PSIsInZhbHVlIjoiSW5TVXhwRFIxMXRiZlFmVnI1Z0h3TUlkWHJMdWhiVXV5Q2lzQVZuVkV2RTdQQ0lMT1BNSkxkRW5wUzk5QnRhd29wOEg4aXNaMVVXUG5DVENyMmIxY0lEQ3EzbGlnN2FmY0Z0YWpHcEh3Q0pLbnhmNWp1ZThvVTg1Y1ZlZzc3NGUiLCJtYWMiOiIzNDhkMDJjZDg2YmNhYjc0OWQ0MDE0YWZkZjlkOTE4MjEzMzFiODUwMDc2ZmFlYmNhZTVhZjU5ZDdhZDViOTM0IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6IjVBUGpNU1Z0Q3dGc3FFTnZNSGp5SkE9PSIsInZhbHVlIjoiRTgrdW9Vb1hCTkEwVjJFVmVkeHF0ZkV0M3AvVXJWTDBiR0JqWjhtZUJRQk5jdElSRG1WaEplNURwblBjU2JmMnJWN2d5TlFZQXhUYjdxb0wxSFY2YXZzUkUvY0J5WjhCcHB2RmR2a2hUNUxKbFpkY2tpNFdHaCtzZjdEM05KNlkiLCJtYWMiOiI2ZmRjYmZhNmRlMjUwMGY5NTYxZmY2NTRhYjU5NmNjOWYxOGNkODgwNjE1OTJmNWJhMzkwMjdkNjA1NjQxMjY2IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET projects/{project_uuid}/subs

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project_uuid   string   

Example: bc09e9a9-4805-4988-8a9e-46e3673b1731

POST projects/{project_uuid}/subs

Example request:
curl --request POST \
    "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731/subs" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"architecto\",
    \"description\": \"Eius et animi quos velit et.\",
    \"type\": \"video\"
}"
const url = new URL(
    "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731/subs"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "architecto",
    "description": "Eius et animi quos velit et.",
    "type": "video"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST projects/{project_uuid}/subs

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project_uuid   string   

Example: bc09e9a9-4805-4988-8a9e-46e3673b1731

Body Parameters

name   string   

Example: architecto

description   string  optional  

Example: Eius et animi quos velit et.

type   string  optional  

Example: video

Must be one of:
  • photo
  • video
topics   string[]  optional  
registers   string[]  optional  

The id of an existing record in the registers table.

keys   string[]  optional  
lat   string[]  optional  
lang   string[]  optional  
devices   string[]  optional  
title   string[]  optional  
model   string[]  optional  
x   string[]  optional  
y   string[]  optional  
z   string[]  optional  
form   string[]  optional  

The id of an existing record in the forms table.

GET projects/{project_uuid}/subs/create

Example request:
curl --request GET \
    --get "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731/subs/create" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731/subs/create"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6IlZGRGdUM2JPbktPVTRuUnZOZ21yTWc9PSIsInZhbHVlIjoiMWNlcm52eFhzL3F4c05FZkY3RGFDY0ZYdENyL0xkanEyTkJOMXJvU2xZcnQwbDhSZ0FTSUdia3c5bmx4NCtOMGpLQnc2dGVSNHZ5Z1JSYVFuTjdlZmlmMUs2dU55WGFHQWtOTDRhVG9TUFEzZmpKQVREVE9peCs5SW8xVUMwMHYiLCJtYWMiOiI3ODQzNTdkYTU2YzQ5Yjk1ZTJjYzZiZTk1NTBhNDgxOGZhOWY2MjQxMzU5NTc4YjAxZGY3ZjA4MGY4NjZhYjJlIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6Inh4ZkxhSE02ckFVUDVOVUpZMTNmSlE9PSIsInZhbHVlIjoibTEyZStOVG5sUlEyQXhQOEM1TTdOcjNwbnYzcVU1bFhzbWJVZm56UlNra1hXcUNUczdKQ3JaRnlVY05MR3pGQ3l2dXpYUlp5b3ErZVl2VGJBMklZWGpmcU5uNUhtZ2Zlamk1MmlPdDU5L0w3dDZzTlhka2pvaTNLdGF0VUYxMUciLCJtYWMiOiIwZjhjZTg3YWVhYjBlOTYxYmQ3ZThjNzY0MGQ0ODVlYTU1NTgyYWY2ODljMDI4NGJiNTI5MzNjZjMyZjhkZWY4IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET projects/{project_uuid}/subs/create

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project_uuid   string   

Example: bc09e9a9-4805-4988-8a9e-46e3673b1731

GET projects/{project_uuid}/subs/{uuid}

Example request:
curl --request GET \
    --get "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731/subs/e1b031af-f4a8-4431-879b-bfe7590f270e" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731/subs/e1b031af-f4a8-4431-879b-bfe7590f270e"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6IkpaNEg0MXRPOW5YRmtlM0piR0wydUE9PSIsInZhbHVlIjoiYkR5cngrNW1Wd1hRNmk0R1dFYmx6ZWRWOWJrOFJpUkc4SUZkMnY0UlVucWloUktpaTh5bXhpb3plaW1ZMkhaSTZ6YS9rWEVnbFFzbEZGcldCdHpSOE1UTVVmblJFcHkzOUhFMmdrNTBaVlRnQmpyanJDSUlFZkNEK1VmQ2FnTTQiLCJtYWMiOiJiM2ZmOGU0ZThlNDk1NGYxMjM2NmE2MGUwMzE0NzA2Mzg3ZDA2ZTA1Y2FjMTE5MjBlNDk5MjE4NmMxMzI0YWU3IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6IjdvVHlRV0xjaW1TYnNsN2NYbk9DalE9PSIsInZhbHVlIjoiSUk3RnZXT3doaFNSUS9QV0kyblkyY3Y4VGdvam1FSkhIK1V5dkpnNTdoM2lva0diSTlCb1dCUEY2eGhja0pjUEJzNkpaMnRnMjU3YWU3VmM1N28vd1ZvYk4veVhUc0gxU0pkaVVyWVFLUzIrWmo1N0pNLzBKRmpLTFJjT0xrKzciLCJtYWMiOiJmODZlNzE4YTA5MTM4MTM1Zjk0YWJmZWM1M2ZmNmI0NGZkODJiZWE5OWZkMzljYzI2MjQwYzAzYzJkMDYxNGU3IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET projects/{project_uuid}/subs/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project_uuid   string   

Example: bc09e9a9-4805-4988-8a9e-46e3673b1731

uuid   string   

Example: e1b031af-f4a8-4431-879b-bfe7590f270e

GET projects/{project_uuid}/subs/{sub_uuid}/edit

Example request:
curl --request GET \
    --get "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731/subs/e1b031af-f4a8-4431-879b-bfe7590f270e/edit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731/subs/e1b031af-f4a8-4431-879b-bfe7590f270e/edit"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6ImJOTGNEWWQ5azJoaitFUXlOY0p6SkE9PSIsInZhbHVlIjoiTFFPSXhxM3I2NFU4eFpXeExIQURUOGcvT0VOV2RZZ0hOUUw0ajVZaWNpTm5wQlNpU0EwZVNBeE1Dd2RQeURWYzZiQmRuV2FuU2tjNXBJTVJpY0RPcG9rNEZOYnUwbXl5a3R4b3J6WEh4eTFydzhUbS9hMU1UVEdmUExMWFlIeEQiLCJtYWMiOiIxNGYwMWExMjMxODM5OTA2YmNlYzRmMDg5OTk2ZDg3M2ZjM2YxZGViMWVkZWMyZTQ4ZjA0MTAzOWQ2MGY1NjFiIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6ImxLQW1XM3RIdStjSmYzYXN2WlhRbVE9PSIsInZhbHVlIjoiYk5vdTF2a3BBeGVBczlJZUhuQ1kzeFVydUc5U1lKMmFpTmVoSXR3ek56RWtkNk9ua1hoWW83ejluSFlkOEY0ZDAxZU9Qa2IzWng1WUNGdlJzaEM4a3hSdWxLeGNqOGxic1ZKTjVOcmpqc0toa3FzdkIzV2VmQlZta1R5eG1FZUIiLCJtYWMiOiI5MGVhOGQ3MWNhNTZlMTQ5ZmRmM2ZiNWNkODM1YTA5NTBjOGZmMzRkOWZlMjNlMDViNTlhNDA5OThiMzc2YTBkIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET projects/{project_uuid}/subs/{sub_uuid}/edit

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project_uuid   string   

Example: bc09e9a9-4805-4988-8a9e-46e3673b1731

sub_uuid   string   

Example: e1b031af-f4a8-4431-879b-bfe7590f270e

PATCH projects/{project_uuid}/subs/{uuid}

Example request:
curl --request PATCH \
    "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731/subs/e1b031af-f4a8-4431-879b-bfe7590f270e" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"architecto\",
    \"description\": \"Eius et animi quos velit et.\",
    \"type\": \"video\"
}"
const url = new URL(
    "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731/subs/e1b031af-f4a8-4431-879b-bfe7590f270e"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "architecto",
    "description": "Eius et animi quos velit et.",
    "type": "video"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH projects/{project_uuid}/subs/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project_uuid   string   

Example: bc09e9a9-4805-4988-8a9e-46e3673b1731

uuid   string   

Example: e1b031af-f4a8-4431-879b-bfe7590f270e

Body Parameters

name   string   

Example: architecto

description   string  optional  

Example: Eius et animi quos velit et.

type   string  optional  

Example: video

Must be one of:
  • photo
  • video
lat   string[]  optional  
lang   string[]  optional  
devices   string[]  optional  
title   string[]  optional  
model   string[]  optional  
x   string[]  optional  
y   string[]  optional  
z   string[]  optional  
form   string[]  optional  

The id of an existing record in the forms table.

DELETE projects/{project_uuid}/subs/{uuid}

Example request:
curl --request DELETE \
    "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731/subs/e1b031af-f4a8-4431-879b-bfe7590f270e" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731/subs/e1b031af-f4a8-4431-879b-bfe7590f270e"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE projects/{project_uuid}/subs/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project_uuid   string   

Example: bc09e9a9-4805-4988-8a9e-46e3673b1731

uuid   string   

Example: e1b031af-f4a8-4431-879b-bfe7590f270e

GET projects/{project_uuid}/subs/{sub_uuid}/scan

Example request:
curl --request GET \
    --get "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731/subs/e1b031af-f4a8-4431-879b-bfe7590f270e/scan" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731/subs/e1b031af-f4a8-4431-879b-bfe7590f270e/scan"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6IlRrWngvaENDWFYzOHJYY3dNN3JZSmc9PSIsInZhbHVlIjoiQjY5c2JEMlg0M0V0NFRJN045My9vS0dkRDdCTXBkQUlTNitwejc2YmplNzV6U0RTSE9KOCtVRXdoR3MvcU84TU1BN2pTZHYzWllnOGxOVks5V3BoUms0ckl4U1VCYThPNFkrenNjeWcycWV6eVVGcUUzRlFBSG9pZ0g0UEozV20iLCJtYWMiOiIzYjM2Yjk2YjVhZDY3NGE0ODI3YjFjZDc3YWM3ZjVkNGJhMjZhMmIxNDI0ZGQyYWUwMWViMjI3MDFhOWZmMWY1IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6IjVWSEJlK1ptQzMrTjRkMnFZUDNXQ1E9PSIsInZhbHVlIjoidGU3ellnT25PdVJJQ2lSMFVaTFFGQ2tPc3NrZlNDbTZwS2grUjVqRDJybFhiN2JrTkhSTHFZVDFKbVFZSUVCeXlMK3FENHN5UmhsZS9sOWg1SWw5WnQ0Ti9wcHFaRW5oTkNtbm5ydHQyZ3lIZ1ZzRUJkOE13UC9Ebm1Sc1lRREgiLCJtYWMiOiI1NjFkMDNhNzg5MWYxMTlhMzRjYjIxMzViZTU3MzNlNmNjOGVlNDQyZTE3ZDAyOGE3NzljNjAwYjc0YmQyMDNkIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET projects/{project_uuid}/subs/{sub_uuid}/scan

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project_uuid   string   

Example: bc09e9a9-4805-4988-8a9e-46e3673b1731

sub_uuid   string   

Example: e1b031af-f4a8-4431-879b-bfe7590f270e

GET projects/{project_uuid}/subs/{sub_uuid}/watch

Example request:
curl --request GET \
    --get "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731/subs/e1b031af-f4a8-4431-879b-bfe7590f270e/watch" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731/subs/e1b031af-f4a8-4431-879b-bfe7590f270e/watch"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6IlJzbEtvRExOWFpkZ0g4ZDViSktmVnc9PSIsInZhbHVlIjoiTDdnRHYxak13NjBqS05zbytFNXJ4YTBId1N0ZHhzT2ZrSFk1Z1VjdUhVNXRVSVNzKy9OM1N1TEF5Rll5cFhZRGNlYTBvMVRkRm9IcHJkZ1JsZ2xuS2ZmOGQ4aFZWVWlnN2VqRGVnM3JrVlpQbjdvUnExNVdreWM1MXQ4M0FCb2YiLCJtYWMiOiI3ZWRkNTFlNTNiNTg4YTVkM2UxNzRlNTRjMGNhOWExZmM1NWIzNmMzMzEwNTQ0Y2ViNzA3NjRkNDJkMjhkNjhhIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6IjJ0elZzSlR2dUgydURPOEdlN3hkZUE9PSIsInZhbHVlIjoiK3NnNjR3QWYrUXNsVEsyOGZZTC9rVFR6KzJQSWlFSkxteE5EMkV0ejFCMVdBMFd6aFJ1WDNmL0hNZ0JaaWphTkgyYzJDQWlNZ3hJT1gyMjd2dkF0ZjlnSndrVzNYa2M0SC9rYmpKajRHemJxaVFYeERXVXBJM0hHV3Q4SFVYa3QiLCJtYWMiOiI0OTQzM2E5YTY3N2ZlY2UxM2M5OThhMDBlMDNmNzA1MTUwNWEyMTYzNzMyODE5ZjM4YmE5N2I4YzhhOTJhYjNjIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET projects/{project_uuid}/subs/{sub_uuid}/watch

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project_uuid   string   

Example: bc09e9a9-4805-4988-8a9e-46e3673b1731

sub_uuid   string   

Example: e1b031af-f4a8-4431-879b-bfe7590f270e

GET projects/{project_uuid}/subs/{sub_uuid}/3d

Example request:
curl --request GET \
    --get "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731/subs/e1b031af-f4a8-4431-879b-bfe7590f270e/3d" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731/subs/e1b031af-f4a8-4431-879b-bfe7590f270e/3d"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6InhHOVJCcmpQSG5FZGNQQ2Y3VjNkQ1E9PSIsInZhbHVlIjoiVU94MU0zT3BaNXB0MWgyNDRUS3graU5reFErZGV2U0Q5UlN1RFcvTEdKTk1oNWtDYWJjQk1OamhvY2g1Q0trdk9TeXkxMDNkbXl1VnZ1L2pwLzI2MURUY1F2S3FYdjIzeDNSWHFObGVxRjk5Z3ZJZkdsbnZZdWh1aDBWcE5CSXQiLCJtYWMiOiJkYzEzNjlhODk4ZmYwNGQwMDJiMGY5YjA1NGM2Yzk4YWE4MzhhZDJhNDE5ZjdiYjVhNGNmMjM3ODYwMThkYWJmIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6IkVJUzBocWgwUW1HdWc4dkNhdklEZEE9PSIsInZhbHVlIjoiYUNXZ1NFMVM0TkVwSEd4YTV3SHY0bVVJVlcwVHo1RkNEZk9xKy8rNDhqYmhCR0ppcHBrSnJTSHpqY2pEU1k5NGJTQW96d1o4di93VjRmOElOWHNaMk9jT3lUcnRibldJOGNtSWNlVzQ1R2dXTW45ZmEyZG5LMmJRYUphK0Vla2YiLCJtYWMiOiJiNzUwN2MyZDg2ODhlYjNmMzNmNjUwMTRmYWI0MmZmYjUyZWI4ZDUwMzNhMmU4OWY1OTZlNTJjNmRmY2QyMzM4IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET projects/{project_uuid}/subs/{sub_uuid}/3d

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project_uuid   string   

Example: bc09e9a9-4805-4988-8a9e-46e3673b1731

sub_uuid   string   

Example: e1b031af-f4a8-4431-879b-bfe7590f270e

GET projects/{project_uuid}/subs/{sub_uuid}/3d/edit

Example request:
curl --request GET \
    --get "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731/subs/e1b031af-f4a8-4431-879b-bfe7590f270e/3d/edit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731/subs/e1b031af-f4a8-4431-879b-bfe7590f270e/3d/edit"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6IlpPZStoWHcrMzNyR21wVEl5YTBzUkE9PSIsInZhbHVlIjoiRy8wWlM2UXUwWWM4VmdSbFppQlVMRWdRaW1VVEd5QTFkb1FqbWoyNjFkY3dpWFZsTmw0UURiUmRDSG9SRy9GVXFEREtHbHR4NTlBME1CUHpWTjJnSzdMRmkybGhkdW84dEQ2RUtIQ0szV3NKMGxybWVGQklxU2Q1S2s0cjNtV20iLCJtYWMiOiIzOTE5YjdlM2VjMGYxZTUyZTZkNWFlM2M1ZGYxNjlkN2RhNmI2OTY1OTgyZjk3NGEzZWQyNGY1ZWEyNzE3YzQ3IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6Ik1aeEE1ck9oZlBSR053WlRTVmprZXc9PSIsInZhbHVlIjoid3NoUWpFZTBHUWtqQUZZZkIxeWZjbHNMWlBidXZCSTU4S1kvZU9HZFdWeEwwTURaQ2c1b2hKaDlvdzlRdHNTSzBRdkJ4N2locnR3dTA0ZjliSWplc05zQzErV3ZOZXpLdFlDRWJBMEhvdVBYRjgwY2NMT1ZXMXBCYkNlTlFvSlAiLCJtYWMiOiIxOWQ3N2M2NTA5NzNlNDQ5Y2U2MTZmMjY5NzU1ODQ1ZjYxMDA3OWI0NWE5ZDVmZTk3YWI5YzRjZDA3OGVhYzRkIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET projects/{project_uuid}/subs/{sub_uuid}/3d/edit

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project_uuid   string   

Example: bc09e9a9-4805-4988-8a9e-46e3673b1731

sub_uuid   string   

Example: e1b031af-f4a8-4431-879b-bfe7590f270e

PATCH projects/{project_uuid}/subs/{sub_uuid}/3d

Example request:
curl --request PATCH \
    "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731/subs/e1b031af-f4a8-4431-879b-bfe7590f270e/3d" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"x\": \"architecto\",
    \"y\": \"architecto\",
    \"z\": \"architecto\",
    \"title\": \"architecto\",
    \"model\": \"architecto\"
}"
const url = new URL(
    "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731/subs/e1b031af-f4a8-4431-879b-bfe7590f270e/3d"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "x": "architecto",
    "y": "architecto",
    "z": "architecto",
    "title": "architecto",
    "model": "architecto"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH projects/{project_uuid}/subs/{sub_uuid}/3d

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project_uuid   string   

Example: bc09e9a9-4805-4988-8a9e-46e3673b1731

sub_uuid   string   

Example: e1b031af-f4a8-4431-879b-bfe7590f270e

Body Parameters

x   string   

Example: architecto

y   string   

Example: architecto

z   string   

Example: architecto

title   string   

Example: architecto

model   string   

Example: architecto

POST projects/{project_uuid}/subs/{sub_uuid}/3d

Example request:
curl --request POST \
    "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731/subs/e1b031af-f4a8-4431-879b-bfe7590f270e/3d" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"model\": \"architecto\"
}"
const url = new URL(
    "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731/subs/e1b031af-f4a8-4431-879b-bfe7590f270e/3d"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "model": "architecto"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST projects/{project_uuid}/subs/{sub_uuid}/3d

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project_uuid   string   

Example: bc09e9a9-4805-4988-8a9e-46e3673b1731

sub_uuid   string   

Example: e1b031af-f4a8-4431-879b-bfe7590f270e

Body Parameters

model   string   

The id of an existing record in the ar_models table. Example: architecto

POST projects/{project_uuid}/subs/{sub_uuid}/3d/mesh

Example request:
curl --request POST \
    "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731/subs/e1b031af-f4a8-4431-879b-bfe7590f270e/3d/mesh" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"mesh\": \"architecto\",
    \"model\": \"architecto\"
}"
const url = new URL(
    "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731/subs/e1b031af-f4a8-4431-879b-bfe7590f270e/3d/mesh"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "mesh": "architecto",
    "model": "architecto"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST projects/{project_uuid}/subs/{sub_uuid}/3d/mesh

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project_uuid   string   

Example: bc09e9a9-4805-4988-8a9e-46e3673b1731

sub_uuid   string   

Example: e1b031af-f4a8-4431-879b-bfe7590f270e

Body Parameters

mesh   string   

Example: architecto

model   string   

Example: architecto

form   string  optional  

The id of an existing record in the forms table.

POST projects/{project_uuid}/subs/{sub_uuid}/3d/save

Example request:
curl --request POST \
    "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731/subs/e1b031af-f4a8-4431-879b-bfe7590f270e/3d/save" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731/subs/e1b031af-f4a8-4431-879b-bfe7590f270e/3d/save"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request      

POST projects/{project_uuid}/subs/{sub_uuid}/3d/save

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project_uuid   string   

Example: bc09e9a9-4805-4988-8a9e-46e3673b1731

sub_uuid   string   

Example: e1b031af-f4a8-4431-879b-bfe7590f270e

GET projects/{project_uuid}/subs/{sub_uuid}/ScanAR

Example request:
curl --request GET \
    --get "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731/subs/e1b031af-f4a8-4431-879b-bfe7590f270e/ScanAR" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731/subs/e1b031af-f4a8-4431-879b-bfe7590f270e/ScanAR"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (500):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: mmcp_session=eyJpdiI6Ik1ienZqYnBSSUhERHFzVDJiRUVveVE9PSIsInZhbHVlIjoiLzI0ZnM3c0FNOWxVamhlVnNkT0NVMHRxcTYyVXJzcHhaTkE1YUZGclNzMVBVYXphcXo3OExMWlZ2bDVhdVEwVkxjMHErMzMvc0RIcGF4ODFtRlpURU5CV2psMGo5dGY5bWdzNTFCNk5XN2V0QkNNdUhUa1FkL0g2NDVneGtlZEQiLCJtYWMiOiI3MDQzMWE4MjMxMzM2NDJiYTc1OGFiNGYwZmM4YTM1OTFiZDAzYTI5OGVmMDMyYmYyNzFlNGQwNWYwYTVhMTMxIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Server Error"
}
 

Request      

GET projects/{project_uuid}/subs/{sub_uuid}/ScanAR

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project_uuid   string   

Example: bc09e9a9-4805-4988-8a9e-46e3673b1731

sub_uuid   string   

Example: e1b031af-f4a8-4431-879b-bfe7590f270e

POST projects/{project_uuid}/subs/{sub_uuid}/ScanAPI

Example request:
curl --request POST \
    "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731/subs/e1b031af-f4a8-4431-879b-bfe7590f270e/ScanAPI" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"url\": \"architecto\",
    \"token\": \"architecto\"
}"
const url = new URL(
    "http://localhost/projects/bc09e9a9-4805-4988-8a9e-46e3673b1731/subs/e1b031af-f4a8-4431-879b-bfe7590f270e/ScanAPI"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "url": "architecto",
    "token": "architecto"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST projects/{project_uuid}/subs/{sub_uuid}/ScanAPI

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project_uuid   string   

Example: bc09e9a9-4805-4988-8a9e-46e3673b1731

sub_uuid   string   

Example: e1b031af-f4a8-4431-879b-bfe7590f270e

Body Parameters

url   string   

Example: architecto

token   string   

Example: architecto

Template

GET templates/create

Example request:
curl --request GET \
    --get "http://localhost/templates/create" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/templates/create"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6InVnR3ArWVZZOUVVZ3p5WmJ2dnRhVWc9PSIsInZhbHVlIjoiYWJEMktLUXlMQnYzTkxyUmpTTndzV3ZMeU4vLzlXL1d0NjJ5bmYrOTg0RE54NUliUWtlRlBWaDIzV0dWSmtBVFJZUzVzenNhK2RiRVhlUWJpMFQ2MzVRTjVVTGg5OXZNSDc1cUYrcnFuRmpSV0d5RFpNenFhWDZPNnBrM0RSakwiLCJtYWMiOiJiZjAzZDc0OTM5OGFlMzdiMTZlOGI5ZTBiYWNiZjRkMmY3ZmE5N2IxMmQ2ZjcyNTEwMzRkMDIzMzA3MjI5MDFjIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6IkpaZ01CcXRubzVOSGRCb1BQRi94UFE9PSIsInZhbHVlIjoiblhxSVdrUHVHc0R6ak16bUhuRStaeEZ1SWwyTGZSQTlBWksvN1pwSG5aODE1NUluYlFJeUdxbThYYzVhcW1MVkI3clZTK3hQUzFFTFhUcjVycTgwVFBLdTZqTmNGSVNJT0lRaENCQ0pyN1IxaVJzUWxaS0NTQ3p6ZXhQVkFWVEgiLCJtYWMiOiIyMzYzMDIwODBlNDJjNGY1ZjAwNzNlY2ExOGM3NDY4MTBiZWZjNmY2YmQ3NTU3NmMyM2RhMDA4NmFkODMwNTdlIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET templates/create

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET templates/item

Example request:
curl --request GET \
    --get "http://localhost/templates/item" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/templates/item"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6Ino2WktjZVBWaVlsQnRzbGh0ZThBOWc9PSIsInZhbHVlIjoieEJHS2w5UUcrY1hBcnBmY0RVdEt0VWh6SzdaWGJnWmJiczhoKy9TL1R1UDZnQ1M3TXgzZzA2c1FUdG8xemxlaUh3bGFZbVE5a01zSzl1ejNjK0tRR1pIcy81TXo5K0pQUlFudlpYbVJhZDZCVFI4aVBCTTJxUThMT2NyZ3NYa0kiLCJtYWMiOiJmZjRjNmQ1Y2RlYThhZDY3YTRjNzNlZjNiYWNlNTFkODhmYzdhODViNTg0NTM2YjdiMzk1Y2M4YjNmODczNGM3IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6Im5WcG5NU3hyRkJrTGtYYk5qSGJIK0E9PSIsInZhbHVlIjoiZnRVK1RIMG9LMk5ZQ05IY1VnTmVURVdKcWlaTlFjSGhlM2dYNXJHem5KekNqVVVNOG1lK3lSaCt2T3dXV3NTQ1J3eE5SZm9SL1M5NnlCdVNpWm1rOTNNNWdBaDNUMHkwYWdTcHY2RlpFRGpuY0hubVRjbkFSUjVDZzJWUkh4YmUiLCJtYWMiOiIxNjQ5NmJiNWQ0N2EwNzc3Nzk3ZmY2NmI2Njg5NzAxYmU1M2RjYjg2NjhiYmRhOWQ2MDY3MmRiYWU4NDhiNDcxIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET templates/item

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET templates/{uuid}

Example request:
curl --request GET \
    --get "http://localhost/templates/9dd85e87-cede-4f9f-b379-bbb196ad5af5" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/templates/9dd85e87-cede-4f9f-b379-bbb196ad5af5"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6ImZuQlQyOUUyTnN0d3dIV2Nkb1gveUE9PSIsInZhbHVlIjoiSkhhUjFSVllKcTVidXpqZUxhbVVGRFgvU1BHdk1DcmFsYzJzMVljenNxOGNSaW40NmM4Mjk1MFJmM0NtenV3VERSeGRZdEJFblhuZlBjMjZYZU5ONjdpa0dYd0dhdkhtRy8xN3hiaHNpc2Y4amd0NHZSeEJ2NEgrOU1aN0FoNXIiLCJtYWMiOiIzYTkzNjIwY2EzOGVmNjVlZDMyMjA5YmU4NGM5YWUwMTNmZGJhNGIyMjhkMDFjODM4MDNmMmFmZDY0NTllZWMyIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6ImYzNjhkZU9XekxoRnI0MTZXb1RTV0E9PSIsInZhbHVlIjoicXN0NVZrZjdTMFNsM0M2OE1lNkE0TVlVWVdkR05mOHlhN09rVWlQV21OR2kwS1dZVjR2RkMrR2dnVmVxbmYzbC9rSXFjUVhDM2NpNGRCNGxUSXAzc0NjYlAvYlNZY3c0S05YY2lua3lQdjFpN3EvMVg2aVhRdWs2dGV1c3RIMm8iLCJtYWMiOiI4OGU0ZmM4M2FiMTBkNzI2MThjZWI4M2NlMjhiYzgxNGEwOWEzMzA4YmY0NGVlYTcxMWMyYjdhM2YyMzAwNTk1IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET templates/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: 9dd85e87-cede-4f9f-b379-bbb196ad5af5

GET templates/{template_uuid}/edit

Example request:
curl --request GET \
    --get "http://localhost/templates/9dd85e87-cede-4f9f-b379-bbb196ad5af5/edit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/templates/9dd85e87-cede-4f9f-b379-bbb196ad5af5/edit"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6IndqQ0xsSmh0YUl6U1hGaWNQaXVkZHc9PSIsInZhbHVlIjoiKzFoalFxeGdGM1pUZ0g1a1FsSWNvMERhK3M1R1NoaG44ZHkzbUJPUEhibXNjMXRnZWx2MEZBa2dWOUhMZGFrSS93Z0s4WlNWV3BnYUNjQWd6SjFqOEF1emVmblk1MU1NYmFlWTAzWDV6YVQyTEZDQ01LUDRwYXhXVXd6RHY1SlIiLCJtYWMiOiI0MzNhNWFjM2Q2MDg4NGMwMzIxMjEwYTc0NWFjMGJjOGY4MDEzNjcyMjU5ZmQxZmI3NTQ0OWE3NDcyMmI5MzM0IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6IjBadGJVZmdZeS83SkYyU0g3VmVXa2c9PSIsInZhbHVlIjoiV0ZwTUhBdGd0TXROcWRwTVlTL3JXWVE5UHpMLzlTZjBZYWFmM0pRSUpoZWh5NlM1aGNSN013ZFhSbHZaVDRKREtxbHQwbXRML3dDa1BLU1I0VEVnNlBGTXdUQ0U4Ry9sWVl3L0xVa2h6K09hYjk2UmtUWkpUeU5PcEtVOTd0NVAiLCJtYWMiOiI4YjVkYWMxMzdhOGRiNTZlZTU5OWExMzIzZmI5MGI4YTMyMmM1ZDIxMzgwZDA2YjA4MTcxMWRjNWEwY2M2YmVjIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:23 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET templates/{template_uuid}/edit

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

template_uuid   string   

Example: 9dd85e87-cede-4f9f-b379-bbb196ad5af5

PATCH templates/{uuid}

Example request:
curl --request PATCH \
    "http://localhost/templates/9dd85e87-cede-4f9f-b379-bbb196ad5af5" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"architecto\",
    \"rows\": 1,
    \"columns\": 1
}"
const url = new URL(
    "http://localhost/templates/9dd85e87-cede-4f9f-b379-bbb196ad5af5"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "architecto",
    "rows": 1,
    "columns": 1
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH templates/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: 9dd85e87-cede-4f9f-b379-bbb196ad5af5

Body Parameters

title   string   

Example: architecto

description   string  optional  
rows   number   

Must be at least 1. Must not be greater than 3. Example: 1

columns   number   

Must be at least 1. Must not be greater than 3. Example: 1

devices   string[]  optional  

The id of an existing record in the devices table.

registers   string[]  optional  

The id of an existing record in the registers table.

DELETE templates/{uuid}

Example request:
curl --request DELETE \
    "http://localhost/templates/9dd85e87-cede-4f9f-b379-bbb196ad5af5" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/templates/9dd85e87-cede-4f9f-b379-bbb196ad5af5"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE templates/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: 9dd85e87-cede-4f9f-b379-bbb196ad5af5

Topic

GET topics/create

Example request:
curl --request GET \
    --get "http://localhost/topics/create" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/topics/create"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6IlRhMjNrV3hmcFB2Q0pPTWNJdmlFdmc9PSIsInZhbHVlIjoiQk5Oak9sUVN1YTZnUW1udEJpZXpyZFJyYTVxK0RPcmc0by9sTDZPV3VlMHNXWW9JdE13cENzdldYNi83dnhveVYzT3ZTS3VBbWpVWDBZSTNYT3B3M1ZyNVJmeTlwb083eEN6YjArNGRTVFRlRkxXSGlqTDZxaHZSZktvQWduNXYiLCJtYWMiOiJmMGE3NDlkZDYyZWQ1NTI3NWI1OGM4MjA0N2E0MzVjOGVlODMyODI2ZWE3N2IyNWNmN2RkZjM2NGEzNDM1Mjk3IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6InJNUVFtZnA2V21kQWJubFVLMWVSVmc9PSIsInZhbHVlIjoiTGNtb3M4WjV4TGd0L3F0a3FYQU9mbEdzZGdzTzZqY1hOeVdGM09pRjNHc0hVQjI5bDV0VzlERUZacnhnT0ZjVVhxdEhtMkV0NDhDR3lZQWQ4UGxCTEFZOVVwWW9vQ2VHMFJWWmZpU3BSdzlVU3lBcUMxOEg0Q21oZFhhSXF2bHAiLCJtYWMiOiJjYmZjMzUyMzZlYzk5YzkxNWJlYzk4NzViOGM2YTZlNTE1NmM3MjQ0YjQ0ZjliMjdhNTkyYTEzZmFiOTdlNDY1IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET topics/create

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET topics/{uuid}

Example request:
curl --request GET \
    --get "http://localhost/topics/75698471-7cbd-477b-b01e-70cef9c46cd9" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/topics/75698471-7cbd-477b-b01e-70cef9c46cd9"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6InoxdjFyQkh3cWhDMFJwbVNlSnRGWEE9PSIsInZhbHVlIjoiN0dwYXE4U3dVa0hzbkUvMGN5aDhkK2pCV0FnMmhKR3QxdG1LVVM4K2ZVdjUvdUNPU2xKTmZYS0taNGJZR1BncHRBMmRZUHBQaW9sSTBlbTk2RGNLSTh0aVZYYkJZbTBBZUlMKzVVbGd0SU9qclhnVFBTZHF6cTM4eWZ6Wms4VEIiLCJtYWMiOiIxYzM5OWMwZmVhY2FjNmE1ZGFiNDRkMzUxNzY4ZWE1ZTk0NGI1NmIzNTg4MDNiZGM1YmVmM2FkMmQyYmI1MGI5IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6ImRIVm5CLy9iQ0w3ZVVjM3RjUHVudGc9PSIsInZhbHVlIjoic0hHaW9OZHF1d3FLWUt1VmRHTjY2c3NWNFhoenl1SVExd0NjUUcxSjhSdkVJWmxmcy9yeVVBcVZ4b2NhMERTeGNIdjRvMFp2MmVyTlRXYzEwRzRtOG9abVlYbjltdjZyU1ZIWXVkTHdVSko2aktzRlBlZ2IzSUVJVGo2VUxlajIiLCJtYWMiOiJmOTAzMWZlNDA2NjAxMWI3N2Q1MTg4MDFjMmVmYTk1N2FiYzA2NDMwMDM2ZjZlNjk5ZjZiMGJjMDRjNzYzMmQ0IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET topics/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: 75698471-7cbd-477b-b01e-70cef9c46cd9

DELETE topics/{uuid}

Example request:
curl --request DELETE \
    "http://localhost/topics/75698471-7cbd-477b-b01e-70cef9c46cd9" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/topics/75698471-7cbd-477b-b01e-70cef9c46cd9"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE topics/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: 75698471-7cbd-477b-b01e-70cef9c46cd9

Translate

GET translations/create

Example request:
curl --request GET \
    --get "http://localhost/translations/create" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/translations/create"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6InBtL0QzZkRzUWJMSEE3TzNZZ1VmakE9PSIsInZhbHVlIjoiTE9qYnNkaHBCdEpmcnZKcVEzb2h5YnZrL2p0RTVDR1ZZbk9JUG9ZU0N0T3BIUm5xVnJxdG0xRXJEeDFlRXdobVFOODF0Nk81K1RCY25jL2t4Q2FjVFdoYy9rQ2t0Q0hzT2lFV0tYRmlrczNWdjlENWJvSWZRL1c3YzdKa0tlQlQiLCJtYWMiOiJhYTdkMDNlNTNjNmU3NzU0NDlkZWRiZTA4ZWQ3NzZmZjljNjgxMTg2MTMyZGFkNTQwMWQwYWY5NDdmOWJjMGQ1IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6ImV4OThpZXFBN3VGN2sxZTlrZHZWRVE9PSIsInZhbHVlIjoiWVFpaXV0aHQybG5XaXdXaUYrZDZESDM2QisvR2xEVDdDeWRBUzNRQnFFMkM0MmtEMFRqVjJXbDdEN1c4WUlKeVZWVGxUSlUzRG0rb2ZJSE1WdjB3dUdTSUl2RTVBSnNyNGRqbWVpMEpGOU5Fb0x1amljUmpJWkVmU0huYWxqS0YiLCJtYWMiOiJiOWNkZWViODQxMDRlYzAwZDdiNjAzNjFhZTljODhiM2MxMTllNTJjMmY1NzFjOWM3NDJjMTcwZjU3ODFjNWE0IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET translations/create

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET translations/{uuid}

Example request:
curl --request GET \
    --get "http://localhost/translations/a69755d2-6872-4bb4-9cf9-aa8711c5cf20" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/translations/a69755d2-6872-4bb4-9cf9-aa8711c5cf20"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6InRnWjBDajJoTk5VV0VvcHJuajZTOEE9PSIsInZhbHVlIjoidno5K3pISkVZRWxJS01pMFVGMk1PbGp4MWIzTE1SaGVHK3c0SStNUVhwNFM0RUpNb0RDcEVSVER0cjgydVFwbnA4TWRLQWt4ZDA1VjRKL01XNDlTSlN5NWFnOVoyc1lCd000bEhlZTRZQ1JXaFBRL0ZvSFdWcGl1S21HZ3N1YzUiLCJtYWMiOiJiMmJiMGJhMGJhNDNiNTZkNWY1ZTYyZGMwMTA4MjdlMzU1ODBjMDVmYzQxZmFmMTIxMzIzMGVlYmFkOTJlYmZiIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6Ii9hclk1NkNRMFV1RUlGVUZUdklNd2c9PSIsInZhbHVlIjoiSHNDb1NMOXdlbHJKM0xCaXdXN1ZlVDAwVkFVQ3dnbkp0UHhkdjJKbXJUZ1JQQk5hRHZpamFKMkozTHd0VWFadE5QQTQwR0Ixbm1sajUrM3pVRjhRaDBDUU5NeGVnSURPTVBZeHA3S1dyOUJSVnVjU29Uc1g2cnpBRndjZ21TZEIiLCJtYWMiOiI4ZDk5YTUxNTUxZjY1ZDBiZmI5YTkwMjJiOGRlYjExZWQzYjYwMGM3NzdkMTE0NmM2NWI1MmJiYTY2ODliYjNjIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET translations/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: a69755d2-6872-4bb4-9cf9-aa8711c5cf20

GET translations/{translation_uuid}/edit

Example request:
curl --request GET \
    --get "http://localhost/translations/a69755d2-6872-4bb4-9cf9-aa8711c5cf20/edit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/translations/a69755d2-6872-4bb4-9cf9-aa8711c5cf20/edit"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6InlDekx2RENscmZwR1QyL3JQUXlxMnc9PSIsInZhbHVlIjoicWFkUTJSaWVySC9XRU9sSzg3U3BiZXhtQ1Q2RmtWbE13VlNTNjg0eHhzaHlZQjYrdWtiRDM4NTlxMzNaVWlESVBGRXM4cFRMOGs5YXVkQWZzSlo1enc4aC9VRndkbUlmZWZoTXRvRVZNdTVwSEtONmlTNEV2Y0VhTnllOHY1Yy8iLCJtYWMiOiJmZjI2NDEyNTIyZjkwOGNlOTg0MjM4MDM1MmM4ZjkyMzEyNTk4MTE5ZDZhODgwMmQ0NzFmMzAzM2FmNjU2MWU1IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6IlhzNmFOR3ArVnpDVFhiTHJGQjRRK0E9PSIsInZhbHVlIjoia3h3V2UxeVpWM3ZxcWxWVjlBUG5zZEo3aXJ1U0krNlVGU1VxazU2U2hQRlR0RzhnZkk2S29Iei9aa3laSHhVUHZCdGNocFBCUE5TS01ja2plVGROVG1pZzRuZUo4MDMxdklUbXd6ai9yWEdGNmJmN2NxWEgrQmpEdDlBR1RHSjUiLCJtYWMiOiIwMDcyYjY4ZjYwOTQwZTZkMjA2MmEyYzM5ZjU5NWZkYjhjNWJjNTUxMTBmM2M1Y2QyOTVhMTUyODM0NzMxZDE2IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET translations/{translation_uuid}/edit

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

translation_uuid   string   

Example: a69755d2-6872-4bb4-9cf9-aa8711c5cf20

PUT translations/{uuid}

Example request:
curl --request PUT \
    "http://localhost/translations/a69755d2-6872-4bb4-9cf9-aa8711c5cf20" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"key\": \"architecto\",
    \"lang\": \"architecto\",
    \"value\": \"architecto\"
}"
const url = new URL(
    "http://localhost/translations/a69755d2-6872-4bb4-9cf9-aa8711c5cf20"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "key": "architecto",
    "lang": "architecto",
    "value": "architecto"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT translations/{uuid}

PATCH translations/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: a69755d2-6872-4bb4-9cf9-aa8711c5cf20

Body Parameters

key   string   

Example: architecto

lang   string   

Example: architecto

value   string   

Example: architecto

DELETE translations/{uuid}

Example request:
curl --request DELETE \
    "http://localhost/translations/a69755d2-6872-4bb4-9cf9-aa8711c5cf20" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/translations/a69755d2-6872-4bb4-9cf9-aa8711c5cf20"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE translations/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: a69755d2-6872-4bb4-9cf9-aa8711c5cf20

User

GET users/create

Example request:
curl --request GET \
    --get "http://localhost/users/create" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/users/create"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6IkUrN3BFeEsvTW13aDVBSWhoWlkwcmc9PSIsInZhbHVlIjoiNVFheS9RLzhJV0pDQ2F1aVJKTnMvc0FhUjR5K3l6d2svRC9yUDljUU9zMkxFWlFCcmhWK1lQWDNvT3RiSWNGQjYxV1FvalZwZDdSd08rQTBvc0xjK1poVjNaU00vV2prQSsveWVwYUNWdS83VTFFRWdoODd6Q1RZSE5BR1VUTWYiLCJtYWMiOiJjNzcyMjI2ZDMwMjI4ZDFiNTU1MjNkMGNmNDBiNjVmNDUzNTRkMTYxMjRmYTA5ZmE0ZjEwZjdjNTliY2M3MzM0IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6IllyTXZrZStaUy94KytrcjdTN2N4NXc9PSIsInZhbHVlIjoiTXQyRUlMMldEWGJ5SkthL1F0RDI4OFhaNWx0ektUeDlwcDVyanh2YWlPd2hvSlFrRVp1NmQvdUNMekZHeUwxVjlBaCtyaFFCZkFBQXlUbUUrVktkejFISG96NnJZOWl2cnExTTV1L3k4Qlh5SHRraThBeUM4ZUhmeGJsR3B6OG4iLCJtYWMiOiIyMWYzNTFmZjJkYTdlMmFlY2FhMTRkMTk1YTlkMzE5MDI1N2EyZTkzYzIyZTgyOThjM2E3Njk1ZTk5MTIzNjVhIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET users/create

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET users/{uuid}

Example request:
curl --request GET \
    --get "http://localhost/users/6be6e4ed-fee4-4f16-ba4f-b514ff895b2f" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/users/6be6e4ed-fee4-4f16-ba4f-b514ff895b2f"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6Ik16NjN1R0FQSXNSVGVIeVhMc21WMlE9PSIsInZhbHVlIjoiNTVFR0xlUDloekhvUUkrRThMRTQyeVNpTlR3Z0JPL1RjL0thRkdKdlc2VkNmZGU4cFhHNDhSL1V2elZFR3hWbmU1QjhKQ1FHSjZHSE9qY2tEdERTWUxkRXA2Qk4wSVpFMkVxb2dCZ2MyNlJsVkg2Z1l0UnRYcEh1ZkFrM0toVnoiLCJtYWMiOiJlZjIzYTU0ZDcwYWVlM2JiOThkYzJhNGFkMjA3MjU5Zjk1YzhjMzZjNDdhZDM1M2NhMDM2ZDhlMWYzOWYzYWQwIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6IndUeWdYZ1pDNXNLbmcwL3VYalU5R2c9PSIsInZhbHVlIjoiRGxPdXV4TXFNQTVvcjdhQXh1SktaVDNzdG1yeUxuOVZWcVFGWFd1ZjRPSGF3em1GM0NkbythSklQN3llcE1QODVBSVJ1NGJqeS94RnBqdkRaR2twNEFVNng3eGNzS0tSV3FHYjM3amVWcE5mSndOME5WUkFnNkRqSHRHL1ZqVjciLCJtYWMiOiIyM2Q4MTA3YzVhMGFiNmZkZmIwYzgxZDI4NjQyYmZlNGRiZTRjZGZkNmNhMDM0MjJjNTc2NzY2MjY2YzRjZjhiIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET users/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: 6be6e4ed-fee4-4f16-ba4f-b514ff895b2f

GET users/{user_uuid}/edit

Example request:
curl --request GET \
    --get "http://localhost/users/6be6e4ed-fee4-4f16-ba4f-b514ff895b2f/edit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/users/6be6e4ed-fee4-4f16-ba4f-b514ff895b2f/edit"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6Ik1sR3BWSTFQOStsWGNQbGNCK0R4WUE9PSIsInZhbHVlIjoiOGE5dy9VZTdDcHVOYVQrdWdSWDVSTFcrdi8wQ3Z1QmtEQUNiNlBBT2hKNTBoc1NpOVR1SlRZMFVPV0ZBQjI2VEpZbS9OdXNGcW85cjlHOEJ2N3h3WjAyK1JHaDN5RVhFb0VuU3E4UDdxMSs0N3c5aUVFUUx0UHd5T1F4NDlZTmEiLCJtYWMiOiJkYzEzNGJiZGVhNWJkNTgwMjNhZTg2YzAwNzAzYjhlMTJmNWFlYzdiYmY2N2I2ZTU3MDJjNzMwMWRjMmE1Mjc4IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6Ik9rK1Z1RjB4RGFxeXZlVXJYZGthY2c9PSIsInZhbHVlIjoicmpJQ1liNGIxaHFjZ0pacDhlbFd1Ky9BbUNjZlorTEZRVzdsTUQwTUszeUlyU2Yvbmt2WFZoNUFtTW1oUlNadkdtdzR0ZUN3dWliVXplbnNxajJFbTN4dGtuSTlZbUxzT1BjZExaQ3p0WThla3BHMkV6ZitGbGtPN3ZFb0MxT0siLCJtYWMiOiJjNzNlYzY0NWEzOGJmNDJhMWFkYTU2NWZjYWI0MzIyY2IxOTdhMDgyY2UwOGU4NzdiNTU5YTg2YzI5ZmE4YjdmIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET users/{user_uuid}/edit

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_uuid   string   

Example: 6be6e4ed-fee4-4f16-ba4f-b514ff895b2f

PATCH users/{uuid}

Example request:
curl --request PATCH \
    "http://localhost/users/6be6e4ed-fee4-4f16-ba4f-b514ff895b2f" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"b\",
    \"email\": \"zbailey@example.net\",
    \"first_name\": \"i\",
    \"last_name\": \"y\",
    \"gender\": \"female\",
    \"timezone\": \"architecto\",
    \"calendar\": \"architecto\"
}"
const url = new URL(
    "http://localhost/users/6be6e4ed-fee4-4f16-ba4f-b514ff895b2f"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "b",
    "email": "zbailey@example.net",
    "first_name": "i",
    "last_name": "y",
    "gender": "female",
    "timezone": "architecto",
    "calendar": "architecto"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH users/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: 6be6e4ed-fee4-4f16-ba4f-b514ff895b2f

Body Parameters

name   string   

Must not be greater than 255 characters. Example: b

password   string  optional  
phone_number   string  optional  
email   string  optional  

Must be a valid email address. Example: zbailey@example.net

first_name   string  optional  

Must not be greater than 255 characters. Example: i

last_name   string  optional  

Must not be greater than 255 characters. Example: y

gender   string  optional  

Example: female

Must be one of:
  • male
  • female
birthday   string  optional  
address   string  optional  
roles   string  optional  

The id of an existing record in the roles table.

timezone   string   

Example: architecto

calendar   string   

Example: architecto

DELETE users/{uuid}

Example request:
curl --request DELETE \
    "http://localhost/users/6be6e4ed-fee4-4f16-ba4f-b514ff895b2f" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/users/6be6e4ed-fee4-4f16-ba4f-b514ff895b2f"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE users/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string   

Example: 6be6e4ed-fee4-4f16-ba4f-b514ff895b2f

GET users/{user_uuid}/profile

Example request:
curl --request GET \
    --get "http://localhost/users/6be6e4ed-fee4-4f16-ba4f-b514ff895b2f/profile" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/users/6be6e4ed-fee4-4f16-ba4f-b514ff895b2f/profile"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6Ild5SFVRTW4vUGlKRkNGMFBUQ1pTanc9PSIsInZhbHVlIjoib1ltSGd6UVFKdWErWjFTRVpQM2FybDAra2tPTkVPUERXSC9KUXlldUFkVnZzRURQdVZTM2VrcjJUWjNSaXN0b0JzdVFiZ0RUeGZydGFMYVIrNXRnK2o5ZDhyR3hCY3FhRjFQRzRNWVpzL3h4dGFnWnhQMHFoSjZ6OTMzclVMeGoiLCJtYWMiOiIxMDU5MzllNmI0MzU5NGRlZjY4ZWQ4YWY0YWM2MWZlMWRkZGM3N2MxNjk2MjM2ZTJiYTc5YjJjZjZjOTU0ODk0IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6IlVsS1dzVjFRR21xQkgvaDZxQ2tyVlE9PSIsInZhbHVlIjoidmUxUzBtVys3cDByckpRcVlYM2lHbnROVW02QnRqdkpqa2Iyb1F2Nlh4S21ZaDFyZ1ZlNVkreEU3NklKMTV0cEpBNEVjdHJPdDUzZlBJUGc1Y2s4c29RWUIrRzY4bW5xeFlaNFVYOHdFTEVaK2RVREdjVU5qYlcyRllDY0lQT3giLCJtYWMiOiIyMjIwMzA5Y2VjMjQ2MTk3YjNmZjA4YjJkZjdkYmU3NTk3MjgyNGRhMzY1YjBlZmZkNGVkOTNjMTc2MTg2OTQ4IiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET users/{user_uuid}/profile

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_uuid   string   

Example: 6be6e4ed-fee4-4f16-ba4f-b514ff895b2f

POST users/{user_uuid}/profile

Example request:
curl --request POST \
    "http://localhost/users/6be6e4ed-fee4-4f16-ba4f-b514ff895b2f/profile" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/users/6be6e4ed-fee4-4f16-ba4f-b514ff895b2f/profile"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request      

POST users/{user_uuid}/profile

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_uuid   string   

Example: 6be6e4ed-fee4-4f16-ba4f-b514ff895b2f

GET users/{user_uuid}/logs

Example request:
curl --request GET \
    --get "http://localhost/users/6be6e4ed-fee4-4f16-ba4f-b514ff895b2f/logs" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/users/6be6e4ed-fee4-4f16-ba4f-b514ff895b2f/logs"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
set-cookie: XSRF-TOKEN=eyJpdiI6IktMS2FDZG8ySHBMVkY5SmtYY2wycWc9PSIsInZhbHVlIjoiVVU4YzJsSzVVTDVWRFE2aTAyanBKaDF2U0FGVjRzaVBIajc1ZVJLcFRZRks4TlZLWHRZOWkrSlVkTkJQTXpkUktUNlRmNkl5VUFvRy91dXRFNy9JT2U3b0JHUWRHKzRuMFpHTXhyOFJCNmlFL1lsOEREaStkSHQzemRqSVM3UmEiLCJtYWMiOiJlNTQ3ZWI1MjA2YzBmYTdhZGM1YTVlNjQzYzFmYTFkYzA4Y2YxNzM5OGJlNDM0MmM2ZmJkNTZjMGQ3NTRiYjhkIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; samesite=lax; mmcp_session=eyJpdiI6IkxZTVdRSUNLZ3ZOKy9DM2JOd3JIZEE9PSIsInZhbHVlIjoiZzBrWm1zdHJMMWlkVHJOUGtEZjBpcENOaUl5Rmt4cmFnTmZpR0RONHVWQkRuQnRkQmluRXQ4bEl5U0ZpSVdROXFiUEFlVlNyMzQ4VGk2c0RFd0tTNUhsV0JQZDBpU2kxM0Q2UUVpM3ZTVGxXdEgwV0FUZzA4VkgvYmQyTWdGRFkiLCJtYWMiOiIxYTZkY2MzMWM1YjFlODMyMzQwYzhlNzZhNjhhNzQyOTI2MGY2MGVjNDc3NzE0OTBjZjhmOTViNGE3M2NiZmMyIiwidGFnIjoiIn0%3D; expires=Tue, 17 Jun 2025 08:43:22 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax
 

{
    "message": "Unauthenticated."
}
 

Request      

GET users/{user_uuid}/logs

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_uuid   string   

Example: 6be6e4ed-fee4-4f16-ba4f-b514ff895b2f

POST users/{user_uuid}/lang

Example request:
curl --request POST \
    "http://localhost/users/6be6e4ed-fee4-4f16-ba4f-b514ff895b2f/lang" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"lang\": \"architecto\"
}"
const url = new URL(
    "http://localhost/users/6be6e4ed-fee4-4f16-ba4f-b514ff895b2f/lang"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "lang": "architecto"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST users/{user_uuid}/lang

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_uuid   string   

Example: 6be6e4ed-fee4-4f16-ba4f-b514ff895b2f

Body Parameters

lang   string   

Example: architecto