site_manager 1.0
Servers
| Description | URL |
|---|---|
| Since site_manager is hosted locally the URL depends on your setup | http://example.com/api |
Endpoints
GET /devices
Read a list of devices
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
buildingId |
query | string | No | ||
rackId |
query | string | No | ||
roomId |
query | string | No | ||
siteId |
query | string | No |
Responses
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
[
{
"id": "d58de447-6349-487b-89f5-7ede4d355c87",
"name": "A-DSP",
"deviceTypeId": "lawo-auhd-core",
"deviceTypeName": "A_UHD Core",
"manufacturerId": "lawo",
"manufacturerName": "Lawo AG",
"manufacturerNameShort": "Lawo",
"rackType": "19INCH",
"rackHeight": 2,
"rackDepth": 324,
"description": "Audio DSP for the main mixer",
"notes": "This is scheduled for replacement in Q2",
"status": "INSTALLED",
"serialNumber": "356674567",
"siteId": "08da8b27-6a69-4497-bc7b-1501d3763e67",
"siteName": "Frankfurt",
"buildingId": "cee6df29-1b14-4c20-a87e-9439fbfa0c82",
"buildingName": "Production Center",
"roomId": "0b48b6da-add1-4bdd-ac12-d8fdfa5e057a",
"roomName": "MCR 1",
"roomNumber": "A01/045",
"rackId": "db46fd4f-d5fb-42c2-a8ee-5fb48da82924",
"rackName": "Rack 23",
"rackPosition": "FRONT",
"rackElevation": 23,
"createdAt": "2026-03-07T13:52:34.736Z",
"createdBy": "4B7y4PX9aJ8O0c2WyKhVmBqMqFRG9iay",
"createdByName": "John Doe",
"updatedAt": "2026-03-07T13:52:34.736Z",
"updatedBy": "4B7y4PX9aJ8O0c2WyKhVmBqMqFRG9iay",
"updatedByName": "John Doe",
"ports": [
{
"id": "47e9b0d0-fb3a-4107-a176-cef3ee14d236",
"portTypeId": "1263480a-7568-4976-aa6b-18930decb4c9",
"portTypeName": "WCLK IN",
"portTypeDirection": "IN",
"connectorId": "BNC_f",
"connectorName": "BNC 75 Ohm female",
"connectorGender": "MALE",
"connectorIcon": "BNC_f"
}
],
"moduleSlots": [
{
"id": "9adebae0-8fb2-4835-9056-42ae75db71e3",
"moduleSlotTypeId": "47ce131b-4a9e-47b4-b584-90806bb67627",
"moduleSlotTypeName": "SFP 1",
"module": {}
}
]
}
]
Schema of the response body
JSON
{
"type": "array",
"items": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Device model",
"description": "JSON document describing a single device",
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string",
"format": "uuid"
},
"name": {
"description": "",
"type": [
"string",
"null"
],
"examples": [
"A-DSP"
]
},
"deviceTypeId": {
"description": "Id of the device type. Consists of id of manufacturer followed by id of device type. See documentation for rules.",
"type": "string",
"pattern": "^(?=.{1,48}$)(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])?-[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$",
"maxLength": 48,
"examples": [
"lawo-auhd-core"
]
},
"deviceTypeName": {
"description": "Name of the device as given by manufacturer",
"type": "string",
"maxLength": 256,
"examples": [
"A_UHD Core"
]
},
"manufacturerId": {
"description": "Id of the manufacturer of the device type.",
"type": "string",
"pattern": "^(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])$",
"maxLength": 16,
"examples": [
"lawo"
]
},
"manufacturerName": {
"description": "",
"type": "string",
"examples": [
"Lawo AG"
]
},
"manufacturerNameShort": {
"description": "",
"type": "string",
"examples": [
"Lawo"
]
},
"rackType": {
"description": "Type of rack the device can be mounted in.",
"enum": [
"NONE",
"19INCH"
],
"type": "string",
"examples": [
"19INCH"
]
},
"rackHeight": {
"description": "Height of the device in rack units. 0 if device is not rackmountable.",
"type": "number",
"minimum": 0,
"examples": [
2
]
},
"rackDepth": {
"description": "Depth of the device within the rack in mm. Measured from the plane of the rack to the furthest protrusion of the device.",
"type": "number",
"minimum": 0,
"examples": [
324
]
},
"description": {
"description": "",
"type": [
"string",
"null"
],
"examples": [
"Audio DSP for the main mixer"
]
},
"notes": {
"description": "",
"type": [
"string",
"null"
],
"examples": [
"This is scheduled for replacement in Q2"
]
},
"status": {
"description": "",
"enum": [
"PLANNED",
"ORDERED",
"DELIVERED",
"INSTALLED",
"TESTED",
"IN_SERVICE",
"OUT_OF_SERVICE"
],
"type": [
"string",
"null"
],
"examples": [
"INSTALLED"
]
},
"serialNumber": {
"description": "",
"type": [
"string",
"null"
],
"examples": [
"356674567"
]
},
"siteId": {
"description": "",
"type": "string",
"format": "uuid"
},
"siteName": {
"description": "",
"type": "string",
"examples": [
"Frankfurt"
]
},
"buildingId": {
"description": "",
"type": "string",
"format": "uuid"
},
"buildingName": {
"description": "",
"type": "string",
"examples": [
"Production Center"
]
},
"roomId": {
"description": "",
"type": "string",
"format": "uuid"
},
"roomName": {
"description": "",
"type": "string",
"examples": [
"MCR 1"
]
},
"roomNumber": {
"description": "Number of the room",
"type": [
"string",
"null"
],
"maxLength": 16,
"examples": [
"A01/045"
]
},
"rackId": {
"description": "",
"type": "string",
"format": "uuid"
},
"rackName": {
"description": "",
"type": "string",
"examples": [
"Rack 23"
]
},
"rackPosition": {
"description": "Mounting position of the device in a rack",
"enum": [
"FRONT",
"BACK",
"LOOSE"
],
"type": "string",
"examples": [
"FRONT"
]
},
"rackElevation": {
"description": "Lowest rack unit the device occupies. Zero if device is not mounted in a rack.",
"type": "number",
"minimum": 0,
"examples": [
23
]
},
"createdAt": {
"description": "",
"type": "string",
"format": "date-time",
"examples": [
"2026-03-07T13:52:34.736Z"
]
},
"createdBy": {
"description": "",
"type": "string",
"examples": [
"4B7y4PX9aJ8O0c2WyKhVmBqMqFRG9iay"
]
},
"createdByName": {
"description": "",
"type": "string",
"examples": [
"John Doe"
]
},
"updatedAt": {
"description": "",
"type": "string",
"format": "date-time",
"examples": [
"2026-03-07T13:52:34.736Z"
]
},
"updatedBy": {
"description": "",
"type": "string",
"examples": [
"4B7y4PX9aJ8O0c2WyKhVmBqMqFRG9iay"
]
},
"updatedByName": {
"description": "",
"type": "string",
"examples": [
"John Doe"
]
},
"ports": {
"description": "",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string",
"format": "uuid"
},
"portTypeId": {
"description": "",
"type": "string",
"format": "uuid"
},
"portTypeName": {
"description": "Name of the port, as printed on the device.",
"type": "string",
"examples": [
"WCLK IN"
]
},
"portTypeDirection": {
"description": "Direction of the port type. See documentation for explainations of the possible values.",
"enum": [
"IN",
"OUT",
"INOUT",
"BIDI",
"UP",
"DOWN",
"FRONT",
"BACK"
],
"type": "string"
},
"connectorId": {
"description": "Id of the connector.",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_f"
]
},
"connectorName": {
"description": "",
"type": "string",
"examples": [
"BNC 75 Ohm female"
]
},
"connectorGender": {
"description": "",
"enum": [
"MALE",
"FEMALE",
"HERMA"
],
"type": "string"
},
"connectorIcon": {
"description": "Icon for use with this connector. These can be fetched as SVG icons from /icons/{id}.svg",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_f"
]
}
},
"required": [
"id",
"portTypeId",
"portTypeName",
"portTypeDirection",
"connectorId",
"connectorName",
"connectorIcon"
],
"additionalProperties": false
}
},
"moduleSlots": {
"description": "",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string",
"format": "uuid"
},
"moduleSlotTypeId": {
"description": "",
"type": "string",
"format": "uuid"
},
"moduleSlotTypeName": {
"description": "Name of the module slot, as labeled on the device.",
"type": "string",
"examples": [
"SFP 1"
]
},
"module": {
"type": "object"
}
},
"required": [
"id",
"moduleSlotTypeId",
"moduleSlotTypeName",
"module"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"name",
"deviceTypeId",
"deviceTypeName",
"manufacturerId",
"manufacturerName",
"manufacturerNameShort",
"rackType",
"rackHeight",
"rackDepth",
"description",
"serialNumber",
"siteId",
"siteName",
"buildingId",
"buildingName",
"roomId",
"roomName",
"roomNumber",
"rackId",
"rackName",
"rackPosition",
"rackElevation",
"ports",
"moduleSlots",
"createdAt",
"createdBy",
"createdByName",
"updatedAt",
"updatedBy",
"updatedByName"
],
"additionalProperties": false
}
}
Refer to the common response description: 400.
Refer to the common response description: 401.
Refer to the common response description: 500.
POST /devices
Add a device
Request body
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
{
"deviceTypeId": "lawo-auhd-core",
"rackId": "69de77b5-5899-41d3-89d2-e8786d0e5e4d",
"name": "A-DSP",
"rackPosition": "FRONT",
"rackElevation": 23,
"description": "Audio DSP for the main mixer",
"notes": "This is scheduled for replacement in Q2",
"status": "INSTALLED",
"serialNumber": "356674567"
}
Schema of the request body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "DeviceCreate model",
"description": "JSON document describing a new device",
"type": "object",
"properties": {
"deviceTypeId": {
"description": "Id of the device type. Consists of id of manufacturer followed by id of device type. See documentation for rules.",
"type": "string",
"pattern": "^(?=.{1,48}$)(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])?-[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$",
"maxLength": 48,
"examples": [
"lawo-auhd-core"
]
},
"rackId": {
"description": "",
"type": "string",
"format": "uuid"
},
"name": {
"description": "",
"type": [
"string",
"null"
],
"examples": [
"A-DSP"
]
},
"rackPosition": {
"description": "Mounting position of the device in a rack",
"enum": [
"FRONT",
"BACK",
"LOOSE"
],
"type": "string",
"examples": [
"FRONT"
]
},
"rackElevation": {
"description": "Lowest rack unit the device occupies. Zero if device is not mounted in a rack.",
"type": "number",
"minimum": 0,
"examples": [
23
]
},
"description": {
"description": "",
"type": [
"string",
"null"
],
"examples": [
"Audio DSP for the main mixer"
]
},
"notes": {
"description": "",
"type": [
"string",
"null"
],
"examples": [
"This is scheduled for replacement in Q2"
]
},
"status": {
"description": "",
"enum": [
"PLANNED",
"ORDERED",
"DELIVERED",
"INSTALLED",
"TESTED",
"IN_SERVICE",
"OUT_OF_SERVICE"
],
"type": [
"string",
"null"
],
"examples": [
"INSTALLED"
]
},
"serialNumber": {
"description": "",
"type": [
"string",
"null"
],
"examples": [
"356674567"
]
}
},
"required": [
"deviceTypeId",
"rackId"
],
"additionalProperties": false
}
Responses
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
{
"id": "0c11e9ec-3981-4d32-9ae5-b375652f68c9",
"name": "A-DSP",
"deviceTypeId": "lawo-auhd-core",
"deviceTypeName": "A_UHD Core",
"manufacturerId": "lawo",
"manufacturerName": "Lawo AG",
"manufacturerNameShort": "Lawo",
"rackType": "19INCH",
"rackHeight": 2,
"rackDepth": 324,
"description": "Audio DSP for the main mixer",
"notes": "This is scheduled for replacement in Q2",
"status": "INSTALLED",
"serialNumber": "356674567",
"siteId": "f0c1946e-4c99-42af-ac73-29b4738ae6bf",
"siteName": "Frankfurt",
"buildingId": "1f2d4ee7-c5f1-42e8-90dc-c9a8caa21a4b",
"buildingName": "Production Center",
"roomId": "c10bcdf3-d0d2-4468-b3e0-3571b10cb547",
"roomName": "MCR 1",
"roomNumber": "A01/045",
"rackId": "2ca30e24-7f32-4476-9ded-b4c985ff1f56",
"rackName": "Rack 23",
"rackPosition": "FRONT",
"rackElevation": 23,
"createdAt": "2026-03-07T13:52:34.736Z",
"createdBy": "4B7y4PX9aJ8O0c2WyKhVmBqMqFRG9iay",
"createdByName": "John Doe",
"updatedAt": "2026-03-07T13:52:34.736Z",
"updatedBy": "4B7y4PX9aJ8O0c2WyKhVmBqMqFRG9iay",
"updatedByName": "John Doe",
"ports": [
{
"id": "e82b9221-17c7-402f-94e4-c3ed631eb6b8",
"portTypeId": "1a3cee7f-826a-440d-9d2a-9839f6da6252",
"portTypeName": "WCLK IN",
"portTypeDirection": "IN",
"connectorId": "BNC_f",
"connectorName": "BNC 75 Ohm female",
"connectorGender": "MALE",
"connectorIcon": "BNC_f"
}
],
"moduleSlots": [
{
"id": "538144fb-ca2c-4d51-9105-1d83c9a8b531",
"moduleSlotTypeId": "10ba82f0-3916-4cc9-8c3f-4ae3e7eab974",
"moduleSlotTypeName": "SFP 1",
"module": {}
}
]
}
Schema of the response body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Device model",
"description": "JSON document describing a single device",
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string",
"format": "uuid"
},
"name": {
"description": "",
"type": [
"string",
"null"
],
"examples": [
"A-DSP"
]
},
"deviceTypeId": {
"description": "Id of the device type. Consists of id of manufacturer followed by id of device type. See documentation for rules.",
"type": "string",
"pattern": "^(?=.{1,48}$)(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])?-[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$",
"maxLength": 48,
"examples": [
"lawo-auhd-core"
]
},
"deviceTypeName": {
"description": "Name of the device as given by manufacturer",
"type": "string",
"maxLength": 256,
"examples": [
"A_UHD Core"
]
},
"manufacturerId": {
"description": "Id of the manufacturer of the device type.",
"type": "string",
"pattern": "^(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])$",
"maxLength": 16,
"examples": [
"lawo"
]
},
"manufacturerName": {
"description": "",
"type": "string",
"examples": [
"Lawo AG"
]
},
"manufacturerNameShort": {
"description": "",
"type": "string",
"examples": [
"Lawo"
]
},
"rackType": {
"description": "Type of rack the device can be mounted in.",
"enum": [
"NONE",
"19INCH"
],
"type": "string",
"examples": [
"19INCH"
]
},
"rackHeight": {
"description": "Height of the device in rack units. 0 if device is not rackmountable.",
"type": "number",
"minimum": 0,
"examples": [
2
]
},
"rackDepth": {
"description": "Depth of the device within the rack in mm. Measured from the plane of the rack to the furthest protrusion of the device.",
"type": "number",
"minimum": 0,
"examples": [
324
]
},
"description": {
"description": "",
"type": [
"string",
"null"
],
"examples": [
"Audio DSP for the main mixer"
]
},
"notes": {
"description": "",
"type": [
"string",
"null"
],
"examples": [
"This is scheduled for replacement in Q2"
]
},
"status": {
"description": "",
"enum": [
"PLANNED",
"ORDERED",
"DELIVERED",
"INSTALLED",
"TESTED",
"IN_SERVICE",
"OUT_OF_SERVICE"
],
"type": [
"string",
"null"
],
"examples": [
"INSTALLED"
]
},
"serialNumber": {
"description": "",
"type": [
"string",
"null"
],
"examples": [
"356674567"
]
},
"siteId": {
"description": "",
"type": "string",
"format": "uuid"
},
"siteName": {
"description": "",
"type": "string",
"examples": [
"Frankfurt"
]
},
"buildingId": {
"description": "",
"type": "string",
"format": "uuid"
},
"buildingName": {
"description": "",
"type": "string",
"examples": [
"Production Center"
]
},
"roomId": {
"description": "",
"type": "string",
"format": "uuid"
},
"roomName": {
"description": "",
"type": "string",
"examples": [
"MCR 1"
]
},
"roomNumber": {
"description": "Number of the room",
"type": [
"string",
"null"
],
"maxLength": 16,
"examples": [
"A01/045"
]
},
"rackId": {
"description": "",
"type": "string",
"format": "uuid"
},
"rackName": {
"description": "",
"type": "string",
"examples": [
"Rack 23"
]
},
"rackPosition": {
"description": "Mounting position of the device in a rack",
"enum": [
"FRONT",
"BACK",
"LOOSE"
],
"type": "string",
"examples": [
"FRONT"
]
},
"rackElevation": {
"description": "Lowest rack unit the device occupies. Zero if device is not mounted in a rack.",
"type": "number",
"minimum": 0,
"examples": [
23
]
},
"createdAt": {
"description": "",
"type": "string",
"format": "date-time",
"examples": [
"2026-03-07T13:52:34.736Z"
]
},
"createdBy": {
"description": "",
"type": "string",
"examples": [
"4B7y4PX9aJ8O0c2WyKhVmBqMqFRG9iay"
]
},
"createdByName": {
"description": "",
"type": "string",
"examples": [
"John Doe"
]
},
"updatedAt": {
"description": "",
"type": "string",
"format": "date-time",
"examples": [
"2026-03-07T13:52:34.736Z"
]
},
"updatedBy": {
"description": "",
"type": "string",
"examples": [
"4B7y4PX9aJ8O0c2WyKhVmBqMqFRG9iay"
]
},
"updatedByName": {
"description": "",
"type": "string",
"examples": [
"John Doe"
]
},
"ports": {
"description": "",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string",
"format": "uuid"
},
"portTypeId": {
"description": "",
"type": "string",
"format": "uuid"
},
"portTypeName": {
"description": "Name of the port, as printed on the device.",
"type": "string",
"examples": [
"WCLK IN"
]
},
"portTypeDirection": {
"description": "Direction of the port type. See documentation for explainations of the possible values.",
"enum": [
"IN",
"OUT",
"INOUT",
"BIDI",
"UP",
"DOWN",
"FRONT",
"BACK"
],
"type": "string"
},
"connectorId": {
"description": "Id of the connector.",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_f"
]
},
"connectorName": {
"description": "",
"type": "string",
"examples": [
"BNC 75 Ohm female"
]
},
"connectorGender": {
"description": "",
"enum": [
"MALE",
"FEMALE",
"HERMA"
],
"type": "string"
},
"connectorIcon": {
"description": "Icon for use with this connector. These can be fetched as SVG icons from /icons/{id}.svg",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_f"
]
}
},
"required": [
"id",
"portTypeId",
"portTypeName",
"portTypeDirection",
"connectorId",
"connectorName",
"connectorIcon"
],
"additionalProperties": false
}
},
"moduleSlots": {
"description": "",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string",
"format": "uuid"
},
"moduleSlotTypeId": {
"description": "",
"type": "string",
"format": "uuid"
},
"moduleSlotTypeName": {
"description": "Name of the module slot, as labeled on the device.",
"type": "string",
"examples": [
"SFP 1"
]
},
"module": {
"type": "object"
}
},
"required": [
"id",
"moduleSlotTypeId",
"moduleSlotTypeName",
"module"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"name",
"deviceTypeId",
"deviceTypeName",
"manufacturerId",
"manufacturerName",
"manufacturerNameShort",
"rackType",
"rackHeight",
"rackDepth",
"description",
"serialNumber",
"siteId",
"siteName",
"buildingId",
"buildingName",
"roomId",
"roomName",
"roomNumber",
"rackId",
"rackName",
"rackPosition",
"rackElevation",
"ports",
"moduleSlots",
"createdAt",
"createdBy",
"createdByName",
"updatedAt",
"updatedBy",
"updatedByName"
],
"additionalProperties": false
}
Refer to the common response description: 400.
Refer to the common response description: 401.
Refer to the common response description: 422.
Refer to the common response description: 500.
GET /devices/{deviceId}
Return information of a single device
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
deviceId |
path | string | No |
Responses
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
{
"id": "29174525-71b4-4a84-820a-382914f96485",
"name": "A-DSP",
"deviceTypeId": "lawo-auhd-core",
"deviceTypeName": "A_UHD Core",
"manufacturerId": "lawo",
"manufacturerName": "Lawo AG",
"manufacturerNameShort": "Lawo",
"rackType": "19INCH",
"rackHeight": 2,
"rackDepth": 324,
"description": "Audio DSP for the main mixer",
"notes": "This is scheduled for replacement in Q2",
"status": "INSTALLED",
"serialNumber": "356674567",
"siteId": "4f8c0985-2a56-4acd-b80a-276635722c96",
"siteName": "Frankfurt",
"buildingId": "734f5d41-d985-4cfe-95b1-0622b050d0f3",
"buildingName": "Production Center",
"roomId": "bbc75863-1211-4e38-8eb2-5f17a042aa28",
"roomName": "MCR 1",
"roomNumber": "A01/045",
"rackId": "f8f9429c-09e8-48de-a419-47f64550e3fd",
"rackName": "Rack 23",
"rackPosition": "FRONT",
"rackElevation": 23,
"createdAt": "2026-03-07T13:52:34.736Z",
"createdBy": "4B7y4PX9aJ8O0c2WyKhVmBqMqFRG9iay",
"createdByName": "John Doe",
"updatedAt": "2026-03-07T13:52:34.736Z",
"updatedBy": "4B7y4PX9aJ8O0c2WyKhVmBqMqFRG9iay",
"updatedByName": "John Doe",
"ports": [
{
"id": "4f02084a-deab-41c8-a1ac-922ba577da8a",
"portTypeId": "2ae06f5a-551d-4fd0-b3e4-04233bc15a64",
"portTypeName": "WCLK IN",
"portTypeDirection": "IN",
"connectorId": "BNC_f",
"connectorName": "BNC 75 Ohm female",
"connectorGender": "MALE",
"connectorIcon": "BNC_f"
}
],
"moduleSlots": [
{
"id": "3cc4d418-14eb-4406-8b2b-67da7c0f3e9f",
"moduleSlotTypeId": "efe35525-4ab4-41fb-9d42-c99cb9d9ead2",
"moduleSlotTypeName": "SFP 1",
"module": {}
}
]
}
Schema of the response body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Device model",
"description": "JSON document describing a single device",
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string",
"format": "uuid"
},
"name": {
"description": "",
"type": [
"string",
"null"
],
"examples": [
"A-DSP"
]
},
"deviceTypeId": {
"description": "Id of the device type. Consists of id of manufacturer followed by id of device type. See documentation for rules.",
"type": "string",
"pattern": "^(?=.{1,48}$)(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])?-[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$",
"maxLength": 48,
"examples": [
"lawo-auhd-core"
]
},
"deviceTypeName": {
"description": "Name of the device as given by manufacturer",
"type": "string",
"maxLength": 256,
"examples": [
"A_UHD Core"
]
},
"manufacturerId": {
"description": "Id of the manufacturer of the device type.",
"type": "string",
"pattern": "^(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])$",
"maxLength": 16,
"examples": [
"lawo"
]
},
"manufacturerName": {
"description": "",
"type": "string",
"examples": [
"Lawo AG"
]
},
"manufacturerNameShort": {
"description": "",
"type": "string",
"examples": [
"Lawo"
]
},
"rackType": {
"description": "Type of rack the device can be mounted in.",
"enum": [
"NONE",
"19INCH"
],
"type": "string",
"examples": [
"19INCH"
]
},
"rackHeight": {
"description": "Height of the device in rack units. 0 if device is not rackmountable.",
"type": "number",
"minimum": 0,
"examples": [
2
]
},
"rackDepth": {
"description": "Depth of the device within the rack in mm. Measured from the plane of the rack to the furthest protrusion of the device.",
"type": "number",
"minimum": 0,
"examples": [
324
]
},
"description": {
"description": "",
"type": [
"string",
"null"
],
"examples": [
"Audio DSP for the main mixer"
]
},
"notes": {
"description": "",
"type": [
"string",
"null"
],
"examples": [
"This is scheduled for replacement in Q2"
]
},
"status": {
"description": "",
"enum": [
"PLANNED",
"ORDERED",
"DELIVERED",
"INSTALLED",
"TESTED",
"IN_SERVICE",
"OUT_OF_SERVICE"
],
"type": [
"string",
"null"
],
"examples": [
"INSTALLED"
]
},
"serialNumber": {
"description": "",
"type": [
"string",
"null"
],
"examples": [
"356674567"
]
},
"siteId": {
"description": "",
"type": "string",
"format": "uuid"
},
"siteName": {
"description": "",
"type": "string",
"examples": [
"Frankfurt"
]
},
"buildingId": {
"description": "",
"type": "string",
"format": "uuid"
},
"buildingName": {
"description": "",
"type": "string",
"examples": [
"Production Center"
]
},
"roomId": {
"description": "",
"type": "string",
"format": "uuid"
},
"roomName": {
"description": "",
"type": "string",
"examples": [
"MCR 1"
]
},
"roomNumber": {
"description": "Number of the room",
"type": [
"string",
"null"
],
"maxLength": 16,
"examples": [
"A01/045"
]
},
"rackId": {
"description": "",
"type": "string",
"format": "uuid"
},
"rackName": {
"description": "",
"type": "string",
"examples": [
"Rack 23"
]
},
"rackPosition": {
"description": "Mounting position of the device in a rack",
"enum": [
"FRONT",
"BACK",
"LOOSE"
],
"type": "string",
"examples": [
"FRONT"
]
},
"rackElevation": {
"description": "Lowest rack unit the device occupies. Zero if device is not mounted in a rack.",
"type": "number",
"minimum": 0,
"examples": [
23
]
},
"createdAt": {
"description": "",
"type": "string",
"format": "date-time",
"examples": [
"2026-03-07T13:52:34.736Z"
]
},
"createdBy": {
"description": "",
"type": "string",
"examples": [
"4B7y4PX9aJ8O0c2WyKhVmBqMqFRG9iay"
]
},
"createdByName": {
"description": "",
"type": "string",
"examples": [
"John Doe"
]
},
"updatedAt": {
"description": "",
"type": "string",
"format": "date-time",
"examples": [
"2026-03-07T13:52:34.736Z"
]
},
"updatedBy": {
"description": "",
"type": "string",
"examples": [
"4B7y4PX9aJ8O0c2WyKhVmBqMqFRG9iay"
]
},
"updatedByName": {
"description": "",
"type": "string",
"examples": [
"John Doe"
]
},
"ports": {
"description": "",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string",
"format": "uuid"
},
"portTypeId": {
"description": "",
"type": "string",
"format": "uuid"
},
"portTypeName": {
"description": "Name of the port, as printed on the device.",
"type": "string",
"examples": [
"WCLK IN"
]
},
"portTypeDirection": {
"description": "Direction of the port type. See documentation for explainations of the possible values.",
"enum": [
"IN",
"OUT",
"INOUT",
"BIDI",
"UP",
"DOWN",
"FRONT",
"BACK"
],
"type": "string"
},
"connectorId": {
"description": "Id of the connector.",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_f"
]
},
"connectorName": {
"description": "",
"type": "string",
"examples": [
"BNC 75 Ohm female"
]
},
"connectorGender": {
"description": "",
"enum": [
"MALE",
"FEMALE",
"HERMA"
],
"type": "string"
},
"connectorIcon": {
"description": "Icon for use with this connector. These can be fetched as SVG icons from /icons/{id}.svg",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_f"
]
}
},
"required": [
"id",
"portTypeId",
"portTypeName",
"portTypeDirection",
"connectorId",
"connectorName",
"connectorIcon"
],
"additionalProperties": false
}
},
"moduleSlots": {
"description": "",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string",
"format": "uuid"
},
"moduleSlotTypeId": {
"description": "",
"type": "string",
"format": "uuid"
},
"moduleSlotTypeName": {
"description": "Name of the module slot, as labeled on the device.",
"type": "string",
"examples": [
"SFP 1"
]
},
"module": {
"type": "object"
}
},
"required": [
"id",
"moduleSlotTypeId",
"moduleSlotTypeName",
"module"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"name",
"deviceTypeId",
"deviceTypeName",
"manufacturerId",
"manufacturerName",
"manufacturerNameShort",
"rackType",
"rackHeight",
"rackDepth",
"description",
"serialNumber",
"siteId",
"siteName",
"buildingId",
"buildingName",
"roomId",
"roomName",
"roomNumber",
"rackId",
"rackName",
"rackPosition",
"rackElevation",
"ports",
"moduleSlots",
"createdAt",
"createdBy",
"createdByName",
"updatedAt",
"updatedBy",
"updatedByName"
],
"additionalProperties": false
}
Refer to the common response description: 401.
Refer to the common response description: 404.
Refer to the common response description: 500.
PATCH /devices/{deviceId}
Update a device
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
deviceId |
path | string | No |
Request body
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
{
"name": "DSP",
"rackId": "43e79c2f-a2b9-43bc-ad7e-b04fa03edc1b",
"rackPosition": "FRONT",
"rackElevation": 23,
"description": "Audio DSP for backup console",
"serialNumber": "54567675",
"notes": "This is scheduled for replacement in Q2",
"status": "INSTALLED"
}
Schema of the request body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "DeviceUpdate model",
"description": "JSON document describing updates to a device",
"type": "object",
"properties": {
"name": {
"description": "",
"type": [
"string",
"null"
],
"examples": [
"DSP"
]
},
"rackId": {
"description": "",
"type": "string",
"format": "uuid"
},
"rackPosition": {
"description": "Mounting position of the device in a rack",
"enum": [
"FRONT",
"BACK",
"LOOSE"
],
"type": "string",
"examples": [
"FRONT"
]
},
"rackElevation": {
"description": "Lowest rack unit the device occupies. Zero if device is not mounted in a rack.",
"type": "number",
"minimum": 0,
"examples": [
23
]
},
"description": {
"description": "",
"type": [
"string",
"null"
],
"examples": [
"Audio DSP for backup console"
]
},
"serialNumber": {
"description": "",
"type": [
"string",
"null"
],
"examples": [
"54567675"
]
},
"notes": {
"description": "",
"type": [
"string",
"null"
],
"examples": [
"This is scheduled for replacement in Q2"
]
},
"status": {
"description": "",
"enum": [
"PLANNED",
"ORDERED",
"DELIVERED",
"INSTALLED",
"TESTED",
"IN_SERVICE",
"OUT_OF_SERVICE"
],
"type": [
"string",
"null"
],
"examples": [
"INSTALLED"
]
}
},
"required": [],
"additionalProperties": false
}
Responses
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
{
"id": "57905d04-1d21-4422-9abd-c9272c8d63d8",
"name": "A-DSP",
"deviceTypeId": "lawo-auhd-core",
"deviceTypeName": "A_UHD Core",
"manufacturerId": "lawo",
"manufacturerName": "Lawo AG",
"manufacturerNameShort": "Lawo",
"rackType": "19INCH",
"rackHeight": 2,
"rackDepth": 324,
"description": "Audio DSP for the main mixer",
"notes": "This is scheduled for replacement in Q2",
"status": "INSTALLED",
"serialNumber": "356674567",
"siteId": "ab90ac41-243c-43b6-8ad3-03f11b0c65bd",
"siteName": "Frankfurt",
"buildingId": "19dbef5f-9d4c-43a5-8992-032a0c5c0a02",
"buildingName": "Production Center",
"roomId": "d134dbab-e027-49cb-a4e3-e2c57378cb11",
"roomName": "MCR 1",
"roomNumber": "A01/045",
"rackId": "ceb629c3-24ec-4e10-a13d-52cc1a7a1302",
"rackName": "Rack 23",
"rackPosition": "FRONT",
"rackElevation": 23,
"createdAt": "2026-03-07T13:52:34.736Z",
"createdBy": "4B7y4PX9aJ8O0c2WyKhVmBqMqFRG9iay",
"createdByName": "John Doe",
"updatedAt": "2026-03-07T13:52:34.736Z",
"updatedBy": "4B7y4PX9aJ8O0c2WyKhVmBqMqFRG9iay",
"updatedByName": "John Doe",
"ports": [
{
"id": "9e273f26-7332-4be0-8023-e039e21678e4",
"portTypeId": "30a6af74-21e1-4684-aefe-3cf3469e4a0c",
"portTypeName": "WCLK IN",
"portTypeDirection": "IN",
"connectorId": "BNC_f",
"connectorName": "BNC 75 Ohm female",
"connectorGender": "MALE",
"connectorIcon": "BNC_f"
}
],
"moduleSlots": [
{
"id": "fcffd8e9-e02a-49b4-a5dd-319362e965e8",
"moduleSlotTypeId": "ae074110-1fdf-4b70-a073-45b660ae7640",
"moduleSlotTypeName": "SFP 1",
"module": {}
}
]
}
Schema of the response body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Device model",
"description": "JSON document describing a single device",
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string",
"format": "uuid"
},
"name": {
"description": "",
"type": [
"string",
"null"
],
"examples": [
"A-DSP"
]
},
"deviceTypeId": {
"description": "Id of the device type. Consists of id of manufacturer followed by id of device type. See documentation for rules.",
"type": "string",
"pattern": "^(?=.{1,48}$)(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])?-[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$",
"maxLength": 48,
"examples": [
"lawo-auhd-core"
]
},
"deviceTypeName": {
"description": "Name of the device as given by manufacturer",
"type": "string",
"maxLength": 256,
"examples": [
"A_UHD Core"
]
},
"manufacturerId": {
"description": "Id of the manufacturer of the device type.",
"type": "string",
"pattern": "^(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])$",
"maxLength": 16,
"examples": [
"lawo"
]
},
"manufacturerName": {
"description": "",
"type": "string",
"examples": [
"Lawo AG"
]
},
"manufacturerNameShort": {
"description": "",
"type": "string",
"examples": [
"Lawo"
]
},
"rackType": {
"description": "Type of rack the device can be mounted in.",
"enum": [
"NONE",
"19INCH"
],
"type": "string",
"examples": [
"19INCH"
]
},
"rackHeight": {
"description": "Height of the device in rack units. 0 if device is not rackmountable.",
"type": "number",
"minimum": 0,
"examples": [
2
]
},
"rackDepth": {
"description": "Depth of the device within the rack in mm. Measured from the plane of the rack to the furthest protrusion of the device.",
"type": "number",
"minimum": 0,
"examples": [
324
]
},
"description": {
"description": "",
"type": [
"string",
"null"
],
"examples": [
"Audio DSP for the main mixer"
]
},
"notes": {
"description": "",
"type": [
"string",
"null"
],
"examples": [
"This is scheduled for replacement in Q2"
]
},
"status": {
"description": "",
"enum": [
"PLANNED",
"ORDERED",
"DELIVERED",
"INSTALLED",
"TESTED",
"IN_SERVICE",
"OUT_OF_SERVICE"
],
"type": [
"string",
"null"
],
"examples": [
"INSTALLED"
]
},
"serialNumber": {
"description": "",
"type": [
"string",
"null"
],
"examples": [
"356674567"
]
},
"siteId": {
"description": "",
"type": "string",
"format": "uuid"
},
"siteName": {
"description": "",
"type": "string",
"examples": [
"Frankfurt"
]
},
"buildingId": {
"description": "",
"type": "string",
"format": "uuid"
},
"buildingName": {
"description": "",
"type": "string",
"examples": [
"Production Center"
]
},
"roomId": {
"description": "",
"type": "string",
"format": "uuid"
},
"roomName": {
"description": "",
"type": "string",
"examples": [
"MCR 1"
]
},
"roomNumber": {
"description": "Number of the room",
"type": [
"string",
"null"
],
"maxLength": 16,
"examples": [
"A01/045"
]
},
"rackId": {
"description": "",
"type": "string",
"format": "uuid"
},
"rackName": {
"description": "",
"type": "string",
"examples": [
"Rack 23"
]
},
"rackPosition": {
"description": "Mounting position of the device in a rack",
"enum": [
"FRONT",
"BACK",
"LOOSE"
],
"type": "string",
"examples": [
"FRONT"
]
},
"rackElevation": {
"description": "Lowest rack unit the device occupies. Zero if device is not mounted in a rack.",
"type": "number",
"minimum": 0,
"examples": [
23
]
},
"createdAt": {
"description": "",
"type": "string",
"format": "date-time",
"examples": [
"2026-03-07T13:52:34.736Z"
]
},
"createdBy": {
"description": "",
"type": "string",
"examples": [
"4B7y4PX9aJ8O0c2WyKhVmBqMqFRG9iay"
]
},
"createdByName": {
"description": "",
"type": "string",
"examples": [
"John Doe"
]
},
"updatedAt": {
"description": "",
"type": "string",
"format": "date-time",
"examples": [
"2026-03-07T13:52:34.736Z"
]
},
"updatedBy": {
"description": "",
"type": "string",
"examples": [
"4B7y4PX9aJ8O0c2WyKhVmBqMqFRG9iay"
]
},
"updatedByName": {
"description": "",
"type": "string",
"examples": [
"John Doe"
]
},
"ports": {
"description": "",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string",
"format": "uuid"
},
"portTypeId": {
"description": "",
"type": "string",
"format": "uuid"
},
"portTypeName": {
"description": "Name of the port, as printed on the device.",
"type": "string",
"examples": [
"WCLK IN"
]
},
"portTypeDirection": {
"description": "Direction of the port type. See documentation for explainations of the possible values.",
"enum": [
"IN",
"OUT",
"INOUT",
"BIDI",
"UP",
"DOWN",
"FRONT",
"BACK"
],
"type": "string"
},
"connectorId": {
"description": "Id of the connector.",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_f"
]
},
"connectorName": {
"description": "",
"type": "string",
"examples": [
"BNC 75 Ohm female"
]
},
"connectorGender": {
"description": "",
"enum": [
"MALE",
"FEMALE",
"HERMA"
],
"type": "string"
},
"connectorIcon": {
"description": "Icon for use with this connector. These can be fetched as SVG icons from /icons/{id}.svg",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_f"
]
}
},
"required": [
"id",
"portTypeId",
"portTypeName",
"portTypeDirection",
"connectorId",
"connectorName",
"connectorIcon"
],
"additionalProperties": false
}
},
"moduleSlots": {
"description": "",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string",
"format": "uuid"
},
"moduleSlotTypeId": {
"description": "",
"type": "string",
"format": "uuid"
},
"moduleSlotTypeName": {
"description": "Name of the module slot, as labeled on the device.",
"type": "string",
"examples": [
"SFP 1"
]
},
"module": {
"type": "object"
}
},
"required": [
"id",
"moduleSlotTypeId",
"moduleSlotTypeName",
"module"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"name",
"deviceTypeId",
"deviceTypeName",
"manufacturerId",
"manufacturerName",
"manufacturerNameShort",
"rackType",
"rackHeight",
"rackDepth",
"description",
"serialNumber",
"siteId",
"siteName",
"buildingId",
"buildingName",
"roomId",
"roomName",
"roomNumber",
"rackId",
"rackName",
"rackPosition",
"rackElevation",
"ports",
"moduleSlots",
"createdAt",
"createdBy",
"createdByName",
"updatedAt",
"updatedBy",
"updatedByName"
],
"additionalProperties": false
}
Refer to the common response description: 400.
Refer to the common response description: 401.
Refer to the common response description: 404.
Refer to the common response description: 422.
Refer to the common response description: 500.
DELETE /devices/{deviceId}
Delete a device
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
deviceId |
path | string | No |
Responses
GET /ports/{portId}
Return information of a single port
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
portId |
path | No |
Responses
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
{
"id": "1d906b6d-c8a8-4a30-9e80-03f582348b2c",
"portTypeId": "0445e013-a4f2-43d0-aed9-7a7b2ec0c34a",
"portTypeName": "WCLK IN",
"portTypeDirection": "IN",
"connectorId": "BNC_f",
"connectorName": "BNC 75 Ohm female",
"connectorIcon": "BNC_f",
"connectorGender": "FEMALE",
"compatibleSignalTypes": [
{
"signalId": "WCLK",
"signalName": "Wordclock"
}
],
"compatibleConnectors": [
{
"connectorId": "BNC_m",
"connectorName": "BNC 75 Ohm male",
"connectorIcon": "BNC_m",
"connectorGender": "MALE"
}
]
}
Schema of the response body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Port model",
"description": "JSON document describing a port",
"type": "object",
"properties": {
"id": {
"description": "Id of the port",
"type": "string",
"format": "uuid"
},
"portTypeId": {
"description": "Id of the port type",
"type": "string",
"format": "uuid"
},
"portTypeName": {
"description": "Name of the port type, as printed on the device.",
"type": "string",
"examples": [
"WCLK IN"
]
},
"portTypeDirection": {
"description": "Direction of the port type. See documentation for explainations of the possible values.",
"enum": [
"IN",
"OUT",
"INOUT",
"BIDI",
"UP",
"DOWN",
"FRONT",
"BACK"
],
"type": "string",
"examples": [
"IN"
]
},
"connectorId": {
"description": "Id of the connector.",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_f"
]
},
"connectorName": {
"description": "Name of the connector.",
"type": "string",
"examples": [
"BNC 75 Ohm female"
]
},
"connectorIcon": {
"description": "Icon for use with this connector. These can be fetched as SVG icons from /icons/{id}.svg",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_f"
]
},
"connectorGender": {
"description": "Gender of the connector",
"enum": [
"MALE",
"FEMALE",
"HERMA"
],
"type": "string",
"examples": [
"FEMALE"
]
},
"compatibleSignalTypes": {
"description": "List of signal types that are compatible with this port",
"type": "array",
"items": {
"type": "object",
"properties": {
"signalId": {
"description": "Id of the signal type",
"type": "string",
"pattern": "^(?!.*--)(?:[a-z](?:[a-z-]{0,14}[a-z])?_)?[A-Z0-9]+(?:_[A-Z0-9]+)*$",
"examples": [
"WCLK"
]
},
"signalName": {
"description": "Name of the signal type",
"type": "string",
"examples": [
"Wordclock"
]
}
},
"required": [
"signalId",
"signalName"
],
"additionalProperties": false
}
},
"compatibleConnectors": {
"description": "",
"type": "array",
"items": {
"type": "object",
"properties": {
"connectorId": {
"description": "Id of the connector.",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_m"
]
},
"connectorName": {
"description": "Name of the connector.",
"type": "string",
"examples": [
"BNC 75 Ohm male"
]
},
"connectorIcon": {
"description": "Icon for use with this connector. These can be fetched as SVG icons from /icons/{id}.svg",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_m"
]
},
"connectorGender": {
"description": "Gender of the connector",
"enum": [
"MALE",
"FEMALE",
"HERMA"
],
"type": "string",
"examples": [
"MALE"
]
}
},
"required": [
"connectorId",
"connectorName",
"connectorIcon",
"connectorGender"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"portTypeId",
"portTypeName",
"portTypeDirection",
"connectorId",
"connectorName",
"connectorGender"
],
"additionalProperties": false
}
Refer to the common response description: 400.
Refer to the common response description: 401.
Refer to the common response description: 404.
Refer to the common response description: 500.
GET /modules
Get a list of all modules
Responses
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
[
{
"id": "ba97af67-4e7f-4ac8-9918-fda8f293913d",
"moduleTypeId": "lawo-dante-io",
"manufacturerId": "lawo",
"manufacturerNameShort": "Lawo",
"ports": [
{
"id": "8b327b10-26ce-4d31-80a8-7890daf7d1e6",
"portTypeId": "7827c9f0-ead6-48f3-8bd9-0e48590b9f1d",
"portTypeName": "Dante Pri",
"portTypeDirection": "UP",
"connectorId": "RJ45_f",
"connectorName": "RJ45 female",
"connectorIcon": "RJ45_f",
"connectorGender": "FEMALE"
}
],
"moduleSlots": [
{
"id": "3c2c7385-1813-4a2a-845f-014f0385166d",
"moduleSlotTypeId": "173488cb-f07b-427f-acf4-5b6cbabbfa90",
"moduleSlotTypeName": "SFP 1",
"module": {}
}
]
}
]
Schema of the response body
JSON
{
"type": "array",
"items": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Module model",
"description": "JSON document describing a module",
"type": "object",
"properties": {
"id": {
"description": "Id of the module",
"type": "string",
"format": "uuid"
},
"moduleTypeId": {
"description": "Id of the module type. Consists of id of manufacturer followed by id of module type. See documentation for rules.",
"type": "string",
"pattern": "^(?=.{1,48}$)(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])?-[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$",
"maxLength": 48,
"examples": [
"lawo-dante-io"
]
},
"manufacturerId": {
"description": "Id of the manufacturer of the device type.",
"type": "string",
"patter": "^(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])$",
"maxLength": 16,
"examples": [
"lawo"
]
},
"manufacturerNameShort": {
"description": "",
"type": "string",
"examples": [
"Lawo"
]
},
"ports": {
"description": "",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string",
"format": "uuid"
},
"portTypeId": {
"description": "",
"type": "string",
"format": "uuid"
},
"portTypeName": {
"description": "Name of the port, as printed on the device.",
"type": "string",
"examples": [
"Dante Pri"
]
},
"portTypeDirection": {
"description": "Direction of the port type. See documentation for explainations of the possible values.",
"enum": [
"IN",
"OUT",
"INOUT",
"BIDI",
"UP",
"DOWN",
"FRONT",
"BACK"
],
"type": "string",
"examples": [
"UP"
]
},
"connectorId": {
"description": "Id of the connector.",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"RJ45_f"
]
},
"connectorName": {
"description": "Name of the connector",
"type": "string",
"examples": [
"RJ45 female"
]
},
"connectorIcon": {
"description": "Icon for use with this connector. These can be fetched as SVG icons from /icons/{id}.svg",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"RJ45_f"
]
},
"connectorGender": {
"description": "Gender of the connector",
"enum": [
"MALE",
"FEMALE",
"HERMA"
],
"type": "string",
"examples": [
"FEMALE"
]
}
},
"required": [
"id",
"portTypeId",
"portTypeName",
"portTypeDirection",
"connectorId",
"connectorName",
"connectorIcon",
"connectorGender"
],
"additionalProperties": false
}
},
"moduleSlots": {
"description": "",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string",
"format": "uuid"
},
"moduleSlotTypeId": {
"description": "",
"type": "string",
"format": "uuid"
},
"moduleSlotTypeName": {
"description": "Name of the module slot, as labeled on the device.",
"type": "string",
"examples": [
"SFP 1"
]
},
"module": {
"type": "object"
}
},
"required": [
"id",
"moduleSlotTypeId",
"moduleSlotTypeName",
"module"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"moduleTypeId",
"manufacturerId",
"manufacturerNameShort",
"ports",
"moduleSlots"
],
"additionalProperties": false
}
}
Refer to the common response description: 401.
Refer to the common response description: 500.
POST /modules
Create a new module
Request body
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "ModuleCreate model",
"description": "JSON document describing a new module",
"type": "object",
"properties": {
"moduleTypeId": {
"description": "Id of the module type. Consists of id of manufacturer followed by id of module type. See documentation for rules.",
"type": "string",
"pattern": "^(?=.{1,48}$)(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])?-[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$",
"maxLength": 48,
"examples": [
"lawo-dante-io"
]
},
"moduleSlotId": {
"description": "Id of the module slot",
"type": "string",
"format": "uuid"
}
},
"required": [
"moduleTypeId",
"moduleSlotId"
],
"additionalProperties": false
}
Responses
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
{
"id": "c9088fcf-12c2-4a45-b321-26a684ddf18e",
"moduleTypeId": "lawo-dante-io",
"manufacturerId": "lawo",
"manufacturerNameShort": "Lawo",
"ports": [
{
"id": "0ac9e447-9ac7-44c7-9e97-a24d46712291",
"portTypeId": "05a13f4a-bfb9-4afe-a00a-7be4125af66b",
"portTypeName": "Dante Pri",
"portTypeDirection": "UP",
"connectorId": "RJ45_f",
"connectorName": "RJ45 female",
"connectorIcon": "RJ45_f",
"connectorGender": "FEMALE"
}
],
"moduleSlots": [
{
"id": "cf295f20-b372-4860-b84e-2d43b4e38a96",
"moduleSlotTypeId": "7d6a0de5-f03e-4cd8-86d6-37d33245b453",
"moduleSlotTypeName": "SFP 1",
"module": {}
}
]
}
Schema of the response body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Module model",
"description": "JSON document describing a module",
"type": "object",
"properties": {
"id": {
"description": "Id of the module",
"type": "string",
"format": "uuid"
},
"moduleTypeId": {
"description": "Id of the module type. Consists of id of manufacturer followed by id of module type. See documentation for rules.",
"type": "string",
"pattern": "^(?=.{1,48}$)(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])?-[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$",
"maxLength": 48,
"examples": [
"lawo-dante-io"
]
},
"manufacturerId": {
"description": "Id of the manufacturer of the device type.",
"type": "string",
"patter": "^(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])$",
"maxLength": 16,
"examples": [
"lawo"
]
},
"manufacturerNameShort": {
"description": "",
"type": "string",
"examples": [
"Lawo"
]
},
"ports": {
"description": "",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string",
"format": "uuid"
},
"portTypeId": {
"description": "",
"type": "string",
"format": "uuid"
},
"portTypeName": {
"description": "Name of the port, as printed on the device.",
"type": "string",
"examples": [
"Dante Pri"
]
},
"portTypeDirection": {
"description": "Direction of the port type. See documentation for explainations of the possible values.",
"enum": [
"IN",
"OUT",
"INOUT",
"BIDI",
"UP",
"DOWN",
"FRONT",
"BACK"
],
"type": "string",
"examples": [
"UP"
]
},
"connectorId": {
"description": "Id of the connector.",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"RJ45_f"
]
},
"connectorName": {
"description": "Name of the connector",
"type": "string",
"examples": [
"RJ45 female"
]
},
"connectorIcon": {
"description": "Icon for use with this connector. These can be fetched as SVG icons from /icons/{id}.svg",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"RJ45_f"
]
},
"connectorGender": {
"description": "Gender of the connector",
"enum": [
"MALE",
"FEMALE",
"HERMA"
],
"type": "string",
"examples": [
"FEMALE"
]
}
},
"required": [
"id",
"portTypeId",
"portTypeName",
"portTypeDirection",
"connectorId",
"connectorName",
"connectorIcon",
"connectorGender"
],
"additionalProperties": false
}
},
"moduleSlots": {
"description": "",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string",
"format": "uuid"
},
"moduleSlotTypeId": {
"description": "",
"type": "string",
"format": "uuid"
},
"moduleSlotTypeName": {
"description": "Name of the module slot, as labeled on the device.",
"type": "string",
"examples": [
"SFP 1"
]
},
"module": {
"type": "object"
}
},
"required": [
"id",
"moduleSlotTypeId",
"moduleSlotTypeName",
"module"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"moduleTypeId",
"manufacturerId",
"manufacturerNameShort",
"ports",
"moduleSlots"
],
"additionalProperties": false
}
Refer to the common response description: 400.
Refer to the common response description: 401.
Refer to the common response description: 422.
Refer to the common response description: 500.
GET /modules/{moduleId}
Return information of a single module
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
moduleId |
path | string | No |
Responses
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
{
"id": "15feb665-0c9a-47fb-b387-1fc22f2fcf2f",
"moduleTypeId": "lawo-dante-io",
"manufacturerId": "lawo",
"manufacturerNameShort": "Lawo",
"ports": [
{
"id": "61998a19-0968-434e-b638-3e59dea32c8d",
"portTypeId": "e81b5b02-70e8-449b-afcd-7be0864e71ce",
"portTypeName": "Dante Pri",
"portTypeDirection": "UP",
"connectorId": "RJ45_f",
"connectorName": "RJ45 female",
"connectorIcon": "RJ45_f",
"connectorGender": "FEMALE"
}
],
"moduleSlots": [
{
"id": "69c3e664-deda-4257-b5cd-57a573ec8d92",
"moduleSlotTypeId": "5265f6fe-5faa-4fbf-b20b-79965a2cb112",
"moduleSlotTypeName": "SFP 1",
"module": {}
}
]
}
Schema of the response body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Module model",
"description": "JSON document describing a module",
"type": "object",
"properties": {
"id": {
"description": "Id of the module",
"type": "string",
"format": "uuid"
},
"moduleTypeId": {
"description": "Id of the module type. Consists of id of manufacturer followed by id of module type. See documentation for rules.",
"type": "string",
"pattern": "^(?=.{1,48}$)(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])?-[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$",
"maxLength": 48,
"examples": [
"lawo-dante-io"
]
},
"manufacturerId": {
"description": "Id of the manufacturer of the device type.",
"type": "string",
"patter": "^(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])$",
"maxLength": 16,
"examples": [
"lawo"
]
},
"manufacturerNameShort": {
"description": "",
"type": "string",
"examples": [
"Lawo"
]
},
"ports": {
"description": "",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string",
"format": "uuid"
},
"portTypeId": {
"description": "",
"type": "string",
"format": "uuid"
},
"portTypeName": {
"description": "Name of the port, as printed on the device.",
"type": "string",
"examples": [
"Dante Pri"
]
},
"portTypeDirection": {
"description": "Direction of the port type. See documentation for explainations of the possible values.",
"enum": [
"IN",
"OUT",
"INOUT",
"BIDI",
"UP",
"DOWN",
"FRONT",
"BACK"
],
"type": "string",
"examples": [
"UP"
]
},
"connectorId": {
"description": "Id of the connector.",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"RJ45_f"
]
},
"connectorName": {
"description": "Name of the connector",
"type": "string",
"examples": [
"RJ45 female"
]
},
"connectorIcon": {
"description": "Icon for use with this connector. These can be fetched as SVG icons from /icons/{id}.svg",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"RJ45_f"
]
},
"connectorGender": {
"description": "Gender of the connector",
"enum": [
"MALE",
"FEMALE",
"HERMA"
],
"type": "string",
"examples": [
"FEMALE"
]
}
},
"required": [
"id",
"portTypeId",
"portTypeName",
"portTypeDirection",
"connectorId",
"connectorName",
"connectorIcon",
"connectorGender"
],
"additionalProperties": false
}
},
"moduleSlots": {
"description": "",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string",
"format": "uuid"
},
"moduleSlotTypeId": {
"description": "",
"type": "string",
"format": "uuid"
},
"moduleSlotTypeName": {
"description": "Name of the module slot, as labeled on the device.",
"type": "string",
"examples": [
"SFP 1"
]
},
"module": {
"type": "object"
}
},
"required": [
"id",
"moduleSlotTypeId",
"moduleSlotTypeName",
"module"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"moduleTypeId",
"manufacturerId",
"manufacturerNameShort",
"ports",
"moduleSlots"
],
"additionalProperties": false
}
Refer to the common response description: 400.
Refer to the common response description: 401.
Refer to the common response description: 404.
Refer to the common response description: 500.
DELETE /modules/{moduleId}
Delete a module
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
moduleId |
path | string | No |
Responses
GET /cables
Return a list of cables
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
endBuildingId |
query | string | No | ||
endRackId |
query | string | No | ||
endRoomId |
query | string | No | ||
startBuildingId |
query | string | No | ||
startRackId |
query | string | No | ||
startRoomId |
query | string | No |
Responses
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
[
{
"id": "25aa4c84-51a8-4702-ab1e-460de4d87e1e",
"number": "x21045",
"length": 5,
"notes": "This is scheduled for replacement in Q2",
"status": "INSTALLED",
"cableTypeId": "CAT_6_flex",
"cableTypeName": "Cat.6 flex",
"compatibleCableTypes": [
{
"id": "CAT_7_flex",
"name": "Cat.7 flex"
}
],
"createdAt": "2026-03-07T13:52:34.736Z",
"createdBy": "4B7y4PX9aJ8O0c2WyKhVmBqMqFRG9iay",
"createdByName": "John Doe",
"updatedAt": "2026-03-07T13:52:34.736Z",
"updatedBy": "4B7y4PX9aJ8O0c2WyKhVmBqMqFRG9iay",
"updatedByName": "John Doe",
"startPortId": "e73ede3a-89bf-4e7f-899d-dce736f5528f",
"startPortName": "WCLK OUT",
"startPortDirection": "OUT",
"startConnectorId": "BNC_m",
"startConnectorColor": "red",
"startConnectorName": "BNC 75 Ohm male",
"startConnectorGender": "MALE",
"startConnectorIcon": "BNC_m",
"compatibleStartConnectors": [
{
"id": "BNC_m",
"name": "BNC 75 Ohm male",
"icon": "BNC_m",
"gender": "MALE"
}
],
"startDeviceId": "09ea7129-b05c-4235-aa78-af8e7d1bba11",
"startDeviceName": "CLK-GEN1",
"startRackId": "5b887eaa-9a27-4f17-b7d2-63d33431fd3f",
"startRackName": "Rack 14",
"startRoomId": "e144e8cc-4876-47a5-a4dc-9ba326b3951d",
"startRoomName": "MCR-CAR",
"startRoomNumber": "01-025",
"startBuildingId": "9ec6288a-eb91-4a6a-8bb4-6c07856a4a1b",
"startBuildingName": "Production Center",
"startSiteId": "7eddc088-a9e6-4b08-9ded-b615369f010e",
"startSiteName": "Frankfurt",
"endPortId": "c3726e5c-44c7-474b-b1ef-9f1d876e6015",
"endPortName": "WCLK IN",
"endPortDirection": "IN",
"endConnectorId": "BNC_m",
"endConnectorColor": "red",
"endConnectorName": "WCLK IN",
"endConnectorGender": "MALE",
"endConnectorIcon": "BNC_m",
"compatibleEndConnectors": [
{
"id": "BNC_m",
"name": "BNC 75 Ohm male",
"icon": "BNC_m",
"gender": "MALE"
}
],
"endDeviceId": "f77b5979-cf65-42b0-8118-1874971e3017",
"endDeviceName": "A-DSP",
"endRackId": "a296e625-5957-487b-9492-9d74c8c6c073",
"endRackName": "Rack 15",
"endRoomId": "f716a0e1-506c-4cc1-b60f-ae769b3bfb87",
"endRoomName": "MCR-CAR",
"endRoomNumber": "01-025",
"endBuildingId": "aaaa2b96-08b7-4c73-bb4f-7ebabde48b81",
"endBuildingName": "Production Center",
"endSiteId": "7784ccd6-c5dc-4574-b752-be23e1c45633",
"endSiteName": "Frankfurt"
}
]
Schema of the response body
JSON
{
"type": "array",
"items": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Cable model",
"description": "JSON document describing a cable",
"type": "object",
"properties": {
"id": {
"description": "Id of the cable",
"type": "string",
"format": "uuid"
},
"number": {
"description": "Number of the cable",
"type": [
"string",
"null"
],
"examples": [
"x21045"
]
},
"length": {
"description": "length of the cable in meters",
"type": [
"number",
"null"
],
"minimum": 0,
"examples": [
5
]
},
"notes": {
"description": "",
"type": [
"string",
"null"
],
"examples": [
"This is scheduled for replacement in Q2"
]
},
"status": {
"description": "",
"enum": [
"PLANNED",
"ORDERED",
"DELIVERED",
"INSTALLED",
"TESTED",
"IN_SERVICE",
"OUT_OF_SERVICE"
],
"type": [
"string",
"null"
],
"examples": [
"INSTALLED"
]
},
"cableTypeId": {
"description": "Id of the cable type",
"type": "string",
"examples": [
"CAT_6_flex"
]
},
"cableTypeName": {
"description": "Name of the cable type",
"type": "string",
"examples": [
"Cat.6 flex"
]
},
"compatibleCableTypes": {
"description": "List of alternative cable types that would be valid",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Id of the cable type",
"type": "string",
"examples": [
"CAT_7_flex"
]
},
"name": {
"description": "Name of the cable type",
"type": "string",
"examples": [
"Cat.7 flex"
]
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
}
},
"createdAt": {
"description": "",
"type": "string",
"format": "date-time",
"examples": [
"2026-03-07T13:52:34.736Z"
]
},
"createdBy": {
"description": "",
"type": "string",
"examples": [
"4B7y4PX9aJ8O0c2WyKhVmBqMqFRG9iay"
]
},
"createdByName": {
"description": "",
"type": "string",
"examples": [
"John Doe"
]
},
"updatedAt": {
"description": "",
"type": "string",
"format": "date-time",
"examples": [
"2026-03-07T13:52:34.736Z"
]
},
"updatedBy": {
"description": "",
"type": "string",
"examples": [
"4B7y4PX9aJ8O0c2WyKhVmBqMqFRG9iay"
]
},
"updatedByName": {
"description": "",
"type": "string",
"examples": [
"John Doe"
]
},
"startPortId": {
"description": "Id of the port at the start side of the cable",
"type": "string",
"format": "uuid"
},
"startPortName": {
"description": "Name of the port at the start side of the cable",
"type": "string",
"examples": [
"WCLK OUT"
]
},
"startPortDirection": {
"description": "Direction of the port. See documentation for explainations of the possible values.",
"enum": [
"IN",
"OUT",
"INOUT",
"BIDI",
"UP",
"DOWN",
"FRONT",
"BACK"
],
"type": "string",
"examples": [
"OUT"
]
},
"startConnectorId": {
"description": "Id of the connector attached to the start side of the cable",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_m"
]
},
"startConnectorColor": {
"description": "Name of the connector, e.g. housing or sleeve, attached to the start side of the cable",
"enum": [
"red",
"blue",
"orange",
"yellow",
"green",
"beige",
"brown",
"lightgray",
"mediumgray",
"black",
"purple",
"cyan",
"white",
"pink"
],
"type": [
"string",
"null"
],
"examples": [
"red"
]
},
"startConnectorName": {
"description": "Name of the connector attached to the start side of the cable",
"type": "string",
"examples": [
"BNC 75 Ohm male"
]
},
"startConnectorGender": {
"description": "Gender of the connector attached to the start side of the cable",
"enum": [
"MALE",
"FEMALE",
"HERMA"
],
"examples": [
"MALE"
]
},
"startConnectorIcon": {
"description": "Icon for use with this connector. These can be fetched as SVG icons from /icons/{id}.svg",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_m"
]
},
"compatibleStartConnectors": {
"type": "array",
"items": {
"description": "List of alternative connectors that would be valid",
"type": "object",
"properties": {
"id": {
"description": "Id of the connector",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_m"
]
},
"name": {
"description": "Name of the connector",
"type": "string",
"examples": [
"BNC 75 Ohm male"
]
},
"icon": {
"description": "Icon for use with this connector. These can be fetched as SVG icons from /icons/{id}.svg",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_m"
]
},
"gender": {
"description": "Gender of the connector",
"enum": [
"MALE",
"FEMALE",
"HERMA"
],
"examples": [
"MALE"
]
}
},
"required": [
"id",
"name",
"icon",
"gender"
],
"additionalProperties": false
}
},
"startDeviceId": {
"description": "Id of the device at the start side of the cable",
"type": "string",
"format": "uuid"
},
"startDeviceName": {
"description": "Name of the device at the start side of the cable",
"type": "string",
"examples": [
"CLK-GEN1"
]
},
"startRackId": {
"description": "Id of the rack at the start side of the cable",
"type": "string",
"format": "uuid"
},
"startRackName": {
"description": "Name of the rack at the start side of the cable",
"type": "string",
"examples": [
"Rack 14"
]
},
"startRoomId": {
"description": "Id of the room at the start side of the cable",
"type": "string",
"format": "uuid"
},
"startRoomName": {
"description": "Name of the room at the start side of the cable",
"type": "string",
"examples": [
"MCR-CAR"
]
},
"startRoomNumber": {
"description": "Number of the room",
"type": [
"string",
"null"
],
"maxLength": 16,
"examples": [
"01-025"
]
},
"startBuildingId": {
"description": "Id of the building at the start side of the cable",
"type": "string",
"format": "uuid"
},
"startBuildingName": {
"description": "Name of the building at the start side of the cable",
"type": "string",
"examples": [
"Production Center"
]
},
"startSiteId": {
"description": "Id of the site at the start side of the cable",
"type": "string",
"format": "uuid"
},
"startSiteName": {
"description": "Name of the site at the start side of the cable",
"type": "string",
"examples": [
"Frankfurt"
]
},
"endPortId": {
"description": "Id of the port at the end side of the cable",
"type": "string",
"format": "uuid"
},
"endPortName": {
"description": "Name of the port at the end side of the cable",
"type": "string",
"examples": [
"WCLK IN"
]
},
"endPortDirection": {
"description": "Direction of the port. See documentation for explainations of the possible values.",
"enum": [
"IN",
"OUT",
"INOUT",
"BIDI",
"UP",
"DOWN",
"FRONT",
"BACK"
],
"type": "string",
"examples": [
"IN"
]
},
"endConnectorId": {
"description": "Id of the connector attached to the end side of the cable",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_m"
]
},
"endConnectorColor": {
"description": "Name of the connector, e.g. housing or sleeve, attached to the end side of the cable",
"enum": [
"red",
"blue",
"orange",
"yellow",
"green",
"beige",
"brown",
"lightgray",
"mediumgray",
"black",
"purple",
"cyan",
"white",
"pink"
],
"type": [
"string",
"null"
],
"examples": [
"red"
]
},
"endConnectorName": {
"description": "Name of the connector attached to the end side of the cable",
"type": "string",
"examples": [
"WCLK IN"
]
},
"endConnectorGender": {
"description": "Gender of the connector attached to the end side of the cable",
"enum": [
"MALE",
"FEMALE",
"HERMA"
],
"examples": [
"MALE"
]
},
"endConnectorIcon": {
"description": "Icon for use with this connector. These can be fetched as SVG icons from /icons/{id}.svg",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_m"
]
},
"compatibleEndConnectors": {
"description": "List of alternative connectors that would be valid",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Id of the connector",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_m"
]
},
"name": {
"description": "Name of the connector",
"type": "string",
"examples": [
"BNC 75 Ohm male"
]
},
"icon": {
"description": "Icon for use with this connector. These can be fetched as SVG icons from /icons/{id}.svg",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_m"
]
},
"gender": {
"description": "Gender of the connector",
"enum": [
"MALE",
"FEMALE",
"HERMA"
],
"examples": [
"MALE"
]
}
},
"required": [
"id",
"name",
"icon",
"gender"
],
"additionalProperties": false
}
},
"endDeviceId": {
"description": "Id of the device at the end side of the cable",
"type": "string",
"format": "uuid"
},
"endDeviceName": {
"description": "Name of the device at the end side of the cable",
"type": "string",
"examples": [
"A-DSP"
]
},
"endRackId": {
"description": "Id of the rack at the end side of the cable",
"type": "string",
"format": "uuid"
},
"endRackName": {
"description": "Name of the rack at the end side of the cable",
"type": "string",
"examples": [
"Rack 15"
]
},
"endRoomId": {
"description": "Id of the room at the end side of the cable",
"type": "string",
"format": "uuid"
},
"endRoomName": {
"description": "Name of the room at the end side of the cable",
"type": "string",
"examples": [
"MCR-CAR"
]
},
"endRoomNumber": {
"description": "Number of the room",
"type": [
"string",
"null"
],
"maxLength": 16,
"examples": [
"01-025"
]
},
"endBuildingId": {
"description": "Id of the building at the end side of the cable",
"type": "string",
"format": "uuid"
},
"endBuildingName": {
"description": "Name of the building at the end side of the cable",
"type": "string",
"examples": [
"Production Center"
]
},
"endSiteId": {
"description": "Id of the site at the end side of the cable",
"type": "string",
"format": "uuid"
},
"endSiteName": {
"description": "Name of the site at the end side of the cable",
"type": "string",
"examples": [
"Frankfurt"
]
}
},
"required": [
"id",
"number",
"length",
"notes",
"status",
"cableTypeId",
"cableTypeName",
"compatibleCableTypes",
"createdAt",
"createdBy",
"createdByName",
"updatedAt",
"updatedBy",
"updatedByName",
"startPortId",
"startPortName",
"startPortDirection",
"startConnectorId",
"startConnectorColor",
"startConnectorName",
"startConnectorGender",
"startConnectorIcon",
"compatibleStartConnectors",
"startDeviceId",
"startDeviceName",
"startRackId",
"startRackName",
"startRoomId",
"startRoomName",
"startRoomNumber",
"startBuildingId",
"startBuildingName",
"startSiteId",
"startSiteName",
"endPortId",
"endPortName",
"endPortDirection",
"endConnectorId",
"endConnectorColor",
"endConnectorName",
"endConnectorGender",
"endConnectorIcon",
"compatibleEndConnectors",
"endDeviceId",
"endDeviceName",
"endRackId",
"endRackName",
"endRoomId",
"endRoomName",
"endRoomNumber",
"endBuildingId",
"endBuildingName",
"endSiteId",
"endSiteName"
],
"additionalProperties": false
}
}
Refer to the common response description: 400.
Refer to the common response description: 401.
Refer to the common response description: 500.
POST /cables
Add a new cableId
Request body
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
{
"number": "x21045",
"length": 5,
"cableTypeId": "CAT_6_flex",
"startPortId": "638e7133-f83e-4a7e-b010-471d68d0acb6",
"startConnectorId": "BNC_m",
"startConnectorColor": "red",
"endPortId": "12e42dd8-1751-42d1-80f7-bff1badeb275",
"endConnectorId": "BNC_m",
"endConnectorColor": "red"
}
Schema of the request body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "CableCreate model",
"description": "JSON document describing a new cable",
"type": "object",
"properties": {
"number": {
"description": "Number of the cable",
"type": [
"string",
"null"
],
"examples": [
"x21045"
]
},
"length": {
"description": "length of the cable in meters",
"type": [
"number",
"null"
],
"minimum": 0,
"examples": [
5
]
},
"cableTypeId": {
"description": "Id of the cable type",
"type": [
"string",
"null"
],
"examples": [
"CAT_6_flex"
]
},
"startPortId": {
"description": "Id of the port at the start side of the cable",
"type": "string",
"format": "uuid"
},
"startConnectorId": {
"description": "Id of the connector attached to the start side of the cable",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_m"
]
},
"startConnectorColor": {
"description": "Name of the connector, e.g. housing or sleeve, attached to the start side of the cable",
"enum": [
"red",
"blue",
"orange",
"yellow",
"green",
"beige",
"brown",
"lightgray",
"mediumgray",
"black",
"purple",
"cyan",
"white",
"pink"
],
"type": [
"string",
"null"
],
"examples": [
"red"
]
},
"endPortId": {
"description": "Id of the port at the end side of the cable",
"type": "string",
"format": "uuid"
},
"endConnectorId": {
"description": "Id of the connector attached to the end side of the cable",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_m"
]
},
"endConnectorColor": {
"description": "Name of the connector, e.g. housing or sleeve, attached to the end side of the cable",
"enum": [
"red",
"blue",
"orange",
"yellow",
"green",
"beige",
"brown",
"lightgray",
"mediumgray",
"black",
"purple",
"cyan",
"white",
"pink"
],
"type": [
"string",
"null"
],
"examples": [
"red"
]
}
},
"required": [
"startPortId",
"endPortId"
],
"additionalProperties": false
}
Responses
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
{
"id": "b3d3b3bd-be56-4a5c-8898-bbada73e756a",
"number": "x21045",
"length": 5,
"notes": "This is scheduled for replacement in Q2",
"status": "INSTALLED",
"cableTypeId": "CAT_6_flex",
"cableTypeName": "Cat.6 flex",
"compatibleCableTypes": [
{
"id": "CAT_7_flex",
"name": "Cat.7 flex"
}
],
"createdAt": "2026-03-07T13:52:34.736Z",
"createdBy": "4B7y4PX9aJ8O0c2WyKhVmBqMqFRG9iay",
"createdByName": "John Doe",
"updatedAt": "2026-03-07T13:52:34.736Z",
"updatedBy": "4B7y4PX9aJ8O0c2WyKhVmBqMqFRG9iay",
"updatedByName": "John Doe",
"startPortId": "61cb6b3e-60e9-4b73-9e3c-100e1d00b037",
"startPortName": "WCLK OUT",
"startPortDirection": "OUT",
"startConnectorId": "BNC_m",
"startConnectorColor": "red",
"startConnectorName": "BNC 75 Ohm male",
"startConnectorGender": "MALE",
"startConnectorIcon": "BNC_m",
"compatibleStartConnectors": [
{
"id": "BNC_m",
"name": "BNC 75 Ohm male",
"icon": "BNC_m",
"gender": "MALE"
}
],
"startDeviceId": "50ad61cb-9e95-413c-9d44-f5370c7b7797",
"startDeviceName": "CLK-GEN1",
"startRackId": "7ba6fdce-1dbc-482e-b0c4-b3b567a81b20",
"startRackName": "Rack 14",
"startRoomId": "fcce5e90-a75d-4a5f-a08d-a3d613916f62",
"startRoomName": "MCR-CAR",
"startRoomNumber": "01-025",
"startBuildingId": "fe458b91-c7d1-4206-bfbe-9776898530e0",
"startBuildingName": "Production Center",
"startSiteId": "63a3a930-b52d-424c-badf-58d01851b645",
"startSiteName": "Frankfurt",
"endPortId": "1e26d410-76b9-4b08-93c1-4f0619e14610",
"endPortName": "WCLK IN",
"endPortDirection": "IN",
"endConnectorId": "BNC_m",
"endConnectorColor": "red",
"endConnectorName": "WCLK IN",
"endConnectorGender": "MALE",
"endConnectorIcon": "BNC_m",
"compatibleEndConnectors": [
{
"id": "BNC_m",
"name": "BNC 75 Ohm male",
"icon": "BNC_m",
"gender": "MALE"
}
],
"endDeviceId": "1938759e-96fc-4afe-9871-0b45cbcf09c0",
"endDeviceName": "A-DSP",
"endRackId": "9d4e6fda-ad81-4cd9-bac3-e8a64edc1dd4",
"endRackName": "Rack 15",
"endRoomId": "fb41e80f-4737-44ed-a54f-4452efa31ca3",
"endRoomName": "MCR-CAR",
"endRoomNumber": "01-025",
"endBuildingId": "57cac0d4-0929-4521-9127-7f6e7c946b09",
"endBuildingName": "Production Center",
"endSiteId": "85aa61b5-ea98-49a8-8ca9-d5e0e71c5ead",
"endSiteName": "Frankfurt"
}
Schema of the response body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Cable model",
"description": "JSON document describing a cable",
"type": "object",
"properties": {
"id": {
"description": "Id of the cable",
"type": "string",
"format": "uuid"
},
"number": {
"description": "Number of the cable",
"type": [
"string",
"null"
],
"examples": [
"x21045"
]
},
"length": {
"description": "length of the cable in meters",
"type": [
"number",
"null"
],
"minimum": 0,
"examples": [
5
]
},
"notes": {
"description": "",
"type": [
"string",
"null"
],
"examples": [
"This is scheduled for replacement in Q2"
]
},
"status": {
"description": "",
"enum": [
"PLANNED",
"ORDERED",
"DELIVERED",
"INSTALLED",
"TESTED",
"IN_SERVICE",
"OUT_OF_SERVICE"
],
"type": [
"string",
"null"
],
"examples": [
"INSTALLED"
]
},
"cableTypeId": {
"description": "Id of the cable type",
"type": "string",
"examples": [
"CAT_6_flex"
]
},
"cableTypeName": {
"description": "Name of the cable type",
"type": "string",
"examples": [
"Cat.6 flex"
]
},
"compatibleCableTypes": {
"description": "List of alternative cable types that would be valid",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Id of the cable type",
"type": "string",
"examples": [
"CAT_7_flex"
]
},
"name": {
"description": "Name of the cable type",
"type": "string",
"examples": [
"Cat.7 flex"
]
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
}
},
"createdAt": {
"description": "",
"type": "string",
"format": "date-time",
"examples": [
"2026-03-07T13:52:34.736Z"
]
},
"createdBy": {
"description": "",
"type": "string",
"examples": [
"4B7y4PX9aJ8O0c2WyKhVmBqMqFRG9iay"
]
},
"createdByName": {
"description": "",
"type": "string",
"examples": [
"John Doe"
]
},
"updatedAt": {
"description": "",
"type": "string",
"format": "date-time",
"examples": [
"2026-03-07T13:52:34.736Z"
]
},
"updatedBy": {
"description": "",
"type": "string",
"examples": [
"4B7y4PX9aJ8O0c2WyKhVmBqMqFRG9iay"
]
},
"updatedByName": {
"description": "",
"type": "string",
"examples": [
"John Doe"
]
},
"startPortId": {
"description": "Id of the port at the start side of the cable",
"type": "string",
"format": "uuid"
},
"startPortName": {
"description": "Name of the port at the start side of the cable",
"type": "string",
"examples": [
"WCLK OUT"
]
},
"startPortDirection": {
"description": "Direction of the port. See documentation for explainations of the possible values.",
"enum": [
"IN",
"OUT",
"INOUT",
"BIDI",
"UP",
"DOWN",
"FRONT",
"BACK"
],
"type": "string",
"examples": [
"OUT"
]
},
"startConnectorId": {
"description": "Id of the connector attached to the start side of the cable",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_m"
]
},
"startConnectorColor": {
"description": "Name of the connector, e.g. housing or sleeve, attached to the start side of the cable",
"enum": [
"red",
"blue",
"orange",
"yellow",
"green",
"beige",
"brown",
"lightgray",
"mediumgray",
"black",
"purple",
"cyan",
"white",
"pink"
],
"type": [
"string",
"null"
],
"examples": [
"red"
]
},
"startConnectorName": {
"description": "Name of the connector attached to the start side of the cable",
"type": "string",
"examples": [
"BNC 75 Ohm male"
]
},
"startConnectorGender": {
"description": "Gender of the connector attached to the start side of the cable",
"enum": [
"MALE",
"FEMALE",
"HERMA"
],
"examples": [
"MALE"
]
},
"startConnectorIcon": {
"description": "Icon for use with this connector. These can be fetched as SVG icons from /icons/{id}.svg",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_m"
]
},
"compatibleStartConnectors": {
"type": "array",
"items": {
"description": "List of alternative connectors that would be valid",
"type": "object",
"properties": {
"id": {
"description": "Id of the connector",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_m"
]
},
"name": {
"description": "Name of the connector",
"type": "string",
"examples": [
"BNC 75 Ohm male"
]
},
"icon": {
"description": "Icon for use with this connector. These can be fetched as SVG icons from /icons/{id}.svg",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_m"
]
},
"gender": {
"description": "Gender of the connector",
"enum": [
"MALE",
"FEMALE",
"HERMA"
],
"examples": [
"MALE"
]
}
},
"required": [
"id",
"name",
"icon",
"gender"
],
"additionalProperties": false
}
},
"startDeviceId": {
"description": "Id of the device at the start side of the cable",
"type": "string",
"format": "uuid"
},
"startDeviceName": {
"description": "Name of the device at the start side of the cable",
"type": "string",
"examples": [
"CLK-GEN1"
]
},
"startRackId": {
"description": "Id of the rack at the start side of the cable",
"type": "string",
"format": "uuid"
},
"startRackName": {
"description": "Name of the rack at the start side of the cable",
"type": "string",
"examples": [
"Rack 14"
]
},
"startRoomId": {
"description": "Id of the room at the start side of the cable",
"type": "string",
"format": "uuid"
},
"startRoomName": {
"description": "Name of the room at the start side of the cable",
"type": "string",
"examples": [
"MCR-CAR"
]
},
"startRoomNumber": {
"description": "Number of the room",
"type": [
"string",
"null"
],
"maxLength": 16,
"examples": [
"01-025"
]
},
"startBuildingId": {
"description": "Id of the building at the start side of the cable",
"type": "string",
"format": "uuid"
},
"startBuildingName": {
"description": "Name of the building at the start side of the cable",
"type": "string",
"examples": [
"Production Center"
]
},
"startSiteId": {
"description": "Id of the site at the start side of the cable",
"type": "string",
"format": "uuid"
},
"startSiteName": {
"description": "Name of the site at the start side of the cable",
"type": "string",
"examples": [
"Frankfurt"
]
},
"endPortId": {
"description": "Id of the port at the end side of the cable",
"type": "string",
"format": "uuid"
},
"endPortName": {
"description": "Name of the port at the end side of the cable",
"type": "string",
"examples": [
"WCLK IN"
]
},
"endPortDirection": {
"description": "Direction of the port. See documentation for explainations of the possible values.",
"enum": [
"IN",
"OUT",
"INOUT",
"BIDI",
"UP",
"DOWN",
"FRONT",
"BACK"
],
"type": "string",
"examples": [
"IN"
]
},
"endConnectorId": {
"description": "Id of the connector attached to the end side of the cable",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_m"
]
},
"endConnectorColor": {
"description": "Name of the connector, e.g. housing or sleeve, attached to the end side of the cable",
"enum": [
"red",
"blue",
"orange",
"yellow",
"green",
"beige",
"brown",
"lightgray",
"mediumgray",
"black",
"purple",
"cyan",
"white",
"pink"
],
"type": [
"string",
"null"
],
"examples": [
"red"
]
},
"endConnectorName": {
"description": "Name of the connector attached to the end side of the cable",
"type": "string",
"examples": [
"WCLK IN"
]
},
"endConnectorGender": {
"description": "Gender of the connector attached to the end side of the cable",
"enum": [
"MALE",
"FEMALE",
"HERMA"
],
"examples": [
"MALE"
]
},
"endConnectorIcon": {
"description": "Icon for use with this connector. These can be fetched as SVG icons from /icons/{id}.svg",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_m"
]
},
"compatibleEndConnectors": {
"description": "List of alternative connectors that would be valid",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Id of the connector",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_m"
]
},
"name": {
"description": "Name of the connector",
"type": "string",
"examples": [
"BNC 75 Ohm male"
]
},
"icon": {
"description": "Icon for use with this connector. These can be fetched as SVG icons from /icons/{id}.svg",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_m"
]
},
"gender": {
"description": "Gender of the connector",
"enum": [
"MALE",
"FEMALE",
"HERMA"
],
"examples": [
"MALE"
]
}
},
"required": [
"id",
"name",
"icon",
"gender"
],
"additionalProperties": false
}
},
"endDeviceId": {
"description": "Id of the device at the end side of the cable",
"type": "string",
"format": "uuid"
},
"endDeviceName": {
"description": "Name of the device at the end side of the cable",
"type": "string",
"examples": [
"A-DSP"
]
},
"endRackId": {
"description": "Id of the rack at the end side of the cable",
"type": "string",
"format": "uuid"
},
"endRackName": {
"description": "Name of the rack at the end side of the cable",
"type": "string",
"examples": [
"Rack 15"
]
},
"endRoomId": {
"description": "Id of the room at the end side of the cable",
"type": "string",
"format": "uuid"
},
"endRoomName": {
"description": "Name of the room at the end side of the cable",
"type": "string",
"examples": [
"MCR-CAR"
]
},
"endRoomNumber": {
"description": "Number of the room",
"type": [
"string",
"null"
],
"maxLength": 16,
"examples": [
"01-025"
]
},
"endBuildingId": {
"description": "Id of the building at the end side of the cable",
"type": "string",
"format": "uuid"
},
"endBuildingName": {
"description": "Name of the building at the end side of the cable",
"type": "string",
"examples": [
"Production Center"
]
},
"endSiteId": {
"description": "Id of the site at the end side of the cable",
"type": "string",
"format": "uuid"
},
"endSiteName": {
"description": "Name of the site at the end side of the cable",
"type": "string",
"examples": [
"Frankfurt"
]
}
},
"required": [
"id",
"number",
"length",
"notes",
"status",
"cableTypeId",
"cableTypeName",
"compatibleCableTypes",
"createdAt",
"createdBy",
"createdByName",
"updatedAt",
"updatedBy",
"updatedByName",
"startPortId",
"startPortName",
"startPortDirection",
"startConnectorId",
"startConnectorColor",
"startConnectorName",
"startConnectorGender",
"startConnectorIcon",
"compatibleStartConnectors",
"startDeviceId",
"startDeviceName",
"startRackId",
"startRackName",
"startRoomId",
"startRoomName",
"startRoomNumber",
"startBuildingId",
"startBuildingName",
"startSiteId",
"startSiteName",
"endPortId",
"endPortName",
"endPortDirection",
"endConnectorId",
"endConnectorColor",
"endConnectorName",
"endConnectorGender",
"endConnectorIcon",
"compatibleEndConnectors",
"endDeviceId",
"endDeviceName",
"endRackId",
"endRackName",
"endRoomId",
"endRoomName",
"endRoomNumber",
"endBuildingId",
"endBuildingName",
"endSiteId",
"endSiteName"
],
"additionalProperties": false
}
Refer to the common response description: 400.
Refer to the common response description: 401.
Refer to the common response description: 422.
Refer to the common response description: 500.
GET /cables/{cableId}
Get information of a cable
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cableId |
path | string | No |
Responses
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
{
"id": "10036b41-0fdf-4859-9f02-f4f0eb76c968",
"number": "x21045",
"length": 5,
"notes": "This is scheduled for replacement in Q2",
"status": "INSTALLED",
"cableTypeId": "CAT_6_flex",
"cableTypeName": "Cat.6 flex",
"compatibleCableTypes": [
{
"id": "CAT_7_flex",
"name": "Cat.7 flex"
}
],
"createdAt": "2026-03-07T13:52:34.736Z",
"createdBy": "4B7y4PX9aJ8O0c2WyKhVmBqMqFRG9iay",
"createdByName": "John Doe",
"updatedAt": "2026-03-07T13:52:34.736Z",
"updatedBy": "4B7y4PX9aJ8O0c2WyKhVmBqMqFRG9iay",
"updatedByName": "John Doe",
"startPortId": "8099404f-d8bb-4859-bca0-9107ee2d1659",
"startPortName": "WCLK OUT",
"startPortDirection": "OUT",
"startConnectorId": "BNC_m",
"startConnectorColor": "red",
"startConnectorName": "BNC 75 Ohm male",
"startConnectorGender": "MALE",
"startConnectorIcon": "BNC_m",
"compatibleStartConnectors": [
{
"id": "BNC_m",
"name": "BNC 75 Ohm male",
"icon": "BNC_m",
"gender": "MALE"
}
],
"startDeviceId": "d41de272-c439-4b77-9c58-a7d704de421e",
"startDeviceName": "CLK-GEN1",
"startRackId": "153b3833-1bab-4dfd-933c-a95d7eeaf4bd",
"startRackName": "Rack 14",
"startRoomId": "e810a62c-d2a5-42bf-9c67-a4125ddf4d68",
"startRoomName": "MCR-CAR",
"startRoomNumber": "01-025",
"startBuildingId": "35041702-62bc-4a82-8e08-8fe653b78bac",
"startBuildingName": "Production Center",
"startSiteId": "6d1d865c-2d8d-49ae-8cea-2e327dd48d2b",
"startSiteName": "Frankfurt",
"endPortId": "d683f4d7-7ce6-4e20-8c54-f56f5310defe",
"endPortName": "WCLK IN",
"endPortDirection": "IN",
"endConnectorId": "BNC_m",
"endConnectorColor": "red",
"endConnectorName": "WCLK IN",
"endConnectorGender": "MALE",
"endConnectorIcon": "BNC_m",
"compatibleEndConnectors": [
{
"id": "BNC_m",
"name": "BNC 75 Ohm male",
"icon": "BNC_m",
"gender": "MALE"
}
],
"endDeviceId": "33f7ab3c-2807-4d60-8d08-ec9975908265",
"endDeviceName": "A-DSP",
"endRackId": "074b7e7e-7fea-464e-8b23-7384efccb2dd",
"endRackName": "Rack 15",
"endRoomId": "b1f54cde-a865-4d28-b20c-fe13cafcf57b",
"endRoomName": "MCR-CAR",
"endRoomNumber": "01-025",
"endBuildingId": "15e8c1b2-b7db-4270-8823-64d33380a2fe",
"endBuildingName": "Production Center",
"endSiteId": "2530cac8-08eb-4598-9a04-99088526ed48",
"endSiteName": "Frankfurt"
}
Schema of the response body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Cable model",
"description": "JSON document describing a cable",
"type": "object",
"properties": {
"id": {
"description": "Id of the cable",
"type": "string",
"format": "uuid"
},
"number": {
"description": "Number of the cable",
"type": [
"string",
"null"
],
"examples": [
"x21045"
]
},
"length": {
"description": "length of the cable in meters",
"type": [
"number",
"null"
],
"minimum": 0,
"examples": [
5
]
},
"notes": {
"description": "",
"type": [
"string",
"null"
],
"examples": [
"This is scheduled for replacement in Q2"
]
},
"status": {
"description": "",
"enum": [
"PLANNED",
"ORDERED",
"DELIVERED",
"INSTALLED",
"TESTED",
"IN_SERVICE",
"OUT_OF_SERVICE"
],
"type": [
"string",
"null"
],
"examples": [
"INSTALLED"
]
},
"cableTypeId": {
"description": "Id of the cable type",
"type": "string",
"examples": [
"CAT_6_flex"
]
},
"cableTypeName": {
"description": "Name of the cable type",
"type": "string",
"examples": [
"Cat.6 flex"
]
},
"compatibleCableTypes": {
"description": "List of alternative cable types that would be valid",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Id of the cable type",
"type": "string",
"examples": [
"CAT_7_flex"
]
},
"name": {
"description": "Name of the cable type",
"type": "string",
"examples": [
"Cat.7 flex"
]
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
}
},
"createdAt": {
"description": "",
"type": "string",
"format": "date-time",
"examples": [
"2026-03-07T13:52:34.736Z"
]
},
"createdBy": {
"description": "",
"type": "string",
"examples": [
"4B7y4PX9aJ8O0c2WyKhVmBqMqFRG9iay"
]
},
"createdByName": {
"description": "",
"type": "string",
"examples": [
"John Doe"
]
},
"updatedAt": {
"description": "",
"type": "string",
"format": "date-time",
"examples": [
"2026-03-07T13:52:34.736Z"
]
},
"updatedBy": {
"description": "",
"type": "string",
"examples": [
"4B7y4PX9aJ8O0c2WyKhVmBqMqFRG9iay"
]
},
"updatedByName": {
"description": "",
"type": "string",
"examples": [
"John Doe"
]
},
"startPortId": {
"description": "Id of the port at the start side of the cable",
"type": "string",
"format": "uuid"
},
"startPortName": {
"description": "Name of the port at the start side of the cable",
"type": "string",
"examples": [
"WCLK OUT"
]
},
"startPortDirection": {
"description": "Direction of the port. See documentation for explainations of the possible values.",
"enum": [
"IN",
"OUT",
"INOUT",
"BIDI",
"UP",
"DOWN",
"FRONT",
"BACK"
],
"type": "string",
"examples": [
"OUT"
]
},
"startConnectorId": {
"description": "Id of the connector attached to the start side of the cable",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_m"
]
},
"startConnectorColor": {
"description": "Name of the connector, e.g. housing or sleeve, attached to the start side of the cable",
"enum": [
"red",
"blue",
"orange",
"yellow",
"green",
"beige",
"brown",
"lightgray",
"mediumgray",
"black",
"purple",
"cyan",
"white",
"pink"
],
"type": [
"string",
"null"
],
"examples": [
"red"
]
},
"startConnectorName": {
"description": "Name of the connector attached to the start side of the cable",
"type": "string",
"examples": [
"BNC 75 Ohm male"
]
},
"startConnectorGender": {
"description": "Gender of the connector attached to the start side of the cable",
"enum": [
"MALE",
"FEMALE",
"HERMA"
],
"examples": [
"MALE"
]
},
"startConnectorIcon": {
"description": "Icon for use with this connector. These can be fetched as SVG icons from /icons/{id}.svg",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_m"
]
},
"compatibleStartConnectors": {
"type": "array",
"items": {
"description": "List of alternative connectors that would be valid",
"type": "object",
"properties": {
"id": {
"description": "Id of the connector",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_m"
]
},
"name": {
"description": "Name of the connector",
"type": "string",
"examples": [
"BNC 75 Ohm male"
]
},
"icon": {
"description": "Icon for use with this connector. These can be fetched as SVG icons from /icons/{id}.svg",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_m"
]
},
"gender": {
"description": "Gender of the connector",
"enum": [
"MALE",
"FEMALE",
"HERMA"
],
"examples": [
"MALE"
]
}
},
"required": [
"id",
"name",
"icon",
"gender"
],
"additionalProperties": false
}
},
"startDeviceId": {
"description": "Id of the device at the start side of the cable",
"type": "string",
"format": "uuid"
},
"startDeviceName": {
"description": "Name of the device at the start side of the cable",
"type": "string",
"examples": [
"CLK-GEN1"
]
},
"startRackId": {
"description": "Id of the rack at the start side of the cable",
"type": "string",
"format": "uuid"
},
"startRackName": {
"description": "Name of the rack at the start side of the cable",
"type": "string",
"examples": [
"Rack 14"
]
},
"startRoomId": {
"description": "Id of the room at the start side of the cable",
"type": "string",
"format": "uuid"
},
"startRoomName": {
"description": "Name of the room at the start side of the cable",
"type": "string",
"examples": [
"MCR-CAR"
]
},
"startRoomNumber": {
"description": "Number of the room",
"type": [
"string",
"null"
],
"maxLength": 16,
"examples": [
"01-025"
]
},
"startBuildingId": {
"description": "Id of the building at the start side of the cable",
"type": "string",
"format": "uuid"
},
"startBuildingName": {
"description": "Name of the building at the start side of the cable",
"type": "string",
"examples": [
"Production Center"
]
},
"startSiteId": {
"description": "Id of the site at the start side of the cable",
"type": "string",
"format": "uuid"
},
"startSiteName": {
"description": "Name of the site at the start side of the cable",
"type": "string",
"examples": [
"Frankfurt"
]
},
"endPortId": {
"description": "Id of the port at the end side of the cable",
"type": "string",
"format": "uuid"
},
"endPortName": {
"description": "Name of the port at the end side of the cable",
"type": "string",
"examples": [
"WCLK IN"
]
},
"endPortDirection": {
"description": "Direction of the port. See documentation for explainations of the possible values.",
"enum": [
"IN",
"OUT",
"INOUT",
"BIDI",
"UP",
"DOWN",
"FRONT",
"BACK"
],
"type": "string",
"examples": [
"IN"
]
},
"endConnectorId": {
"description": "Id of the connector attached to the end side of the cable",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_m"
]
},
"endConnectorColor": {
"description": "Name of the connector, e.g. housing or sleeve, attached to the end side of the cable",
"enum": [
"red",
"blue",
"orange",
"yellow",
"green",
"beige",
"brown",
"lightgray",
"mediumgray",
"black",
"purple",
"cyan",
"white",
"pink"
],
"type": [
"string",
"null"
],
"examples": [
"red"
]
},
"endConnectorName": {
"description": "Name of the connector attached to the end side of the cable",
"type": "string",
"examples": [
"WCLK IN"
]
},
"endConnectorGender": {
"description": "Gender of the connector attached to the end side of the cable",
"enum": [
"MALE",
"FEMALE",
"HERMA"
],
"examples": [
"MALE"
]
},
"endConnectorIcon": {
"description": "Icon for use with this connector. These can be fetched as SVG icons from /icons/{id}.svg",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_m"
]
},
"compatibleEndConnectors": {
"description": "List of alternative connectors that would be valid",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Id of the connector",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_m"
]
},
"name": {
"description": "Name of the connector",
"type": "string",
"examples": [
"BNC 75 Ohm male"
]
},
"icon": {
"description": "Icon for use with this connector. These can be fetched as SVG icons from /icons/{id}.svg",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_m"
]
},
"gender": {
"description": "Gender of the connector",
"enum": [
"MALE",
"FEMALE",
"HERMA"
],
"examples": [
"MALE"
]
}
},
"required": [
"id",
"name",
"icon",
"gender"
],
"additionalProperties": false
}
},
"endDeviceId": {
"description": "Id of the device at the end side of the cable",
"type": "string",
"format": "uuid"
},
"endDeviceName": {
"description": "Name of the device at the end side of the cable",
"type": "string",
"examples": [
"A-DSP"
]
},
"endRackId": {
"description": "Id of the rack at the end side of the cable",
"type": "string",
"format": "uuid"
},
"endRackName": {
"description": "Name of the rack at the end side of the cable",
"type": "string",
"examples": [
"Rack 15"
]
},
"endRoomId": {
"description": "Id of the room at the end side of the cable",
"type": "string",
"format": "uuid"
},
"endRoomName": {
"description": "Name of the room at the end side of the cable",
"type": "string",
"examples": [
"MCR-CAR"
]
},
"endRoomNumber": {
"description": "Number of the room",
"type": [
"string",
"null"
],
"maxLength": 16,
"examples": [
"01-025"
]
},
"endBuildingId": {
"description": "Id of the building at the end side of the cable",
"type": "string",
"format": "uuid"
},
"endBuildingName": {
"description": "Name of the building at the end side of the cable",
"type": "string",
"examples": [
"Production Center"
]
},
"endSiteId": {
"description": "Id of the site at the end side of the cable",
"type": "string",
"format": "uuid"
},
"endSiteName": {
"description": "Name of the site at the end side of the cable",
"type": "string",
"examples": [
"Frankfurt"
]
}
},
"required": [
"id",
"number",
"length",
"notes",
"status",
"cableTypeId",
"cableTypeName",
"compatibleCableTypes",
"createdAt",
"createdBy",
"createdByName",
"updatedAt",
"updatedBy",
"updatedByName",
"startPortId",
"startPortName",
"startPortDirection",
"startConnectorId",
"startConnectorColor",
"startConnectorName",
"startConnectorGender",
"startConnectorIcon",
"compatibleStartConnectors",
"startDeviceId",
"startDeviceName",
"startRackId",
"startRackName",
"startRoomId",
"startRoomName",
"startRoomNumber",
"startBuildingId",
"startBuildingName",
"startSiteId",
"startSiteName",
"endPortId",
"endPortName",
"endPortDirection",
"endConnectorId",
"endConnectorColor",
"endConnectorName",
"endConnectorGender",
"endConnectorIcon",
"compatibleEndConnectors",
"endDeviceId",
"endDeviceName",
"endRackId",
"endRackName",
"endRoomId",
"endRoomName",
"endRoomNumber",
"endBuildingId",
"endBuildingName",
"endSiteId",
"endSiteName"
],
"additionalProperties": false
}
Refer to the common response description: 400.
Refer to the common response description: 401.
Refer to the common response description: 404.
Refer to the common response description: 500.
PATCH /cables/{cableId}
Update a cable
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cableId |
path | string | No |
Request body
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
{
"number": "x21045",
"length": 5,
"cableTypeId": "CAT_6_flex",
"startConnectorId": "BNC_m",
"startConnectorColor": "red",
"endConnectorId": "BNC_m",
"endConnectorColor": "red"
}
Schema of the request body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "CableUpdate model",
"description": "JSON document describing updates to a cable",
"type": "object",
"properties": {
"number": {
"description": "Number of the cable",
"type": [
"string",
"null"
],
"examples": [
"x21045"
]
},
"length": {
"description": "length of the cable in meters",
"type": [
"number",
"null"
],
"minimum": 0,
"examples": [
5
]
},
"cableTypeId": {
"description": "Id of the cable type",
"type": [
"string",
"null"
],
"examples": [
"CAT_6_flex"
]
},
"startConnectorId": {
"description": "Id of the connector attached to the start side of the cable",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_m"
]
},
"startConnectorColor": {
"description": "Name of the connector, e.g. housing or sleeve, attached to the start side of the cable",
"enum": [
"red",
"blue",
"orange",
"yellow",
"green",
"beige",
"brown",
"lightgray",
"mediumgray",
"black",
"purple",
"cyan",
"white",
"pink"
],
"type": [
"string",
"null"
],
"examples": [
"red"
]
},
"endConnectorId": {
"description": "Id of the connector attached to the end side of the cable",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_m"
]
},
"endConnectorColor": {
"description": "Name of the connector, e.g. housing or sleeve, attached to the end side of the cable",
"enum": [
"red",
"blue",
"orange",
"yellow",
"green",
"beige",
"brown",
"lightgray",
"mediumgray",
"black",
"purple",
"cyan",
"white",
"pink"
],
"type": [
"string",
"null"
],
"examples": [
"red"
]
}
},
"required": [],
"additionalProperties": false
}
Responses
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
{
"id": "5b409cde-4af4-4a4f-b04d-b734e653d552",
"number": "x21045",
"length": 5,
"notes": "This is scheduled for replacement in Q2",
"status": "INSTALLED",
"cableTypeId": "CAT_6_flex",
"cableTypeName": "Cat.6 flex",
"compatibleCableTypes": [
{
"id": "CAT_7_flex",
"name": "Cat.7 flex"
}
],
"createdAt": "2026-03-07T13:52:34.736Z",
"createdBy": "4B7y4PX9aJ8O0c2WyKhVmBqMqFRG9iay",
"createdByName": "John Doe",
"updatedAt": "2026-03-07T13:52:34.736Z",
"updatedBy": "4B7y4PX9aJ8O0c2WyKhVmBqMqFRG9iay",
"updatedByName": "John Doe",
"startPortId": "4daee557-fd17-4932-83be-a4c2ca1756c0",
"startPortName": "WCLK OUT",
"startPortDirection": "OUT",
"startConnectorId": "BNC_m",
"startConnectorColor": "red",
"startConnectorName": "BNC 75 Ohm male",
"startConnectorGender": "MALE",
"startConnectorIcon": "BNC_m",
"compatibleStartConnectors": [
{
"id": "BNC_m",
"name": "BNC 75 Ohm male",
"icon": "BNC_m",
"gender": "MALE"
}
],
"startDeviceId": "89505ca2-69b8-4024-8454-d0fdf561fa7f",
"startDeviceName": "CLK-GEN1",
"startRackId": "67adbc53-2a97-4dd5-8d1b-051fd2ccc433",
"startRackName": "Rack 14",
"startRoomId": "56f5f073-203a-4c11-a623-1c8bb51ba83c",
"startRoomName": "MCR-CAR",
"startRoomNumber": "01-025",
"startBuildingId": "46e6c6e1-b8bd-4b31-82de-6e2677fa2922",
"startBuildingName": "Production Center",
"startSiteId": "05e24c4c-4f98-4249-9a45-b93518d3df93",
"startSiteName": "Frankfurt",
"endPortId": "cf9d22d6-2848-40a5-9bb0-fc9259c2bbec",
"endPortName": "WCLK IN",
"endPortDirection": "IN",
"endConnectorId": "BNC_m",
"endConnectorColor": "red",
"endConnectorName": "WCLK IN",
"endConnectorGender": "MALE",
"endConnectorIcon": "BNC_m",
"compatibleEndConnectors": [
{
"id": "BNC_m",
"name": "BNC 75 Ohm male",
"icon": "BNC_m",
"gender": "MALE"
}
],
"endDeviceId": "b728c45d-ffd1-494d-9af0-20203128012f",
"endDeviceName": "A-DSP",
"endRackId": "1af6ce31-ea81-4296-9801-49ed93b36475",
"endRackName": "Rack 15",
"endRoomId": "5baa3c4b-e7bf-4cc0-8f58-cfc7471a0946",
"endRoomName": "MCR-CAR",
"endRoomNumber": "01-025",
"endBuildingId": "349b6940-575e-40e0-926e-8ce32b00d56e",
"endBuildingName": "Production Center",
"endSiteId": "67e9a90e-d688-413a-a98f-7dc716ab6348",
"endSiteName": "Frankfurt"
}
Schema of the response body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Cable model",
"description": "JSON document describing a cable",
"type": "object",
"properties": {
"id": {
"description": "Id of the cable",
"type": "string",
"format": "uuid"
},
"number": {
"description": "Number of the cable",
"type": [
"string",
"null"
],
"examples": [
"x21045"
]
},
"length": {
"description": "length of the cable in meters",
"type": [
"number",
"null"
],
"minimum": 0,
"examples": [
5
]
},
"notes": {
"description": "",
"type": [
"string",
"null"
],
"examples": [
"This is scheduled for replacement in Q2"
]
},
"status": {
"description": "",
"enum": [
"PLANNED",
"ORDERED",
"DELIVERED",
"INSTALLED",
"TESTED",
"IN_SERVICE",
"OUT_OF_SERVICE"
],
"type": [
"string",
"null"
],
"examples": [
"INSTALLED"
]
},
"cableTypeId": {
"description": "Id of the cable type",
"type": "string",
"examples": [
"CAT_6_flex"
]
},
"cableTypeName": {
"description": "Name of the cable type",
"type": "string",
"examples": [
"Cat.6 flex"
]
},
"compatibleCableTypes": {
"description": "List of alternative cable types that would be valid",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Id of the cable type",
"type": "string",
"examples": [
"CAT_7_flex"
]
},
"name": {
"description": "Name of the cable type",
"type": "string",
"examples": [
"Cat.7 flex"
]
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
}
},
"createdAt": {
"description": "",
"type": "string",
"format": "date-time",
"examples": [
"2026-03-07T13:52:34.736Z"
]
},
"createdBy": {
"description": "",
"type": "string",
"examples": [
"4B7y4PX9aJ8O0c2WyKhVmBqMqFRG9iay"
]
},
"createdByName": {
"description": "",
"type": "string",
"examples": [
"John Doe"
]
},
"updatedAt": {
"description": "",
"type": "string",
"format": "date-time",
"examples": [
"2026-03-07T13:52:34.736Z"
]
},
"updatedBy": {
"description": "",
"type": "string",
"examples": [
"4B7y4PX9aJ8O0c2WyKhVmBqMqFRG9iay"
]
},
"updatedByName": {
"description": "",
"type": "string",
"examples": [
"John Doe"
]
},
"startPortId": {
"description": "Id of the port at the start side of the cable",
"type": "string",
"format": "uuid"
},
"startPortName": {
"description": "Name of the port at the start side of the cable",
"type": "string",
"examples": [
"WCLK OUT"
]
},
"startPortDirection": {
"description": "Direction of the port. See documentation for explainations of the possible values.",
"enum": [
"IN",
"OUT",
"INOUT",
"BIDI",
"UP",
"DOWN",
"FRONT",
"BACK"
],
"type": "string",
"examples": [
"OUT"
]
},
"startConnectorId": {
"description": "Id of the connector attached to the start side of the cable",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_m"
]
},
"startConnectorColor": {
"description": "Name of the connector, e.g. housing or sleeve, attached to the start side of the cable",
"enum": [
"red",
"blue",
"orange",
"yellow",
"green",
"beige",
"brown",
"lightgray",
"mediumgray",
"black",
"purple",
"cyan",
"white",
"pink"
],
"type": [
"string",
"null"
],
"examples": [
"red"
]
},
"startConnectorName": {
"description": "Name of the connector attached to the start side of the cable",
"type": "string",
"examples": [
"BNC 75 Ohm male"
]
},
"startConnectorGender": {
"description": "Gender of the connector attached to the start side of the cable",
"enum": [
"MALE",
"FEMALE",
"HERMA"
],
"examples": [
"MALE"
]
},
"startConnectorIcon": {
"description": "Icon for use with this connector. These can be fetched as SVG icons from /icons/{id}.svg",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_m"
]
},
"compatibleStartConnectors": {
"type": "array",
"items": {
"description": "List of alternative connectors that would be valid",
"type": "object",
"properties": {
"id": {
"description": "Id of the connector",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_m"
]
},
"name": {
"description": "Name of the connector",
"type": "string",
"examples": [
"BNC 75 Ohm male"
]
},
"icon": {
"description": "Icon for use with this connector. These can be fetched as SVG icons from /icons/{id}.svg",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_m"
]
},
"gender": {
"description": "Gender of the connector",
"enum": [
"MALE",
"FEMALE",
"HERMA"
],
"examples": [
"MALE"
]
}
},
"required": [
"id",
"name",
"icon",
"gender"
],
"additionalProperties": false
}
},
"startDeviceId": {
"description": "Id of the device at the start side of the cable",
"type": "string",
"format": "uuid"
},
"startDeviceName": {
"description": "Name of the device at the start side of the cable",
"type": "string",
"examples": [
"CLK-GEN1"
]
},
"startRackId": {
"description": "Id of the rack at the start side of the cable",
"type": "string",
"format": "uuid"
},
"startRackName": {
"description": "Name of the rack at the start side of the cable",
"type": "string",
"examples": [
"Rack 14"
]
},
"startRoomId": {
"description": "Id of the room at the start side of the cable",
"type": "string",
"format": "uuid"
},
"startRoomName": {
"description": "Name of the room at the start side of the cable",
"type": "string",
"examples": [
"MCR-CAR"
]
},
"startRoomNumber": {
"description": "Number of the room",
"type": [
"string",
"null"
],
"maxLength": 16,
"examples": [
"01-025"
]
},
"startBuildingId": {
"description": "Id of the building at the start side of the cable",
"type": "string",
"format": "uuid"
},
"startBuildingName": {
"description": "Name of the building at the start side of the cable",
"type": "string",
"examples": [
"Production Center"
]
},
"startSiteId": {
"description": "Id of the site at the start side of the cable",
"type": "string",
"format": "uuid"
},
"startSiteName": {
"description": "Name of the site at the start side of the cable",
"type": "string",
"examples": [
"Frankfurt"
]
},
"endPortId": {
"description": "Id of the port at the end side of the cable",
"type": "string",
"format": "uuid"
},
"endPortName": {
"description": "Name of the port at the end side of the cable",
"type": "string",
"examples": [
"WCLK IN"
]
},
"endPortDirection": {
"description": "Direction of the port. See documentation for explainations of the possible values.",
"enum": [
"IN",
"OUT",
"INOUT",
"BIDI",
"UP",
"DOWN",
"FRONT",
"BACK"
],
"type": "string",
"examples": [
"IN"
]
},
"endConnectorId": {
"description": "Id of the connector attached to the end side of the cable",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_m"
]
},
"endConnectorColor": {
"description": "Name of the connector, e.g. housing or sleeve, attached to the end side of the cable",
"enum": [
"red",
"blue",
"orange",
"yellow",
"green",
"beige",
"brown",
"lightgray",
"mediumgray",
"black",
"purple",
"cyan",
"white",
"pink"
],
"type": [
"string",
"null"
],
"examples": [
"red"
]
},
"endConnectorName": {
"description": "Name of the connector attached to the end side of the cable",
"type": "string",
"examples": [
"WCLK IN"
]
},
"endConnectorGender": {
"description": "Gender of the connector attached to the end side of the cable",
"enum": [
"MALE",
"FEMALE",
"HERMA"
],
"examples": [
"MALE"
]
},
"endConnectorIcon": {
"description": "Icon for use with this connector. These can be fetched as SVG icons from /icons/{id}.svg",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_m"
]
},
"compatibleEndConnectors": {
"description": "List of alternative connectors that would be valid",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Id of the connector",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_m"
]
},
"name": {
"description": "Name of the connector",
"type": "string",
"examples": [
"BNC 75 Ohm male"
]
},
"icon": {
"description": "Icon for use with this connector. These can be fetched as SVG icons from /icons/{id}.svg",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_m"
]
},
"gender": {
"description": "Gender of the connector",
"enum": [
"MALE",
"FEMALE",
"HERMA"
],
"examples": [
"MALE"
]
}
},
"required": [
"id",
"name",
"icon",
"gender"
],
"additionalProperties": false
}
},
"endDeviceId": {
"description": "Id of the device at the end side of the cable",
"type": "string",
"format": "uuid"
},
"endDeviceName": {
"description": "Name of the device at the end side of the cable",
"type": "string",
"examples": [
"A-DSP"
]
},
"endRackId": {
"description": "Id of the rack at the end side of the cable",
"type": "string",
"format": "uuid"
},
"endRackName": {
"description": "Name of the rack at the end side of the cable",
"type": "string",
"examples": [
"Rack 15"
]
},
"endRoomId": {
"description": "Id of the room at the end side of the cable",
"type": "string",
"format": "uuid"
},
"endRoomName": {
"description": "Name of the room at the end side of the cable",
"type": "string",
"examples": [
"MCR-CAR"
]
},
"endRoomNumber": {
"description": "Number of the room",
"type": [
"string",
"null"
],
"maxLength": 16,
"examples": [
"01-025"
]
},
"endBuildingId": {
"description": "Id of the building at the end side of the cable",
"type": "string",
"format": "uuid"
},
"endBuildingName": {
"description": "Name of the building at the end side of the cable",
"type": "string",
"examples": [
"Production Center"
]
},
"endSiteId": {
"description": "Id of the site at the end side of the cable",
"type": "string",
"format": "uuid"
},
"endSiteName": {
"description": "Name of the site at the end side of the cable",
"type": "string",
"examples": [
"Frankfurt"
]
}
},
"required": [
"id",
"number",
"length",
"notes",
"status",
"cableTypeId",
"cableTypeName",
"compatibleCableTypes",
"createdAt",
"createdBy",
"createdByName",
"updatedAt",
"updatedBy",
"updatedByName",
"startPortId",
"startPortName",
"startPortDirection",
"startConnectorId",
"startConnectorColor",
"startConnectorName",
"startConnectorGender",
"startConnectorIcon",
"compatibleStartConnectors",
"startDeviceId",
"startDeviceName",
"startRackId",
"startRackName",
"startRoomId",
"startRoomName",
"startRoomNumber",
"startBuildingId",
"startBuildingName",
"startSiteId",
"startSiteName",
"endPortId",
"endPortName",
"endPortDirection",
"endConnectorId",
"endConnectorColor",
"endConnectorName",
"endConnectorGender",
"endConnectorIcon",
"compatibleEndConnectors",
"endDeviceId",
"endDeviceName",
"endRackId",
"endRackName",
"endRoomId",
"endRoomName",
"endRoomNumber",
"endBuildingId",
"endBuildingName",
"endSiteId",
"endSiteName"
],
"additionalProperties": false
}
Refer to the common response description: 400.
Refer to the common response description: 401.
Refer to the common response description: 404.
Refer to the common response description: 422.
Refer to the common response description: 500.
DELETE /cables/{cableId}
Delete a cable
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cableId |
path | string | No |
Responses
GET /sites
Get a list of sites
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON
{
"type": "array",
"items": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Site model",
"description": "JSON document describing a site",
"type": "object",
"properties": {
"id": {
"description": "Id of the site",
"type": "string",
"format": "uuid"
},
"name": {
"description": "Name of the site",
"type": "string",
"examples": [
"Frankfurt"
]
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
}
}
Refer to the common response description: 401.
Refer to the common response description: 500.
POST /sites
Add a site
Request body
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "SiteCreate model",
"description": "JSON document describing a new site",
"type": "object",
"properties": {
"name": {
"description": "Name of the site",
"type": "string",
"examples": [
"Frankfurt"
]
}
},
"required": [
"name"
],
"additionalProperties": false
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Site model",
"description": "JSON document describing a site",
"type": "object",
"properties": {
"id": {
"description": "Id of the site",
"type": "string",
"format": "uuid"
},
"name": {
"description": "Name of the site",
"type": "string",
"examples": [
"Frankfurt"
]
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
}
Refer to the common response description: 400.
Refer to the common response description: 401.
Refer to the common response description: 500.
GET /site/{siteId}
Get information of a single site
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
siteId |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Site model",
"description": "JSON document describing a site",
"type": "object",
"properties": {
"id": {
"description": "Id of the site",
"type": "string",
"format": "uuid"
},
"name": {
"description": "Name of the site",
"type": "string",
"examples": [
"Frankfurt"
]
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
}
Refer to the common response description: 400.
Refer to the common response description: 401.
Refer to the common response description: 404.
Refer to the common response description: 500.
DELETE /site/{siteId}
Delete a site
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
siteId |
path | string | No |
Responses
GET /buildings
Get a list of buildings
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
siteId |
query | string | No |
Responses
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
[
{
"id": "3de91d6c-f7cb-41bf-8310-1cd440103dcc",
"name": "Production Center",
"nameShort": "PC",
"siteId": "0a7c9b71-03f7-459d-9822-c35113e5ed45"
}
]
Schema of the response body
JSON
{
"type": "array",
"items": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Building model",
"description": "JSON document describing the building",
"type": "object",
"properties": {
"id": {
"description": "Id of the building",
"type": "string",
"format": "uuid"
},
"name": {
"description": "Name of the building",
"type": "string",
"examples": [
"Production Center"
]
},
"nameShort": {
"description": "Short name of the building",
"type": [
"string",
"null"
],
"maxLength": 16,
"examples": [
"PC"
]
},
"siteId": {
"description": "Id of the site at which the building is located",
"type": "string",
"format": "uuid"
}
},
"required": [
"id",
"name",
"nameShort",
"siteId"
],
"additionalProperties": false
}
}
Refer to the common response description: 400.
Refer to the common response description: 401.
Refer to the common response description: 500.
POST /buildings
Add a building
Request body
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
{
"name": "Production Center",
"nameShort": "PC",
"siteId": "e0190184-113f-4582-b769-9d600384af60"
}
Schema of the request body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "BuildingCreate model",
"description": "JSON document describing a new building",
"type": "object",
"properties": {
"name": {
"description": "Name of the building",
"type": "string",
"examples": [
"Production Center"
]
},
"nameShort": {
"description": "Short name of the building",
"type": [
"string",
"null"
],
"maxLength": 16,
"examples": [
"PC"
]
},
"siteId": {
"description": "Id of the site at which the building is located",
"type": "string",
"format": "uuid"
}
},
"required": [
"name",
"siteId"
],
"additionalProperties": false
}
Responses
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
{
"id": "58bc0a0b-f81f-4205-8207-bb958ebbde44",
"name": "Production Center",
"nameShort": "PC",
"siteId": "f1d3beff-afcc-43d8-b7af-6527a6730726"
}
Schema of the response body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Building model",
"description": "JSON document describing the building",
"type": "object",
"properties": {
"id": {
"description": "Id of the building",
"type": "string",
"format": "uuid"
},
"name": {
"description": "Name of the building",
"type": "string",
"examples": [
"Production Center"
]
},
"nameShort": {
"description": "Short name of the building",
"type": [
"string",
"null"
],
"maxLength": 16,
"examples": [
"PC"
]
},
"siteId": {
"description": "Id of the site at which the building is located",
"type": "string",
"format": "uuid"
}
},
"required": [
"id",
"name",
"nameShort",
"siteId"
],
"additionalProperties": false
}
Refer to the common response description: 400.
Refer to the common response description: 401.
Refer to the common response description: 422.
Refer to the common response description: 500.
GET /buildings/{buildingId}
Get information of a single building
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
buildingId |
path | string | No |
Responses
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
{
"id": "cd10faf6-6e00-4a93-bef2-10c7dfeca2a6",
"name": "Production Center",
"nameShort": "PC",
"siteId": "ac6b11a2-de04-4b86-959e-95279e2014a2"
}
Schema of the response body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Building model",
"description": "JSON document describing the building",
"type": "object",
"properties": {
"id": {
"description": "Id of the building",
"type": "string",
"format": "uuid"
},
"name": {
"description": "Name of the building",
"type": "string",
"examples": [
"Production Center"
]
},
"nameShort": {
"description": "Short name of the building",
"type": [
"string",
"null"
],
"maxLength": 16,
"examples": [
"PC"
]
},
"siteId": {
"description": "Id of the site at which the building is located",
"type": "string",
"format": "uuid"
}
},
"required": [
"id",
"name",
"nameShort",
"siteId"
],
"additionalProperties": false
}
Refer to the common response description: 400.
Refer to the common response description: 401.
Refer to the common response description: 404.
Refer to the common response description: 500.
DELETE /buildings/{buildingId}
Delete a building
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
buildingId |
path | string | No |
Responses
GET /rooms
Get a list of Rooms
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
buildingId |
query | string | No |
Responses
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
[
{
"id": "e37ac2ba-db31-4747-a9f9-7154cc1b1891",
"name": "MCR-CAR",
"number": "01-025",
"buildingId": "24aace11-9b1a-44be-82e8-7a2e72a711ad"
}
]
Schema of the response body
JSON
{
"type": "array",
"items": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Room model",
"description": "JSON document describing a room",
"type": "object",
"properties": {
"id": {
"description": "Id of the room",
"type": "string",
"format": "uuid"
},
"name": {
"description": "Name of the room",
"type": "string",
"examples": [
"MCR-CAR"
]
},
"number": {
"description": "Number of the room",
"type": [
"string",
"null"
],
"maxLength": 16,
"examples": [
"01-025"
]
},
"buildingId": {
"description": "Id of the building in which the room is located",
"type": "string",
"format": "uuid"
}
},
"required": [
"id",
"name",
"number",
"buildingId"
],
"additionalProperties": false
}
}
Refer to the common response description: 400.
Refer to the common response description: 401.
Refer to the common response description: 500.
POST /rooms
Add a room
Request body
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "RoomCreate model",
"description": "JSON document describing a new room",
"type": "object",
"properties": {
"name": {
"description": "Name of the room",
"type": "string",
"examples": [
"MCR-CAR"
]
},
"number": {
"description": "Number of the room",
"type": [
"string",
"null"
],
"maxLength": 16,
"examples": [
"01-025"
]
},
"buildingId": {
"description": "Id of the building in which the room is located",
"type": "string",
"format": "uuid"
}
},
"required": [
"name",
"buildingId"
],
"additionalProperties": false
}
Responses
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
{
"id": "9286a085-303c-4dbd-9610-d83351687bb8",
"name": "MCR-CAR",
"number": "01-025",
"buildingId": "b11b39eb-a2b4-44e2-b1dd-186d199829e0"
}
Schema of the response body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Room model",
"description": "JSON document describing a room",
"type": "object",
"properties": {
"id": {
"description": "Id of the room",
"type": "string",
"format": "uuid"
},
"name": {
"description": "Name of the room",
"type": "string",
"examples": [
"MCR-CAR"
]
},
"number": {
"description": "Number of the room",
"type": [
"string",
"null"
],
"maxLength": 16,
"examples": [
"01-025"
]
},
"buildingId": {
"description": "Id of the building in which the room is located",
"type": "string",
"format": "uuid"
}
},
"required": [
"id",
"name",
"number",
"buildingId"
],
"additionalProperties": false
}
Refer to the common response description: 400.
Refer to the common response description: 401.
Refer to the common response description: 422.
Refer to the common response description: 500.
GET /rooms/{roomId}
Get information of a single room
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
roomId |
path | string | No |
Responses
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
{
"id": "26a6ba3c-7a0f-434f-8034-1b7ac6db301a",
"name": "MCR-CAR",
"number": "01-025",
"buildingId": "441c795a-e47b-436a-816d-514f62cf3594"
}
Schema of the response body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Room model",
"description": "JSON document describing a room",
"type": "object",
"properties": {
"id": {
"description": "Id of the room",
"type": "string",
"format": "uuid"
},
"name": {
"description": "Name of the room",
"type": "string",
"examples": [
"MCR-CAR"
]
},
"number": {
"description": "Number of the room",
"type": [
"string",
"null"
],
"maxLength": 16,
"examples": [
"01-025"
]
},
"buildingId": {
"description": "Id of the building in which the room is located",
"type": "string",
"format": "uuid"
}
},
"required": [
"id",
"name",
"number",
"buildingId"
],
"additionalProperties": false
}
Refer to the common response description: 400.
Refer to the common response description: 401.
Refer to the common response description: 404.
Refer to the common response description: 500.
DELETE /rooms/{roomId}
Delete a room
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
roomId |
path | string | No |
Responses
GET /racks
Get a list of racks
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
roomId |
query | string | No |
Responses
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
[
{
"id": "d924646a-64a6-48e8-a990-3504c3114a33",
"name": "Rack 12",
"roomId": "d8ab8430-6736-496f-9d67-6baebdc1fbd6",
"type": "19INCH",
"totalRU": 42,
"depth": 800
}
]
Schema of the response body
JSON
{
"type": "array",
"items": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Rack model",
"description": "JSON document describing a rack",
"type": "object",
"properties": {
"id": {
"description": "Id of the rack",
"type": "string",
"format": "uuid"
},
"name": {
"description": "Name of the rack",
"type": "string",
"examples": [
"Rack 12"
]
},
"roomId": {
"description": "Id of the room in which the rack is located",
"type": "string",
"format": "uuid"
},
"type": {
"description": "Type of the rack",
"enum": [
"NONE",
"19INCH"
],
"type": "string",
"examples": [
"19INCH"
]
},
"totalRU": {
"description": "Height of the rack in units. 0 when not a rack",
"type": "number",
"minimum": 0,
"examples": [
42
]
},
"depth": {
"description": "Depth of the rack in mm",
"type": "number",
"minimum": 0,
"examples": [
800
]
}
},
"required": [
"id",
"name",
"roomId",
"type",
"totalRU",
"depth"
],
"additionalProperties": false
}
}
Refer to the common response description: 400.
Refer to the common response description: 401.
Refer to the common response description: 500.
POST /racks
Add a rack
Request body
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
{
"name": "Rack 12",
"roomId": "24a9e0c3-5978-472e-bdc4-f9b30d1a68da",
"type": "19INCH",
"totalRU": 42,
"depth": 800
}
Schema of the request body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "RackCreate model",
"description": "JSON document describing a new rack",
"type": "object",
"properties": {
"name": {
"description": "Name of the rack",
"type": "string",
"examples": [
"Rack 12"
]
},
"roomId": {
"description": "Id of the room in which the rack is located",
"type": "string",
"format": "uuid"
},
"type": {
"description": "Type of the rack",
"enum": [
"NONE",
"19INCH"
],
"type": "string",
"examples": [
"19INCH"
]
},
"totalRU": {
"description": "Height of the rack in units. 0 when not a rack",
"type": "number",
"minimum": 0,
"examples": [
42
]
},
"depth": {
"description": "Depth of the rack in mm",
"type": "number",
"minimum": 0,
"examples": [
800
]
}
},
"required": [
"name",
"roomId",
"type"
],
"additionalProperties": false
}
Responses
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
{
"id": "f649077e-8dbd-4684-920c-c84d1fcfaf0b",
"name": "Rack 12",
"roomId": "82ad353c-d340-42b7-928a-93ea78555a88",
"type": "19INCH",
"totalRU": 42,
"depth": 800
}
Schema of the response body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Rack model",
"description": "JSON document describing a rack",
"type": "object",
"properties": {
"id": {
"description": "Id of the rack",
"type": "string",
"format": "uuid"
},
"name": {
"description": "Name of the rack",
"type": "string",
"examples": [
"Rack 12"
]
},
"roomId": {
"description": "Id of the room in which the rack is located",
"type": "string",
"format": "uuid"
},
"type": {
"description": "Type of the rack",
"enum": [
"NONE",
"19INCH"
],
"type": "string",
"examples": [
"19INCH"
]
},
"totalRU": {
"description": "Height of the rack in units. 0 when not a rack",
"type": "number",
"minimum": 0,
"examples": [
42
]
},
"depth": {
"description": "Depth of the rack in mm",
"type": "number",
"minimum": 0,
"examples": [
800
]
}
},
"required": [
"id",
"name",
"roomId",
"type",
"totalRU",
"depth"
],
"additionalProperties": false
}
Refer to the common response description: 400.
Refer to the common response description: 401.
Refer to the common response description: 422.
Refer to the common response description: 500.
GET /racks/{rackId}
Get information of a single rack
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
rackId |
path | string | No |
Responses
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
{
"id": "118c172a-dd09-408e-bb16-52f581214d32",
"name": "Rack 12",
"roomId": "923e450b-65f7-44fa-bc2e-c36c8b59ada5",
"type": "19INCH",
"totalRU": 42,
"depth": 800
}
Schema of the response body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Rack model",
"description": "JSON document describing a rack",
"type": "object",
"properties": {
"id": {
"description": "Id of the rack",
"type": "string",
"format": "uuid"
},
"name": {
"description": "Name of the rack",
"type": "string",
"examples": [
"Rack 12"
]
},
"roomId": {
"description": "Id of the room in which the rack is located",
"type": "string",
"format": "uuid"
},
"type": {
"description": "Type of the rack",
"enum": [
"NONE",
"19INCH"
],
"type": "string",
"examples": [
"19INCH"
]
},
"totalRU": {
"description": "Height of the rack in units. 0 when not a rack",
"type": "number",
"minimum": 0,
"examples": [
42
]
},
"depth": {
"description": "Depth of the rack in mm",
"type": "number",
"minimum": 0,
"examples": [
800
]
}
},
"required": [
"id",
"name",
"roomId",
"type",
"totalRU",
"depth"
],
"additionalProperties": false
}
Refer to the common response description: 400.
Refer to the common response description: 401.
Refer to the common response description: 404.
Refer to the common response description: 500.
DELETE /racks/{rackId}
Delete a rack
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
rackId |
path | string | No |
Responses
GET /devicetypes
Get a list of device types
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
manufacturerId |
query | string | No |
Responses
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
[
{
"id": "lawo-auhd-core",
"version": "1.1",
"name": "A__UHD Core",
"manufacturerId": "lawo",
"manufacturerName": "Lawo AG",
"manufacturerNameShort": "lawo",
"orderCode": "UHD-CORE-R2",
"orderNumber": "710/20",
"climateLoad": "220",
"rackType": "19INCH",
"rackHeight": 1,
"rackDepth": 324,
"portTypes": [
{
"id": "e6f359ff-77b4-46c6-99dd-be55d909d193",
"name": "MGMT A",
"direction": "UP",
"connectorId": "RJ45_f",
"compatibleSignalTypes": [
"10BASE_T"
]
}
],
"moduleSlotTypes": [
{
"id": "838beb2f-b700-419a-8800-8ccad77845a7",
"name": "1"
}
]
}
]
Schema of the response body
JSON
{
"type": "array",
"items": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "DeviceType model",
"description": "JSON document describing the device type",
"type": "object",
"properties": {
"id": {
"description": "Id of the device type. Consists of id of manufacturer followed by id of device type. See documentation for rules.",
"type": "string",
"pattern": "^(?=.{1,48}$)(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])?-[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$",
"maxLength": 48,
"examples": [
"lawo-auhd-core"
]
},
"version": {
"description": "Version number of the template. Minor version must be increased with every change. Major version must only be changed when targeting a different API version.",
"type": "string",
"pattern": "^\\d{1,2}\\.\\d{1,2}$",
"examples": [
"1.1"
]
},
"name": {
"description": "Name of the device as given by manufacturer",
"type": "string",
"maxLength": 256,
"examples": [
"A__UHD Core"
]
},
"manufacturerId": {
"description": "Id of the manufacturer of the device type.",
"type": "string",
"patter": "^(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])$",
"maxLength": 16,
"examples": [
"lawo"
]
},
"manufacturerName": {
"description": "Name of the manufacturer",
"type": "string",
"examples": [
"Lawo AG"
]
},
"manufacturerNameShort": {
"description": "Abbreviated version of the name of the manufacturer",
"type": "string",
"maxLength": 16,
"examples": [
"lawo"
]
},
"orderCode": {
"description": "Order code for the device type as used by the manufacturer.",
"type": [
"string",
"null"
],
"examples": [
"UHD-CORE-R2"
]
},
"orderNumber": {
"description": "Order number for the device type as used by the manufacturer.",
"type": [
"string",
"null"
],
"examples": [
"710/20"
]
},
"climateLoad": {
"description": "The maximum heat dissipation of the device type.",
"type": "integer",
"minimum": 0,
"examples": [
"220"
]
},
"rackType": {
"description": "Type of rack the device can be mounted in.",
"enum": [
"NONE",
"19INCH"
],
"type": "string",
"examples": [
"19INCH"
]
},
"rackHeight": {
"description": "Height of the device in rack units. 0 if device is not rackmountable.",
"type": "number",
"minimum": 0,
"examples": [
1
]
},
"rackDepth": {
"description": "Depth of the device within the rack in mm. Measured from the plane of the rack to the furthest protrusion of the device.",
"type": "number",
"minimum": 0,
"examples": [
324
]
},
"portTypes": {
"description": "List of all types of ports on the device type.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Id of the port type",
"type": "string",
"format": "uuid"
},
"name": {
"description": "Name of the port, as printed on the device.",
"type": "string",
"examples": [
"MGMT A"
]
},
"direction": {
"description": "Direction of the port type. See documentation for explainations of the possible values.",
"enum": [
"IN",
"OUT",
"INOUT",
"BIDI",
"UP",
"DOWN",
"FRONT",
"BACK"
],
"type": "string",
"examples": [
"UP"
]
},
"connectorId": {
"description": "Id of the connector.",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"RJ45_f"
]
},
"compatibleSignalTypes": {
"description": "List of signal types that are compatible with this port.",
"type": "array",
"items": {
"type": "string",
"pattern": "^(?!.*--)(?:[a-z](?:[a-z-]{0,14}[a-z])?_)?[A-Z0-9]+(?:_[A-Z0-9]+)*$",
"examples": [
"10BASE_T",
"100BASE_TX",
"1000BASE_T"
]
},
"uniqueItems": true
}
},
"required": [
"id",
"name",
"direction",
"connectorId",
"compatibleSignalTypes"
],
"additionalProperties": false
}
},
"moduleSlotTypes": {
"description": "List of all types of module slots on the device type.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Id of the module slot type",
"type": "string",
"format": "uuid"
},
"name": {
"description": "Name of the module slot, as labeled on the device.",
"type": "string",
"examples": [
"1"
]
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"version",
"name",
"manufacturerId",
"manufacturerName",
"manufacturerNameShort",
"orderCode",
"orderNumber",
"climateLoad",
"rackType",
"rackHeight",
"rackDepth",
"portTypes",
"moduleSlotTypes"
],
"additionalProperties": false
}
}
Refer to the common response description: 400.
Refer to the common response description: 401.
Refer to the common response description: 500.
POST /devicetypes
Add a device type
Request body
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
{
"id": "lawo-auhd-core",
"version": "1.1",
"name": "A__UHD Core",
"manufacturerId": "lawo",
"orderCode": "UHD-CORE-R2",
"orderNumber": "710/20",
"climateLoad": "220",
"rackType": "19INCH",
"rackHeight": 1,
"rackDepth": 324,
"portTypes": [
{
"name": "MGMT A",
"direction": "UP",
"connectorId": "RJ45_f",
"compatibleSignalTypes": [
"10BASE_T"
]
}
],
"moduleSlotTypes": [
{
"name": "1",
"compatibleModuleSlotFormFactors": [
"sfp"
],
"compatibleModuleTypes": [
"lawo-98160-10"
],
"incompatibleModuleTypes": [
"directout-sfp-madi-bnc"
]
}
]
}
Schema of the request body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "DeviceTypeCreate model",
"description": "JSON document describing the device type",
"type": "object",
"properties": {
"id": {
"description": "Id of the device type. Consists of id of manufacturer followed by id of device type. See documentation for rules.",
"type": "string",
"pattern": "^(?=.{1,48}$)(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])?-[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$",
"maxLength": 48,
"examples": [
"lawo-auhd-core"
]
},
"version": {
"description": "Version number of the template. Minor version must be increased with every change. Major version must only be changed when targeting a different API version.",
"type": "string",
"pattern": "^\\d{1,2}\\.\\d{1,2}$",
"examples": [
"1.1"
]
},
"name": {
"description": "Name of the device as given by manufacturer",
"type": "string",
"maxLength": 256,
"examples": [
"A__UHD Core"
]
},
"manufacturerId": {
"description": "Id of the manufacturer of the device type.",
"type": "string",
"patter": "^(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])$",
"maxLength": 16,
"examples": [
"lawo"
]
},
"orderCode": {
"description": "Order code for the device type as used by the manufacturer.",
"type": [
"string",
"null"
],
"examples": [
"UHD-CORE-R2"
]
},
"orderNumber": {
"description": "Order number for the device type as used by the manufacturer.",
"type": [
"string",
"null"
],
"examples": [
"710/20"
]
},
"climateLoad": {
"description": "The maximum heat dissipation of the device type.",
"type": "integer",
"minimum": 0,
"examples": [
"220"
]
},
"rackType": {
"description": "Type of rack the device can be mounted in.",
"enum": [
"NONE",
"19INCH"
],
"type": "string",
"examples": [
"19INCH"
]
},
"rackHeight": {
"description": "Height of the device in rack units. 0 if device is not rackmountable.",
"type": "number",
"minimum": 0,
"examples": [
1
]
},
"rackDepth": {
"description": "Depth of the device within the rack in mm. Measured from the plane of the rack to the furthest protrusion of the device.",
"type": "number",
"minimum": 0,
"examples": [
324
]
},
"portTypes": {
"description": "List of all types of ports on the device type.",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "Name of the port, as printed on the device.",
"type": "string",
"examples": [
"MGMT A"
]
},
"direction": {
"description": "Direction of the port type. See documentation for explainations of the possible values.",
"enum": [
"IN",
"OUT",
"INOUT",
"BIDI",
"UP",
"DOWN",
"FRONT",
"BACK"
],
"type": "string",
"examples": [
"UP"
]
},
"connectorId": {
"description": "Id of the connector.",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"RJ45_f"
]
},
"compatibleSignalTypes": {
"description": "List of signal types that are compatible with this port.",
"type": "array",
"items": {
"type": "string",
"pattern": "^(?!.*--)(?:[a-z](?:[a-z-]{0,14}[a-z])?_)?[A-Z0-9]+(?:_[A-Z0-9]+)*$",
"examples": [
"10BASE_T",
"100BASE_TX",
"1000BASE_T"
]
},
"uniqueItems": true
}
},
"required": [
"name",
"direction",
"connectorId",
"compatibleSignalTypes"
],
"additionalProperties": false
}
},
"moduleSlotTypes": {
"description": "List of all types of module slots on the device type.",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "Name of the module slot, as labeled on the device.",
"type": "string",
"examples": [
"1"
]
},
"compatibleModuleSlotFormFactors": {
"description": "List of module slot factors that can physically fit into the slot.",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"examples": [
"sfp"
]
}
},
"compatibleModuleTypes": {
"description": "List of module types that are guranteed by the manufacturer to work in this slot.",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"pattern": "^(?=.{1,48}$)(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])?-[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$",
"examples": [
"lawo-98160-10"
]
}
},
"incompatibleModuleTypes": {
"description": "List of module types that are guranteed by the manufacturer not work in this module slot.",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"pattern": "^(?=.{1,48}$)(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])?-[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$",
"examples": [
"directout-sfp-madi-bnc"
]
}
}
},
"required": [
"name",
"compatibleModuleSlotFormFactors",
"compatibleModuleTypes",
"incompatibleModuleTypes"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"version",
"name",
"manufacturerId",
"orderCode",
"orderNumber",
"climateLoad",
"rackType",
"portTypes",
"moduleSlotTypes"
],
"dependentRequired": {
"rackType": [
"rackHeight",
"rackDepth"
]
},
"additionalProperties": false
}
Responses
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
{
"id": "lawo-auhd-core",
"version": "1.1",
"name": "A__UHD Core",
"manufacturerId": "lawo",
"manufacturerName": "Lawo AG",
"manufacturerNameShort": "lawo",
"orderCode": "UHD-CORE-R2",
"orderNumber": "710/20",
"climateLoad": "220",
"rackType": "19INCH",
"rackHeight": 1,
"rackDepth": 324,
"portTypes": [
{
"id": "55de6332-e6b3-4a5d-90ec-551c7eccb07b",
"name": "MGMT A",
"direction": "UP",
"connectorId": "RJ45_f",
"compatibleSignalTypes": [
"10BASE_T"
]
}
],
"moduleSlotTypes": [
{
"id": "2e60b46e-4420-48b6-a61d-206501759d08",
"name": "1"
}
]
}
Schema of the response body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "DeviceType model",
"description": "JSON document describing the device type",
"type": "object",
"properties": {
"id": {
"description": "Id of the device type. Consists of id of manufacturer followed by id of device type. See documentation for rules.",
"type": "string",
"pattern": "^(?=.{1,48}$)(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])?-[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$",
"maxLength": 48,
"examples": [
"lawo-auhd-core"
]
},
"version": {
"description": "Version number of the template. Minor version must be increased with every change. Major version must only be changed when targeting a different API version.",
"type": "string",
"pattern": "^\\d{1,2}\\.\\d{1,2}$",
"examples": [
"1.1"
]
},
"name": {
"description": "Name of the device as given by manufacturer",
"type": "string",
"maxLength": 256,
"examples": [
"A__UHD Core"
]
},
"manufacturerId": {
"description": "Id of the manufacturer of the device type.",
"type": "string",
"patter": "^(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])$",
"maxLength": 16,
"examples": [
"lawo"
]
},
"manufacturerName": {
"description": "Name of the manufacturer",
"type": "string",
"examples": [
"Lawo AG"
]
},
"manufacturerNameShort": {
"description": "Abbreviated version of the name of the manufacturer",
"type": "string",
"maxLength": 16,
"examples": [
"lawo"
]
},
"orderCode": {
"description": "Order code for the device type as used by the manufacturer.",
"type": [
"string",
"null"
],
"examples": [
"UHD-CORE-R2"
]
},
"orderNumber": {
"description": "Order number for the device type as used by the manufacturer.",
"type": [
"string",
"null"
],
"examples": [
"710/20"
]
},
"climateLoad": {
"description": "The maximum heat dissipation of the device type.",
"type": "integer",
"minimum": 0,
"examples": [
"220"
]
},
"rackType": {
"description": "Type of rack the device can be mounted in.",
"enum": [
"NONE",
"19INCH"
],
"type": "string",
"examples": [
"19INCH"
]
},
"rackHeight": {
"description": "Height of the device in rack units. 0 if device is not rackmountable.",
"type": "number",
"minimum": 0,
"examples": [
1
]
},
"rackDepth": {
"description": "Depth of the device within the rack in mm. Measured from the plane of the rack to the furthest protrusion of the device.",
"type": "number",
"minimum": 0,
"examples": [
324
]
},
"portTypes": {
"description": "List of all types of ports on the device type.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Id of the port type",
"type": "string",
"format": "uuid"
},
"name": {
"description": "Name of the port, as printed on the device.",
"type": "string",
"examples": [
"MGMT A"
]
},
"direction": {
"description": "Direction of the port type. See documentation for explainations of the possible values.",
"enum": [
"IN",
"OUT",
"INOUT",
"BIDI",
"UP",
"DOWN",
"FRONT",
"BACK"
],
"type": "string",
"examples": [
"UP"
]
},
"connectorId": {
"description": "Id of the connector.",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"RJ45_f"
]
},
"compatibleSignalTypes": {
"description": "List of signal types that are compatible with this port.",
"type": "array",
"items": {
"type": "string",
"pattern": "^(?!.*--)(?:[a-z](?:[a-z-]{0,14}[a-z])?_)?[A-Z0-9]+(?:_[A-Z0-9]+)*$",
"examples": [
"10BASE_T",
"100BASE_TX",
"1000BASE_T"
]
},
"uniqueItems": true
}
},
"required": [
"id",
"name",
"direction",
"connectorId",
"compatibleSignalTypes"
],
"additionalProperties": false
}
},
"moduleSlotTypes": {
"description": "List of all types of module slots on the device type.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Id of the module slot type",
"type": "string",
"format": "uuid"
},
"name": {
"description": "Name of the module slot, as labeled on the device.",
"type": "string",
"examples": [
"1"
]
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"version",
"name",
"manufacturerId",
"manufacturerName",
"manufacturerNameShort",
"orderCode",
"orderNumber",
"climateLoad",
"rackType",
"rackHeight",
"rackDepth",
"portTypes",
"moduleSlotTypes"
],
"additionalProperties": false
}
Refer to the common response description: 400.
Refer to the common response description: 401.
Refer to the common response description: 422.
Refer to the common response description: 500.
GET /devicetypes/{deviceTypeId}
Get information of a device type
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
deviceTypeId |
path | string | No |
Responses
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
{
"id": "lawo-auhd-core",
"version": "1.1",
"name": "A__UHD Core",
"manufacturerId": "lawo",
"manufacturerName": "Lawo AG",
"manufacturerNameShort": "lawo",
"orderCode": "UHD-CORE-R2",
"orderNumber": "710/20",
"climateLoad": "220",
"rackType": "19INCH",
"rackHeight": 1,
"rackDepth": 324,
"portTypes": [
{
"id": "ef423d2f-f208-4dc8-81b3-f1ff9f03e9f2",
"name": "MGMT A",
"direction": "UP",
"connectorId": "RJ45_f",
"compatibleSignalTypes": [
"10BASE_T"
]
}
],
"moduleSlotTypes": [
{
"id": "ba3b0f83-caeb-4e3c-8069-4c9e621c5064",
"name": "1"
}
]
}
Schema of the response body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "DeviceType model",
"description": "JSON document describing the device type",
"type": "object",
"properties": {
"id": {
"description": "Id of the device type. Consists of id of manufacturer followed by id of device type. See documentation for rules.",
"type": "string",
"pattern": "^(?=.{1,48}$)(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])?-[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$",
"maxLength": 48,
"examples": [
"lawo-auhd-core"
]
},
"version": {
"description": "Version number of the template. Minor version must be increased with every change. Major version must only be changed when targeting a different API version.",
"type": "string",
"pattern": "^\\d{1,2}\\.\\d{1,2}$",
"examples": [
"1.1"
]
},
"name": {
"description": "Name of the device as given by manufacturer",
"type": "string",
"maxLength": 256,
"examples": [
"A__UHD Core"
]
},
"manufacturerId": {
"description": "Id of the manufacturer of the device type.",
"type": "string",
"patter": "^(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])$",
"maxLength": 16,
"examples": [
"lawo"
]
},
"manufacturerName": {
"description": "Name of the manufacturer",
"type": "string",
"examples": [
"Lawo AG"
]
},
"manufacturerNameShort": {
"description": "Abbreviated version of the name of the manufacturer",
"type": "string",
"maxLength": 16,
"examples": [
"lawo"
]
},
"orderCode": {
"description": "Order code for the device type as used by the manufacturer.",
"type": [
"string",
"null"
],
"examples": [
"UHD-CORE-R2"
]
},
"orderNumber": {
"description": "Order number for the device type as used by the manufacturer.",
"type": [
"string",
"null"
],
"examples": [
"710/20"
]
},
"climateLoad": {
"description": "The maximum heat dissipation of the device type.",
"type": "integer",
"minimum": 0,
"examples": [
"220"
]
},
"rackType": {
"description": "Type of rack the device can be mounted in.",
"enum": [
"NONE",
"19INCH"
],
"type": "string",
"examples": [
"19INCH"
]
},
"rackHeight": {
"description": "Height of the device in rack units. 0 if device is not rackmountable.",
"type": "number",
"minimum": 0,
"examples": [
1
]
},
"rackDepth": {
"description": "Depth of the device within the rack in mm. Measured from the plane of the rack to the furthest protrusion of the device.",
"type": "number",
"minimum": 0,
"examples": [
324
]
},
"portTypes": {
"description": "List of all types of ports on the device type.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Id of the port type",
"type": "string",
"format": "uuid"
},
"name": {
"description": "Name of the port, as printed on the device.",
"type": "string",
"examples": [
"MGMT A"
]
},
"direction": {
"description": "Direction of the port type. See documentation for explainations of the possible values.",
"enum": [
"IN",
"OUT",
"INOUT",
"BIDI",
"UP",
"DOWN",
"FRONT",
"BACK"
],
"type": "string",
"examples": [
"UP"
]
},
"connectorId": {
"description": "Id of the connector.",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"RJ45_f"
]
},
"compatibleSignalTypes": {
"description": "List of signal types that are compatible with this port.",
"type": "array",
"items": {
"type": "string",
"pattern": "^(?!.*--)(?:[a-z](?:[a-z-]{0,14}[a-z])?_)?[A-Z0-9]+(?:_[A-Z0-9]+)*$",
"examples": [
"10BASE_T",
"100BASE_TX",
"1000BASE_T"
]
},
"uniqueItems": true
}
},
"required": [
"id",
"name",
"direction",
"connectorId",
"compatibleSignalTypes"
],
"additionalProperties": false
}
},
"moduleSlotTypes": {
"description": "List of all types of module slots on the device type.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Id of the module slot type",
"type": "string",
"format": "uuid"
},
"name": {
"description": "Name of the module slot, as labeled on the device.",
"type": "string",
"examples": [
"1"
]
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"version",
"name",
"manufacturerId",
"manufacturerName",
"manufacturerNameShort",
"orderCode",
"orderNumber",
"climateLoad",
"rackType",
"rackHeight",
"rackDepth",
"portTypes",
"moduleSlotTypes"
],
"additionalProperties": false
}
Refer to the common response description: 400.
Refer to the common response description: 401.
Refer to the common response description: 404.
Refer to the common response description: 500.
DELETE /devicetypes/{deviceTypeId}
Delete a device type
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
deviceTypeId |
path | string | No |
Responses
GET /moduleslottypes/{moduleSlotTypeId}/compatiblemoduletypes
Read information about the compatibility of module types for this module slot type
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
moduleSlotTypeId |
path | string | No |
Responses
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
{
"whitelist": [
{
"moduleTypeId": "directout-sfp-madi-bnc",
"moduleTypeName": "SFP MADI BNC",
"manufacturerId": "directout",
"manufacturerName": "DirectOut GmbH",
"manufacturerNameShort": "DirectOut"
}
],
"blacklist": [
{
"moduleTypeId": "dnetgear-agm734",
"moduleTypeName": "AGM734",
"manufacturerId": "netgear",
"manufacturerName": "NETGEAR Inc.",
"manufacturerNameShort": "NETGEAR"
}
],
"compatibleModuleTypes": [
{
"moduleTypeId": "lawo-98160-82",
"moduleTypeName": "981/60-82",
"manufacturerId": "lawo",
"manufacturerName": "Lawo AG",
"manufacturerNameShort": "Lawo"
}
]
}
Schema of the response body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "ModuleSlotTypeCompatible model",
"description": "JSON document describing the compatible and incompatible module types for a module slot type",
"type": "object",
"properties": {
"whitelist": {
"description": "List of module types that are guranteed by the manufacturer to work in this slot",
"type": "array",
"items": {
"type": "object",
"properties": {
"moduleTypeId": {
"description": "Id of the module type. Consists of id of manufacturer followed by id of module type. See documentation for rules.",
"type": "string",
"pattern": "^(?=.{1,48}$)(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])?-[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$",
"maxLength": 48,
"examples": [
"directout-sfp-madi-bnc"
]
},
"moduleTypeName": {
"description": "Name of the module as given by manufacturer",
"type": "string",
"maxLength": 256,
"examples": [
"SFP MADI BNC"
]
},
"manufacturerId": {
"description": "Id of the manufacturer of the device type.",
"type": "string",
"pattern": "^(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])$",
"maxLength": 16,
"examples": [
"directout"
]
},
"manufacturerName": {
"description": "",
"type": "string",
"examples": [
"DirectOut GmbH"
]
},
"manufacturerNameShort": {
"description": "",
"type": "string",
"examples": [
"DirectOut"
]
}
},
"required": [
"moduleTypeId",
"moduleTypeName",
"manufacturerId",
"manufacturerName",
"manufacturerNameShort"
]
}
},
"blacklist": {
"description": "List of module types that will definitely not work in this slot",
"type": "array",
"items": {
"type": "object",
"properties": {
"moduleTypeId": {
"description": "Id of the module type. Consists of id of manufacturer followed by id of module type. See documentation for rules.",
"type": "string",
"pattern": "^(?=.{1,48}$)(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])?-[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$",
"maxLength": 48,
"examples": [
"dnetgear-agm734"
]
},
"moduleTypeName": {
"description": "Name of the module as given by manufacturer",
"type": "string",
"maxLength": 256,
"examples": [
"AGM734"
]
},
"manufacturerId": {
"description": "Id of the manufacturer of the device type.",
"type": "string",
"pattern": "^(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])$",
"maxLength": 16,
"examples": [
"netgear"
]
},
"manufacturerName": {
"description": "",
"type": "string",
"examples": [
"NETGEAR Inc."
]
},
"manufacturerNameShort": {
"description": "",
"type": "string",
"examples": [
"NETGEAR"
]
}
},
"required": [
"moduleTypeId",
"moduleTypeName",
"manufacturerId",
"manufacturerName",
"manufacturerNameShort"
]
}
},
"compatibleModuleTypes": {
"description": "List of module types that physically fit but are not guranteed to work in this slot type",
"type": "array",
"items": {
"type": "object",
"properties": {
"moduleTypeId": {
"description": "Id of the module type. Consists of id of manufacturer followed by id of module type. See documentation for rules.",
"type": "string",
"pattern": "^(?=.{1,48}$)(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])?-[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$",
"maxLength": 48,
"examples": [
"lawo-98160-82"
]
},
"moduleTypeName": {
"description": "Name of the module as given by manufacturer",
"type": "string",
"maxLength": 256,
"examples": [
"981/60-82"
]
},
"manufacturerId": {
"description": "Id of the manufacturer of the device type.",
"type": "string",
"pattern": "^(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])$",
"maxLength": 16,
"examples": [
"lawo"
]
},
"manufacturerName": {
"description": "",
"type": "string",
"examples": [
"Lawo AG"
]
},
"manufacturerNameShort": {
"description": "",
"type": "string",
"examples": [
"Lawo"
]
}
},
"required": [
"moduleTypeId",
"moduleTypeName",
"manufacturerId",
"manufacturerName",
"manufacturerNameShort"
]
}
}
},
"required": [
"whitelist",
"blacklist",
"compatibleModuleTypes"
]
}
Refer to the common response description: 400.
Refer to the common response description: 401.
Refer to the common response description: 404.
Refer to the common response description: 500.
GET /moduletypes
Read the list of module types
Responses
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
[
{
"id": "directout-dantemilansrcio",
"version": "1.1",
"name": "DANTE.MILAN.SRC.IO",
"manufacturerId": "directout",
"manufacturerName": "DirectOut GmbH",
"manufacturerNameShort": "DirectOut",
"orderCode": "DTMILSRCIO",
"orderNumber": "DONETDA01",
"moduleFormFactorId": "directout-a-slot",
"portTypes": [
{
"id": "443d7ee8-1e0f-4f9e-beaf-858415a349bf",
"name": "PRI (1)",
"direction": "UP",
"connectorId": "RJ45_f",
"compatibleSignalTypes": [
"10BASE_T"
]
}
],
"moduleSlotTypes": [
{
"id": "b6424885-a42c-4cf4-b32a-f9032e2fed76",
"name": "1",
"compatibleFormFactors": [
"string"
]
}
]
}
]
Schema of the response body
JSON
{
"type": "array",
"items": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "ModuleType model",
"description": "JSON document describing a module type",
"type": "object",
"properties": {
"id": {
"description": "Id of the module type. Consists of id of manufacturer followed by id of module type. See documentation for rules.",
"type": "string",
"pattern": "^(?=.{1,48}$)(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])?-[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$",
"maxLength": 48,
"examples": [
"directout-dantemilansrcio"
]
},
"version": {
"description": "Version number of the template. Minor version must be increased with every change. Major version must only be changed when targeting a different API version.",
"type": "string",
"pattern": "^\\d{1,2}\\.\\d{1,2}$",
"examples": [
"1.1"
]
},
"name": {
"description": "Name of the module as given by manufacturer",
"type": "string",
"maxLength": 256,
"examples": [
"DANTE.MILAN.SRC.IO"
]
},
"manufacturerId": {
"description": "Id of the manufacturer of the device type.",
"type": "string",
"patter": "^(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])$",
"maxLength": 16,
"examples": [
"directout"
]
},
"manufacturerName": {
"description": "Name of the manufacturer",
"type": "string",
"examples": [
"DirectOut GmbH"
]
},
"manufacturerNameShort": {
"description": "Abbreviated version of the name of the manufacturer",
"type": "string",
"maxLength": 16,
"examples": [
"DirectOut"
]
},
"orderCode": {
"description": "Order code for the module type as used by the manufacturer.",
"type": [
"string",
"null"
],
"examples": [
"DTMILSRCIO"
]
},
"orderNumber": {
"description": "Order number for the module type as used by the manufacturer.",
"type": [
"string",
"null"
],
"examples": [
"DONETDA01"
]
},
"moduleFormFactorId": {
"description": "Form factor of the module.",
"type": [
"string",
"null"
],
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"examples": [
"directout-a-slot"
]
},
"portTypes": {
"description": "List of all types of ports on the module type.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Id of the port type",
"type": "string",
"format": "uuid"
},
"name": {
"description": "Name of the port, as printed on the device.",
"type": "string",
"examples": [
"PRI (1)"
]
},
"direction": {
"description": "Direction of the port type. See documentation for explainations of the possible values.",
"enum": [
"IN",
"OUT",
"INOUT",
"BIDI",
"UP",
"DOWN",
"FRONT",
"BACK"
],
"type": "string",
"examples": [
"UP"
]
},
"connectorId": {
"description": "Id of the connector.",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"RJ45_f"
]
},
"compatibleSignalTypes": {
"description": "List of signal types that are compatible with this port.",
"type": "array",
"items": {
"type": "string",
"pattern": "^(?!.*--)(?:[a-z](?:[a-z-]{0,14}[a-z])?_)?[A-Z0-9]+(?:_[A-Z0-9]+)*$",
"examples": [
"10BASE_T",
"100BASE_TX",
"1000BASE_T"
]
},
"uniqueItems": true
}
},
"required": [
"id",
"name",
"direction",
"connectorId",
"compatibleSignalTypes"
],
"additionalProperties": false
}
},
"moduleSlotTypes": {
"description": "List of all types of module slots on the module type.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Id of the module slot type",
"type": "string",
"format": "uuid"
},
"name": {
"description": "Name of the module slot, as labeled on the device.",
"type": "string",
"examples": [
"1"
]
},
"compatibleFormFactors": {
"description": "List of module slot factors that can physically fit into the slot.",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
}
}
},
"required": [
"id",
"name",
"compatibleFormFactors"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"version",
"name",
"manufacturerId",
"manufacturerName",
"manufacturerNameShort",
"orderCode",
"orderNumber",
"moduleFormFactorId",
"portTypes",
"moduleSlotTypes"
],
"additionalProperties": false
}
}
Refer to the common response description: 401.
Refer to the common response description: 500.
POST /moduletypes
Add a module type
Request body
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
{
"id": "directout-dantemilansrcio",
"version": "1.1",
"name": "DANTE.MILAN.SRC.IO",
"manufacturerId": "directout",
"orderCode": "DTMILSRCIO",
"orderNumber": "DONETDA01",
"moduleFormFactorId": "directout-a-slot",
"portTypes": [
{
"name": "PRI (1)",
"direction": "UP",
"connectorId": "RJ45_f",
"compatibleSignalTypes": [
"10BASE_T"
]
}
],
"moduleSlotTypes": [
{
"name": "1",
"compatibleModuleSlotFormFactors": [
"string"
],
"compatibleModuleTypes": [
"string"
],
"incompatibleModuleTypes": [
"string"
]
}
]
}
Schema of the request body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "ModuleTypeCreate model",
"description": "JSON document describing a module type",
"type": "object",
"properties": {
"id": {
"description": "Id of the module type. Consists of id of manufacturer followed by id of module type. See documentation for rules.",
"type": "string",
"pattern": "^(?=.{1,48}$)(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])?-[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$",
"maxLength": 48,
"examples": [
"directout-dantemilansrcio"
]
},
"version": {
"description": "Version number of the template. Minor version must be increased with every change. Major version must only be changed when targeting a different API version.",
"type": "string",
"pattern": "^\\d{1,2}\\.\\d{1,2}$",
"examples": [
"1.1"
]
},
"name": {
"description": "Name of the module as given by manufacturer",
"type": "string",
"maxLength": 256,
"examples": [
"DANTE.MILAN.SRC.IO"
]
},
"manufacturerId": {
"description": "Id of the manufacturer of the device type.",
"type": "string",
"patter": "^(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])$",
"maxLength": 16,
"examples": [
"directout"
]
},
"orderCode": {
"description": "Order code for the module type as used by the manufacturer.",
"type": [
"string",
"null"
],
"examples": [
"DTMILSRCIO"
]
},
"orderNumber": {
"description": "Order number for the module type as used by the manufacturer.",
"type": [
"string",
"null"
],
"examples": [
"DONETDA01"
]
},
"moduleFormFactorId": {
"description": "Form factor of the module.",
"type": [
"string",
"null"
],
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"examples": [
"directout-a-slot"
]
},
"portTypes": {
"description": "List of all types of ports on the module type.",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "Name of the port, as printed on the device.",
"type": "string",
"examples": [
"PRI (1)"
]
},
"direction": {
"description": "Direction of the port type. See documentation for explainations of the possible values.",
"enum": [
"IN",
"OUT",
"INOUT",
"BIDI",
"UP",
"DOWN",
"FRONT",
"BACK"
],
"type": "string",
"examples": [
"UP"
]
},
"connectorId": {
"description": "Id of the connector.",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"RJ45_f"
]
},
"compatibleSignalTypes": {
"description": "List of signal types that are compatible with this port.",
"type": "array",
"items": {
"type": "string",
"pattern": "^(?!.*--)(?:[a-z](?:[a-z-]{0,14}[a-z])?_)?[A-Z0-9]+(?:_[A-Z0-9]+)*$",
"examples": [
"10BASE_T",
"100BASE_TX",
"1000BASE_T"
]
},
"uniqueItems": true
}
},
"required": [
"name",
"direction",
"connectorId",
"compatibleSignalTypes"
],
"additionalProperties": false
}
},
"moduleSlotTypes": {
"description": "List of all types of module slots on the module type.",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "Name of the module slot, as labeled on the device.",
"type": "string",
"examples": [
"1"
]
},
"compatibleModuleSlotFormFactors": {
"description": "List of module slot factors that can physically fit into the slot.",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
}
},
"compatibleModuleTypes": {
"description": "List of module types that are guranteed by the manufacturer to work in this slot.",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"pattern": "^(?=.{1,48}$)(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])?-[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$"
}
},
"incompatibleModuleTypes": {
"description": "List of module types that are guranteed by the manufacturer not work in this module slot.",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"pattern": "^(?=.{1,48}$)(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])?-[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$"
}
}
},
"required": [
"name",
"compatibleModuleSlotFormFactors",
"compatibleModuleTypes",
"incompatibleModuleTypes"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"version",
"name",
"manufacturerId"
],
"additionalProperties": false
}
Responses
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
{
"id": "directout-dantemilansrcio",
"version": "1.1",
"name": "DANTE.MILAN.SRC.IO",
"manufacturerId": "directout",
"manufacturerName": "DirectOut GmbH",
"manufacturerNameShort": "DirectOut",
"orderCode": "DTMILSRCIO",
"orderNumber": "DONETDA01",
"moduleFormFactorId": "directout-a-slot",
"portTypes": [
{
"id": "cdd7e2e5-ed49-4a2e-ba94-1af0e50d2df7",
"name": "PRI (1)",
"direction": "UP",
"connectorId": "RJ45_f",
"compatibleSignalTypes": [
"10BASE_T"
]
}
],
"moduleSlotTypes": [
{
"id": "ce4f2153-96e6-48be-a813-932caa6aacb7",
"name": "1",
"compatibleFormFactors": [
"string"
]
}
]
}
Schema of the response body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "ModuleType model",
"description": "JSON document describing a module type",
"type": "object",
"properties": {
"id": {
"description": "Id of the module type. Consists of id of manufacturer followed by id of module type. See documentation for rules.",
"type": "string",
"pattern": "^(?=.{1,48}$)(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])?-[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$",
"maxLength": 48,
"examples": [
"directout-dantemilansrcio"
]
},
"version": {
"description": "Version number of the template. Minor version must be increased with every change. Major version must only be changed when targeting a different API version.",
"type": "string",
"pattern": "^\\d{1,2}\\.\\d{1,2}$",
"examples": [
"1.1"
]
},
"name": {
"description": "Name of the module as given by manufacturer",
"type": "string",
"maxLength": 256,
"examples": [
"DANTE.MILAN.SRC.IO"
]
},
"manufacturerId": {
"description": "Id of the manufacturer of the device type.",
"type": "string",
"patter": "^(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])$",
"maxLength": 16,
"examples": [
"directout"
]
},
"manufacturerName": {
"description": "Name of the manufacturer",
"type": "string",
"examples": [
"DirectOut GmbH"
]
},
"manufacturerNameShort": {
"description": "Abbreviated version of the name of the manufacturer",
"type": "string",
"maxLength": 16,
"examples": [
"DirectOut"
]
},
"orderCode": {
"description": "Order code for the module type as used by the manufacturer.",
"type": [
"string",
"null"
],
"examples": [
"DTMILSRCIO"
]
},
"orderNumber": {
"description": "Order number for the module type as used by the manufacturer.",
"type": [
"string",
"null"
],
"examples": [
"DONETDA01"
]
},
"moduleFormFactorId": {
"description": "Form factor of the module.",
"type": [
"string",
"null"
],
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"examples": [
"directout-a-slot"
]
},
"portTypes": {
"description": "List of all types of ports on the module type.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Id of the port type",
"type": "string",
"format": "uuid"
},
"name": {
"description": "Name of the port, as printed on the device.",
"type": "string",
"examples": [
"PRI (1)"
]
},
"direction": {
"description": "Direction of the port type. See documentation for explainations of the possible values.",
"enum": [
"IN",
"OUT",
"INOUT",
"BIDI",
"UP",
"DOWN",
"FRONT",
"BACK"
],
"type": "string",
"examples": [
"UP"
]
},
"connectorId": {
"description": "Id of the connector.",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"RJ45_f"
]
},
"compatibleSignalTypes": {
"description": "List of signal types that are compatible with this port.",
"type": "array",
"items": {
"type": "string",
"pattern": "^(?!.*--)(?:[a-z](?:[a-z-]{0,14}[a-z])?_)?[A-Z0-9]+(?:_[A-Z0-9]+)*$",
"examples": [
"10BASE_T",
"100BASE_TX",
"1000BASE_T"
]
},
"uniqueItems": true
}
},
"required": [
"id",
"name",
"direction",
"connectorId",
"compatibleSignalTypes"
],
"additionalProperties": false
}
},
"moduleSlotTypes": {
"description": "List of all types of module slots on the module type.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Id of the module slot type",
"type": "string",
"format": "uuid"
},
"name": {
"description": "Name of the module slot, as labeled on the device.",
"type": "string",
"examples": [
"1"
]
},
"compatibleFormFactors": {
"description": "List of module slot factors that can physically fit into the slot.",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
}
}
},
"required": [
"id",
"name",
"compatibleFormFactors"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"version",
"name",
"manufacturerId",
"manufacturerName",
"manufacturerNameShort",
"orderCode",
"orderNumber",
"moduleFormFactorId",
"portTypes",
"moduleSlotTypes"
],
"additionalProperties": false
}
Refer to the common response description: 400.
Refer to the common response description: 401.
Refer to the common response description: 422.
Refer to the common response description: 500.
GET /cabletypes
Read the list of cable types
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON
{
"type": "array",
"items": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "CableType model",
"description": "JSON document describing a cable type",
"type": "object",
"properties": {
"id": {
"description": "Id of the cabletype",
"type": "string",
"examples": [
"CAT_6_flex"
]
},
"name": {
"description": "Name of the cabletype",
"type": "string",
"examples": [
"Cat.6 flex"
]
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
}
}
Refer to the common response description: 401.
Refer to the common response description: 500.
GET /connectors
Read the list of connectors
Responses
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
[
{
"id": "BNC_f",
"name": "BNC 75 Ohm female",
"gender": "MALE",
"icon": "BNC_f",
"compatibleConnectors": [
"BNC_f"
]
}
]
Schema of the response body
JSON
{
"type": "array",
"items": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Connector model",
"description": "JSON document describing a connector",
"type": "object",
"properties": {
"id": {
"description": "Id of the connector.",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_f"
]
},
"name": {
"description": "",
"type": "string",
"examples": [
"BNC 75 Ohm female"
]
},
"gender": {
"description": "",
"enum": [
"MALE",
"FEMALE",
"HERMA"
],
"type": "string"
},
"icon": {
"description": "Icon for use with this connector. These can be fetched as SVG icons from /icons/{id}.svg",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_f"
]
},
"compatibleConnectors": {
"description": "List of connectors compatible with this connector",
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_f"
]
},
"uniqueItems": true
}
},
"required": [
"id",
"name",
"gender",
"icon",
"compatibleConnectors"
],
"additionalProperties": false
}
}
Refer to the common response description: 401.
Refer to the common response description: 500.
POST /connectors
Add a new connector
Request body
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
{
"id": "BNC_f",
"name": "BNC 75 Ohm female",
"gender": "MALE",
"icon": "BNC_f",
"compatibleConnectors": [
"BNC_f"
]
}
Schema of the request body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "ConnectorCreate model",
"description": "JSON document describing a connector",
"type": "object",
"properties": {
"id": {
"description": "Id of the connector.",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_f"
]
},
"name": {
"description": "",
"type": "string",
"examples": [
"BNC 75 Ohm female"
]
},
"gender": {
"description": "",
"enum": [
"MALE",
"FEMALE",
"HERMA"
],
"type": "string"
},
"icon": {
"description": "Icon for use with this connector. These can be fetched as SVG icons from /icons/{id}.svg",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_f"
]
},
"compatibleConnectors": {
"description": "List of connectors compatible with this connector",
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_f"
]
},
"uniqueItems": true
}
},
"required": [
"id",
"name",
"gender",
"icon",
"compatibleConnectors"
],
"additionalProperties": false
}
Responses
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
{
"id": "BNC_f",
"name": "BNC 75 Ohm female",
"gender": "MALE",
"icon": "BNC_f",
"compatibleConnectors": [
"BNC_f"
]
}
Schema of the response body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Connector model",
"description": "JSON document describing a connector",
"type": "object",
"properties": {
"id": {
"description": "Id of the connector.",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_f"
]
},
"name": {
"description": "",
"type": "string",
"examples": [
"BNC 75 Ohm female"
]
},
"gender": {
"description": "",
"enum": [
"MALE",
"FEMALE",
"HERMA"
],
"type": "string"
},
"icon": {
"description": "Icon for use with this connector. These can be fetched as SVG icons from /icons/{id}.svg",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_f"
]
},
"compatibleConnectors": {
"description": "List of connectors compatible with this connector",
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_f"
]
},
"uniqueItems": true
}
},
"required": [
"id",
"name",
"gender",
"icon",
"compatibleConnectors"
],
"additionalProperties": false
}
Refer to the common response description: 400.
Refer to the common response description: 401.
Refer to the common response description: 422.
Refer to the common response description: 500.
PATCH /connectors/{connectorId}
Update a connector
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
connectorId |
path | string | No |
Request body
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "ConnectorUpdate model",
"description": "JSON document describing updates to a connector",
"type": "object",
"properties": {
"compatibleConnectors": {
"description": "List of connectors compatible with this connector",
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_f"
]
},
"uniqueItems": true
}
},
"required": [
"compatibleConnectors"
],
"additionalProperties": false
}
Responses
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
{
"id": "BNC_f",
"name": "BNC 75 Ohm female",
"gender": "MALE",
"icon": "BNC_f",
"compatibleConnectors": [
"BNC_f"
]
}
Schema of the response body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Connector model",
"description": "JSON document describing a connector",
"type": "object",
"properties": {
"id": {
"description": "Id of the connector.",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_f"
]
},
"name": {
"description": "",
"type": "string",
"examples": [
"BNC 75 Ohm female"
]
},
"gender": {
"description": "",
"enum": [
"MALE",
"FEMALE",
"HERMA"
],
"type": "string"
},
"icon": {
"description": "Icon for use with this connector. These can be fetched as SVG icons from /icons/{id}.svg",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_f"
]
},
"compatibleConnectors": {
"description": "List of connectors compatible with this connector",
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"BNC_f"
]
},
"uniqueItems": true
}
},
"required": [
"id",
"name",
"gender",
"icon",
"compatibleConnectors"
],
"additionalProperties": false
}
Refer to the common response description: 500.
GET /signaltypes
Read a list of signal types
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON
{
"type": "array",
"items": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "SignalType model",
"description": "JSON document describing a signal type",
"type": "object",
"properties": {
"id": {
"description": "Id of the signal type",
"type": "string",
"pattern": "^(?!.*--)(?:[a-z](?:[a-z-]{0,14}[a-z])?_)?[A-Z0-9]+(?:_[A-Z0-9]+)*$",
"examples": [
"WCLK"
]
},
"name": {
"description": "Name of the signal type",
"type": "string",
"examples": [
"Wordclock"
]
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
}
}
Refer to the common response description: 401.
Refer to the common response description: 500.
POST /signaltypes
Add a signal type
Request body
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "SignalTypeCreate model",
"description": "JSON document describing a signal type",
"type": "object",
"properties": {
"id": {
"description": "Id of the signal type",
"type": "string",
"pattern": "^(?!.*--)(?:[a-z](?:[a-z-]{0,14}[a-z])?_)?[A-Z0-9]+(?:_[A-Z0-9]+)*$",
"examples": [
"WCLK"
]
},
"name": {
"description": "Name of the signal type",
"type": "string",
"examples": [
"Wordclock"
]
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "SignalType model",
"description": "JSON document describing a signal type",
"type": "object",
"properties": {
"id": {
"description": "Id of the signal type",
"type": "string",
"pattern": "^(?!.*--)(?:[a-z](?:[a-z-]{0,14}[a-z])?_)?[A-Z0-9]+(?:_[A-Z0-9]+)*$",
"examples": [
"WCLK"
]
},
"name": {
"description": "Name of the signal type",
"type": "string",
"examples": [
"Wordclock"
]
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
}
Refer to the common response description: 401.
Refer to the common response description: 500.
GET /manufacturers
Read the list of manufacturers
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON
{
"type": "array",
"items": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Manufacturer model",
"description": "JSON document describing a manufacturer",
"type": "object",
"properties": {
"id": {
"description": "Id of the manufacturer",
"type": "string",
"pattern": "^(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])$",
"maxLength": 16,
"examples": [
"lawo"
]
},
"name": {
"description": "Company name of the manufacturer",
"type": "string",
"examples": [
"Lawo AG"
]
},
"nameShort": {
"description": "Shortened company name of the manufacturer",
"type": "string",
"examples": [
"Lawo"
]
}
},
"required": [
"id",
"name",
"nameShort"
],
"additionalProperties": false
}
}
Refer to the common response description: 401.
Refer to the common response description: 500.
POST /manufacturers
Add a manufacturer
Request body
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "ManufacturerCreate model",
"description": "JSON document describing a manufacturer",
"type": "object",
"properties": {
"id": {
"description": "Id of the manufacturer",
"type": "string",
"pattern": "^(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])$",
"maxLength": 16,
"examples": [
"lawo"
]
},
"name": {
"description": "Company name of the manufacturer",
"type": "string",
"examples": [
"Lawo AG"
]
},
"nameShort": {
"description": "Shortened company name of the manufacturer",
"type": "string",
"examples": [
"Lawo"
]
}
},
"required": [
"id",
"name",
"nameShort"
],
"additionalProperties": false
}
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "ManufacturerCreate model",
"description": "JSON document describing a manufacturer",
"type": "object",
"properties": {
"id": {
"description": "Id of the manufacturer",
"type": "string",
"pattern": "^(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])$",
"maxLength": 16,
"examples": [
"lawo"
]
},
"name": {
"description": "Company name of the manufacturer",
"type": "string",
"examples": [
"Lawo AG"
]
},
"nameShort": {
"description": "Shortened company name of the manufacturer",
"type": "string",
"examples": [
"Lawo"
]
}
},
"required": [
"id",
"name",
"nameShort"
],
"additionalProperties": false
}
Refer to the common response description: 400.
Refer to the common response description: 401.
Refer to the common response description: 500.
GET /manufacturers/{manufacturerId}
Read the information of a manufacturer
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
manufacturerId |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Manufacturer model",
"description": "JSON document describing a manufacturer",
"type": "object",
"properties": {
"id": {
"description": "Id of the manufacturer",
"type": "string",
"pattern": "^(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])$",
"maxLength": 16,
"examples": [
"lawo"
]
},
"name": {
"description": "Company name of the manufacturer",
"type": "string",
"examples": [
"Lawo AG"
]
},
"nameShort": {
"description": "Shortened company name of the manufacturer",
"type": "string",
"examples": [
"Lawo"
]
}
},
"required": [
"id",
"name",
"nameShort"
],
"additionalProperties": false
}
Refer to the common response description: 400.
Refer to the common response description: 401.
Refer to the common response description: 404.
Refer to the common response description: 500.
DELETE /manufacturers/{manufacturerId}
Delete a manufacturer
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
manufacturerId |
path | string | No |
Responses
PUT /moduleslots/{moduleSlotId}/module
Replace the module in the slot or put a new one in
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
moduleSlotId |
path | string | No |
Request body
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "ModuleCreate model",
"description": "JSON document describing a new module",
"type": "object",
"properties": {
"moduleTypeId": {
"description": "Id of the module type. Consists of id of manufacturer followed by id of module type. See documentation for rules.",
"type": "string",
"pattern": "^(?=.{1,48}$)(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])?-[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$",
"maxLength": 48,
"examples": [
"lawo-dante-io"
]
},
"moduleSlotId": {
"description": "Id of the module slot",
"type": "string",
"format": "uuid"
}
},
"required": [
"moduleTypeId",
"moduleSlotId"
],
"additionalProperties": false
}
Responses
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
{
"id": "e792a096-8266-4339-b01d-cd6cdd80e18c",
"moduleTypeId": "lawo-dante-io",
"manufacturerId": "lawo",
"manufacturerNameShort": "Lawo",
"ports": [
{
"id": "a65804b2-4dae-48c1-9456-3ae7b57d42e1",
"portTypeId": "855218c7-dff1-494c-9f0a-7c7efbb6c31c",
"portTypeName": "Dante Pri",
"portTypeDirection": "UP",
"connectorId": "RJ45_f",
"connectorName": "RJ45 female",
"connectorIcon": "RJ45_f",
"connectorGender": "FEMALE"
}
],
"moduleSlots": [
{
"id": "faca0ce2-77aa-47a3-bee0-54fe2b7fd3f4",
"moduleSlotTypeId": "03c316c9-f585-4751-a578-bce19ecb24f7",
"moduleSlotTypeName": "SFP 1",
"module": {}
}
]
}
Schema of the response body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Module model",
"description": "JSON document describing a module",
"type": "object",
"properties": {
"id": {
"description": "Id of the module",
"type": "string",
"format": "uuid"
},
"moduleTypeId": {
"description": "Id of the module type. Consists of id of manufacturer followed by id of module type. See documentation for rules.",
"type": "string",
"pattern": "^(?=.{1,48}$)(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])?-[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$",
"maxLength": 48,
"examples": [
"lawo-dante-io"
]
},
"manufacturerId": {
"description": "Id of the manufacturer of the device type.",
"type": "string",
"patter": "^(?!.*--)[a-z](?:[a-z-]{0,14}[a-z])$",
"maxLength": 16,
"examples": [
"lawo"
]
},
"manufacturerNameShort": {
"description": "",
"type": "string",
"examples": [
"Lawo"
]
},
"ports": {
"description": "",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string",
"format": "uuid"
},
"portTypeId": {
"description": "",
"type": "string",
"format": "uuid"
},
"portTypeName": {
"description": "Name of the port, as printed on the device.",
"type": "string",
"examples": [
"Dante Pri"
]
},
"portTypeDirection": {
"description": "Direction of the port type. See documentation for explainations of the possible values.",
"enum": [
"IN",
"OUT",
"INOUT",
"BIDI",
"UP",
"DOWN",
"FRONT",
"BACK"
],
"type": "string",
"examples": [
"UP"
]
},
"connectorId": {
"description": "Id of the connector.",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"RJ45_f"
]
},
"connectorName": {
"description": "Name of the connector",
"type": "string",
"examples": [
"RJ45 female"
]
},
"connectorIcon": {
"description": "Icon for use with this connector. These can be fetched as SVG icons from /icons/{id}.svg",
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9]|[_.](?=[A-Za-z0-9]))*_(?:f|m|h)$",
"examples": [
"RJ45_f"
]
},
"connectorGender": {
"description": "Gender of the connector",
"enum": [
"MALE",
"FEMALE",
"HERMA"
],
"type": "string",
"examples": [
"FEMALE"
]
}
},
"required": [
"id",
"portTypeId",
"portTypeName",
"portTypeDirection",
"connectorId",
"connectorName",
"connectorIcon",
"connectorGender"
],
"additionalProperties": false
}
},
"moduleSlots": {
"description": "",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string",
"format": "uuid"
},
"moduleSlotTypeId": {
"description": "",
"type": "string",
"format": "uuid"
},
"moduleSlotTypeName": {
"description": "Name of the module slot, as labeled on the device.",
"type": "string",
"examples": [
"SFP 1"
]
},
"module": {
"type": "object"
}
},
"required": [
"id",
"moduleSlotTypeId",
"moduleSlotTypeName",
"module"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"moduleTypeId",
"manufacturerId",
"manufacturerNameShort",
"ports",
"moduleSlots"
],
"additionalProperties": false
}
Refer to the common response description: 400.
Refer to the common response description: 401.
Refer to the common response description: 404.
Refer to the common response description: 422.
Refer to the common response description: 500.
Schemas
AuthorizationError
| Name | Type | Description |
|---|---|---|
error |
string | A descriptive error message |
hint |
string | Further explaination and steps to remediate the error |
Building
| Name | Type | Description |
|---|---|---|
id |
string(uuid) | Id of the building |
name |
string | Name of the building |
nameShort |
string | null | Short name of the building |
siteId |
string(uuid) | Id of the site at which the building is located |
BuildingCreate
| Name | Type | Description |
|---|---|---|
name |
string | Name of the building |
nameShort |
string | null | Short name of the building |
siteId |
string(uuid) | Id of the site at which the building is located |
BuildingList
Type: Array<Properties: id, name, nameShort, siteId>
Cable
| Name | Type | Description |
|---|---|---|
cableTypeId |
string | Id of the cable type |
cableTypeName |
string | Name of the cable type |
compatibleCableTypes |
Array<Properties: id, name> |
List of alternative cable types that would be valid |
compatibleEndConnectors |
Array<Properties: id, name, icon, gender> |
List of alternative connectors that would be valid |
compatibleStartConnectors |
Array<Properties: id, name, icon, gender> |
|
createdAt |
string(date-time) | |
createdBy |
string | |
createdByName |
string | |
endBuildingId |
string(uuid) | Id of the building at the end side of the cable |
endBuildingName |
string | Name of the building at the end side of the cable |
endConnectorColor |
string | null | Name of the connector, e.g. housing or sleeve, attached to the end side of the cable |
endConnectorGender |
Gender of the connector attached to the end side of the cable | |
endConnectorIcon |
string | Icon for use with this connector. These can be fetched as SVG icons from /icons/{id}.svg |
endConnectorId |
string | Id of the connector attached to the end side of the cable |
endConnectorName |
string | Name of the connector attached to the end side of the cable |
endDeviceId |
string(uuid) | Id of the device at the end side of the cable |
endDeviceName |
string | Name of the device at the end side of the cable |
endPortDirection |
string | Direction of the port. See documentation for explainations of the possible values. |
endPortId |
string(uuid) | Id of the port at the end side of the cable |
endPortName |
string | Name of the port at the end side of the cable |
endRackId |
string(uuid) | Id of the rack at the end side of the cable |
endRackName |
string | Name of the rack at the end side of the cable |
endRoomId |
string(uuid) | Id of the room at the end side of the cable |
endRoomName |
string | Name of the room at the end side of the cable |
endRoomNumber |
string | null | Number of the room |
endSiteId |
string(uuid) | Id of the site at the end side of the cable |
endSiteName |
string | Name of the site at the end side of the cable |
id |
string(uuid) | Id of the cable |
length |
number | null | length of the cable in meters |
notes |
string | null | |
number |
string | null | Number of the cable |
startBuildingId |
string(uuid) | Id of the building at the start side of the cable |
startBuildingName |
string | Name of the building at the start side of the cable |
startConnectorColor |
string | null | Name of the connector, e.g. housing or sleeve, attached to the start side of the cable |
startConnectorGender |
Gender of the connector attached to the start side of the cable | |
startConnectorIcon |
string | Icon for use with this connector. These can be fetched as SVG icons from /icons/{id}.svg |
startConnectorId |
string | Id of the connector attached to the start side of the cable |
startConnectorName |
string | Name of the connector attached to the start side of the cable |
startDeviceId |
string(uuid) | Id of the device at the start side of the cable |
startDeviceName |
string | Name of the device at the start side of the cable |
startPortDirection |
string | Direction of the port. See documentation for explainations of the possible values. |
startPortId |
string(uuid) | Id of the port at the start side of the cable |
startPortName |
string | Name of the port at the start side of the cable |
startRackId |
string(uuid) | Id of the rack at the start side of the cable |
startRackName |
string | Name of the rack at the start side of the cable |
startRoomId |
string(uuid) | Id of the room at the start side of the cable |
startRoomName |
string | Name of the room at the start side of the cable |
startRoomNumber |
string | null | Number of the room |
startSiteId |
string(uuid) | Id of the site at the start side of the cable |
startSiteName |
string | Name of the site at the start side of the cable |
status |
string | null | |
updatedAt |
string(date-time) | |
updatedBy |
string | |
updatedByName |
string |
CableCreate
| Name | Type | Description |
|---|---|---|
cableTypeId |
string | null | Id of the cable type |
endConnectorColor |
string | null | Name of the connector, e.g. housing or sleeve, attached to the end side of the cable |
endConnectorId |
string | Id of the connector attached to the end side of the cable |
endPortId |
string(uuid) | Id of the port at the end side of the cable |
length |
number | null | length of the cable in meters |
number |
string | null | Number of the cable |
startConnectorColor |
string | null | Name of the connector, e.g. housing or sleeve, attached to the start side of the cable |
startConnectorId |
string | Id of the connector attached to the start side of the cable |
startPortId |
string(uuid) | Id of the port at the start side of the cable |
CableList
Type: Array<Properties: id, number, length, notes, status, cableTypeId, cableTypeName, compatibleCableTypes, createdAt, createdBy, createdByName, updatedAt, updatedBy, updatedByName, startPortId, startPortName, startPortDirection, startConnectorId, startConnectorColor, startConnectorName, startConnectorGender, startConnectorIcon, compatibleStartConnectors, startDeviceId, startDeviceName, startRackId, startRackName, startRoomId, startRoomName, startRoomNumber, startBuildingId, startBuildingName, startSiteId, startSiteName, endPortId, endPortName, endPortDirection, endConnectorId, endConnectorColor, endConnectorName, endConnectorGender, endConnectorIcon, compatibleEndConnectors, endDeviceId, endDeviceName, endRackId, endRackName, endRoomId, endRoomName, endRoomNumber, endBuildingId, endBuildingName, endSiteId, endSiteName>
CableType
| Name | Type | Description |
|---|---|---|
id |
string | Id of the cabletype |
name |
string | Name of the cabletype |
CableTypeList
Type: Array<Properties: id, name>
CableUpdate
| Name | Type | Description |
|---|---|---|
cableTypeId |
string | null | Id of the cable type |
endConnectorColor |
string | null | Name of the connector, e.g. housing or sleeve, attached to the end side of the cable |
endConnectorId |
string | Id of the connector attached to the end side of the cable |
length |
number | null | length of the cable in meters |
number |
string | null | Number of the cable |
startConnectorColor |
string | null | Name of the connector, e.g. housing or sleeve, attached to the start side of the cable |
startConnectorId |
string | Id of the connector attached to the start side of the cable |
ConflictError
| Name | Type | Description |
|---|---|---|
dbMessage |
string | The error message generated by the database |
error |
string | A descriptive error message |
hint |
string | Further explaination and steps to remediate the error |
Connector
| Name | Type | Description |
|---|---|---|
compatibleConnectors |
Array<string> | List of connectors compatible with this connector |
gender |
string | |
icon |
string | Icon for use with this connector. These can be fetched as SVG icons from /icons/{id}.svg |
id |
string | Id of the connector. |
name |
string |
ConnectorCreate
| Name | Type | Description |
|---|---|---|
compatibleConnectors |
Array<string> | List of connectors compatible with this connector |
gender |
string | |
icon |
string | Icon for use with this connector. These can be fetched as SVG icons from /icons/{id}.svg |
id |
string | Id of the connector. |
name |
string |
ConnectorList
Type: Array<Properties: id, name, gender, icon, compatibleConnectors>
ConnectorUpdate
| Name | Type | Description |
|---|---|---|
compatibleConnectors |
Array<string> | List of connectors compatible with this connector |
Device
| Name | Type | Description |
|---|---|---|
buildingId |
string(uuid) | |
buildingName |
string | |
createdAt |
string(date-time) | |
createdBy |
string | |
createdByName |
string | |
description |
string | null | |
deviceTypeId |
string | Id of the device type. Consists of id of manufacturer followed by id of device type. See documentation for rules. |
deviceTypeName |
string | Name of the device as given by manufacturer |
id |
string(uuid) | |
manufacturerId |
string | Id of the manufacturer of the device type. |
manufacturerName |
string | |
manufacturerNameShort |
string | |
moduleSlots |
Array<Properties: id, moduleSlotTypeId, moduleSlotTypeName, module> |
|
name |
string | null | |
notes |
string | null | |
ports |
Array<Properties: id, portTypeId, portTypeName, portTypeDirection, connectorId, connectorName, connectorGender, connectorIcon> |
|
rackDepth |
number | Depth of the device within the rack in mm. Measured from the plane of the rack to the furthest protrusion of the device. |
rackElevation |
number | Lowest rack unit the device occupies. Zero if device is not mounted in a rack. |
rackHeight |
number | Height of the device in rack units. 0 if device is not rackmountable. |
rackId |
string(uuid) | |
rackName |
string | |
rackPosition |
string | Mounting position of the device in a rack |
rackType |
string | Type of rack the device can be mounted in. |
roomId |
string(uuid) | |
roomName |
string | |
roomNumber |
string | null | Number of the room |
serialNumber |
string | null | |
siteId |
string(uuid) | |
siteName |
string | |
status |
string | null | |
updatedAt |
string(date-time) | |
updatedBy |
string | |
updatedByName |
string |
DeviceCreate
| Name | Type | Description |
|---|---|---|
description |
string | null | |
deviceTypeId |
string | Id of the device type. Consists of id of manufacturer followed by id of device type. See documentation for rules. |
name |
string | null | |
notes |
string | null | |
rackElevation |
number | Lowest rack unit the device occupies. Zero if device is not mounted in a rack. |
rackId |
string(uuid) | |
rackPosition |
string | Mounting position of the device in a rack |
serialNumber |
string | null | |
status |
string | null |
DeviceList
Type: Array<Properties: id, name, deviceTypeId, deviceTypeName, manufacturerId, manufacturerName, manufacturerNameShort, rackType, rackHeight, rackDepth, description, notes, status, serialNumber, siteId, siteName, buildingId, buildingName, roomId, roomName, roomNumber, rackId, rackName, rackPosition, rackElevation, createdAt, createdBy, createdByName, updatedAt, updatedBy, updatedByName, ports, moduleSlots>
DeviceType
| Name | Type | Description |
|---|---|---|
climateLoad |
integer | The maximum heat dissipation of the device type. |
id |
string | Id of the device type. Consists of id of manufacturer followed by id of device type. See documentation for rules. |
manufacturerId |
string | Id of the manufacturer of the device type. |
manufacturerName |
string | Name of the manufacturer |
manufacturerNameShort |
string | Abbreviated version of the name of the manufacturer |
moduleSlotTypes |
Array<Properties: id, name> |
List of all types of module slots on the device type. |
name |
string | Name of the device as given by manufacturer |
orderCode |
string | null | Order code for the device type as used by the manufacturer. |
orderNumber |
string | null | Order number for the device type as used by the manufacturer. |
portTypes |
Array<Properties: id, name, direction, connectorId, compatibleSignalTypes> |
List of all types of ports on the device type. |
rackDepth |
number | Depth of the device within the rack in mm. Measured from the plane of the rack to the furthest protrusion of the device. |
rackHeight |
number | Height of the device in rack units. 0 if device is not rackmountable. |
rackType |
string | Type of rack the device can be mounted in. |
version |
string | Version number of the template. Minor version must be increased with every change. Major version must only be changed when targeting a different API version. |
DeviceTypeCreate
| Name | Type | Description |
|---|---|---|
climateLoad |
integer | The maximum heat dissipation of the device type. |
id |
string | Id of the device type. Consists of id of manufacturer followed by id of device type. See documentation for rules. |
manufacturerId |
string | Id of the manufacturer of the device type. |
moduleSlotTypes |
Array<Properties: name, compatibleModuleSlotFormFactors, compatibleModuleTypes, incompatibleModuleTypes> |
List of all types of module slots on the device type. |
name |
string | Name of the device as given by manufacturer |
orderCode |
string | null | Order code for the device type as used by the manufacturer. |
orderNumber |
string | null | Order number for the device type as used by the manufacturer. |
portTypes |
Array<Properties: name, direction, connectorId, compatibleSignalTypes> |
List of all types of ports on the device type. |
rackDepth |
number | Depth of the device within the rack in mm. Measured from the plane of the rack to the furthest protrusion of the device. |
rackHeight |
number | Height of the device in rack units. 0 if device is not rackmountable. |
rackType |
string | Type of rack the device can be mounted in. |
version |
string | Version number of the template. Minor version must be increased with every change. Major version must only be changed when targeting a different API version. |
DeviceTypeList
Type: Array<Properties: id, version, name, manufacturerId, manufacturerName, manufacturerNameShort, orderCode, orderNumber, climateLoad, rackType, rackHeight, rackDepth, portTypes, moduleSlotTypes>
DeviceUpdate
| Name | Type | Description |
|---|---|---|
description |
string | null | |
name |
string | null | |
notes |
string | null | |
rackElevation |
number | Lowest rack unit the device occupies. Zero if device is not mounted in a rack. |
rackId |
string(uuid) | |
rackPosition |
string | Mounting position of the device in a rack |
serialNumber |
string | null | |
status |
string | null |
ErrorMessage
| Name | Type | Description |
|---|---|---|
error |
string | A descriptive error message |
hint |
string | Further explaination and steps to remediate the error |
Manufacturer
| Name | Type | Description |
|---|---|---|
id |
string | Id of the manufacturer |
name |
string | Company name of the manufacturer |
nameShort |
string | Shortened company name of the manufacturer |
ManufacturerCreate
| Name | Type | Description |
|---|---|---|
id |
string | Id of the manufacturer |
name |
string | Company name of the manufacturer |
nameShort |
string | Shortened company name of the manufacturer |
ManufacturerList
Type: Array<Properties: id, name, nameShort>
Module
| Name | Type | Description |
|---|---|---|
id |
string(uuid) | Id of the module |
manufacturerId |
string | Id of the manufacturer of the device type. |
manufacturerNameShort |
string | |
moduleSlots |
Array<Properties: id, moduleSlotTypeId, moduleSlotTypeName, module> |
|
moduleTypeId |
string | Id of the module type. Consists of id of manufacturer followed by id of module type. See documentation for rules. |
ports |
Array<Properties: id, portTypeId, portTypeName, portTypeDirection, connectorId, connectorName, connectorIcon, connectorGender> |
ModuleCreate
| Name | Type | Description |
|---|---|---|
moduleSlotId |
string(uuid) | Id of the module slot |
moduleTypeId |
string | Id of the module type. Consists of id of manufacturer followed by id of module type. See documentation for rules. |
ModuleList
Type: Array<Properties: id, moduleTypeId, manufacturerId, manufacturerNameShort, ports, moduleSlots>
ModuleSlotTypeCompatible
| Name | Type | Description |
|---|---|---|
blacklist |
Array<Properties: moduleTypeId, moduleTypeName, manufacturerId, manufacturerName, manufacturerNameShort> |
List of module types that will definitely not work in this slot |
compatibleModuleTypes |
Array<Properties: moduleTypeId, moduleTypeName, manufacturerId, manufacturerName, manufacturerNameShort> |
List of module types that physically fit but are not guranteed to work in this slot type |
whitelist |
Array<Properties: moduleTypeId, moduleTypeName, manufacturerId, manufacturerName, manufacturerNameShort> |
List of module types that are guranteed by the manufacturer to work in this slot |
ModuleType
| Name | Type | Description |
|---|---|---|
id |
string | Id of the module type. Consists of id of manufacturer followed by id of module type. See documentation for rules. |
manufacturerId |
string | Id of the manufacturer of the device type. |
manufacturerName |
string | Name of the manufacturer |
manufacturerNameShort |
string | Abbreviated version of the name of the manufacturer |
moduleFormFactorId |
string | null | Form factor of the module. |
moduleSlotTypes |
Array<Properties: id, name, compatibleFormFactors> |
List of all types of module slots on the module type. |
name |
string | Name of the module as given by manufacturer |
orderCode |
string | null | Order code for the module type as used by the manufacturer. |
orderNumber |
string | null | Order number for the module type as used by the manufacturer. |
portTypes |
Array<Properties: id, name, direction, connectorId, compatibleSignalTypes> |
List of all types of ports on the module type. |
version |
string | Version number of the template. Minor version must be increased with every change. Major version must only be changed when targeting a different API version. |
ModuleTypeCreate
| Name | Type | Description |
|---|---|---|
id |
string | Id of the module type. Consists of id of manufacturer followed by id of module type. See documentation for rules. |
manufacturerId |
string | Id of the manufacturer of the device type. |
moduleFormFactorId |
string | null | Form factor of the module. |
moduleSlotTypes |
Array<Properties: name, compatibleModuleSlotFormFactors, compatibleModuleTypes, incompatibleModuleTypes> |
List of all types of module slots on the module type. |
name |
string | Name of the module as given by manufacturer |
orderCode |
string | null | Order code for the module type as used by the manufacturer. |
orderNumber |
string | null | Order number for the module type as used by the manufacturer. |
portTypes |
Array<Properties: name, direction, connectorId, compatibleSignalTypes> |
List of all types of ports on the module type. |
version |
string | Version number of the template. Minor version must be increased with every change. Major version must only be changed when targeting a different API version. |
ModuleTypeList
Type: Array<Properties: id, version, name, manufacturerId, manufacturerName, manufacturerNameShort, orderCode, orderNumber, moduleFormFactorId, portTypes, moduleSlotTypes>
NotFoundError
| Name | Type | Description |
|---|---|---|
error |
string | A descriptive error message |
hint |
string | Further explaination and steps to remediate the error |
Port
| Name | Type | Description |
|---|---|---|
compatibleConnectors |
Array<Properties: connectorId, connectorName, connectorIcon, connectorGender> |
|
compatibleSignalTypes |
Array<Properties: signalId, signalName> |
List of signal types that are compatible with this port |
connectorGender |
string | Gender of the connector |
connectorIcon |
string | Icon for use with this connector. These can be fetched as SVG icons from /icons/{id}.svg |
connectorId |
string | Id of the connector. |
connectorName |
string | Name of the connector. |
id |
string(uuid) | Id of the port |
portTypeDirection |
string | Direction of the port type. See documentation for explainations of the possible values. |
portTypeId |
string(uuid) | Id of the port type |
portTypeName |
string | Name of the port type, as printed on the device. |
Rack
| Name | Type | Description |
|---|---|---|
depth |
number | Depth of the rack in mm |
id |
string(uuid) | Id of the rack |
name |
string | Name of the rack |
roomId |
string(uuid) | Id of the room in which the rack is located |
totalRU |
number | Height of the rack in units. 0 when not a rack |
type |
string | Type of the rack |
RackCreate
| Name | Type | Description |
|---|---|---|
depth |
number | Depth of the rack in mm |
name |
string | Name of the rack |
roomId |
string(uuid) | Id of the room in which the rack is located |
totalRU |
number | Height of the rack in units. 0 when not a rack |
type |
string | Type of the rack |
RackList
Type: Array<Properties: id, name, roomId, type, totalRU, depth>
RequestError
| Name | Type | Description |
|---|---|---|
error |
string | A descriptive error message |
hint |
string | Further explaination and steps to remediate the error |
Room
| Name | Type | Description |
|---|---|---|
buildingId |
string(uuid) | Id of the building in which the room is located |
id |
string(uuid) | Id of the room |
name |
string | Name of the room |
number |
string | null | Number of the room |
RoomCreate
| Name | Type | Description |
|---|---|---|
buildingId |
string(uuid) | Id of the building in which the room is located |
name |
string | Name of the room |
number |
string | null | Number of the room |
RoomList
Type: Array<Properties: id, name, number, buildingId>
ServerError
| Name | Type | Description |
|---|---|---|
error |
string | A descriptive error message |
hint |
string | Further explaination and steps to remediate the error |
SignalType
| Name | Type | Description |
|---|---|---|
id |
string | Id of the signal type |
name |
string | Name of the signal type |
SignalTypeCreate
| Name | Type | Description |
|---|---|---|
id |
string | Id of the signal type |
name |
string | Name of the signal type |
SignalTypeList
Type: Array<Properties: id, name>
Site
| Name | Type | Description |
|---|---|---|
id |
string(uuid) | Id of the site |
name |
string | Name of the site |
SiteCreate
| Name | Type | Description |
|---|---|---|
name |
string | Name of the site |
SiteList
Type: Array<Properties: id, name>
ValidationError
| Name | Type | Description |
|---|---|---|
dbConstraint |
string | The constraint in the database that was violated |
dbMessage |
string | The error message generated by the database |
error |
string | A descriptive error message |
hint |
string | Further explaination and steps to remediate the error |
Common responses
This section describes common responses that are reused across operations.
400
The request does not follow the syntax rules. Retrying with the same request will never result in success.
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Bad request message",
"description": "Error message provided with 400 codes",
"type": "object",
"properties": {
"error": {
"description": "A descriptive error message",
"type": "string",
"example": "Invalid syntax in the request"
},
"hint": {
"description": "Further explaination and steps to remediate the error",
"type": "string",
"example": "Hints about proper syntax "
}
},
"required": [
"error",
"hint"
],
"additionalProperties": false
}
401
The request does not include valid authorization. Retry with the proper cookie included in the request.
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Error message",
"description": "Error message provided with 401 codes",
"type": "object",
"properties": {
"error": {
"description": "A descriptive error message",
"type": "string",
"example": "No session found"
},
"hint": {
"description": "Further explaination and steps to remediate the error",
"type": "string",
"example": "Try logging out and back in"
}
},
"required": [],
"additionalProperties": false
}
404
The requested path is syntactically corrcect but no ressource exists here
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
{
"error": "Device '0f135d47-a440-44ee-a838-3f801b9df90b' does not exist.",
"hint": "Ensure that the provided id references an existing object"
}
Schema of the response body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Not found message",
"description": "Error message provided with 404 codes",
"type": "object",
"properties": {
"error": {
"description": "A descriptive error message",
"type": "string",
"example": "Device '0f135d47-a440-44ee-a838-3f801b9df90b' does not exist."
},
"hint": {
"description": "Further explaination and steps to remediate the error",
"type": "string",
"example": "Ensure that the provided id references an existing object"
}
},
"required": [
"error",
"hint"
],
"additionalProperties": false
}
409
The request is valid but can not be processed due to the current state of the database (e.g. a ressource can not be deleted while it is still referenced elsewhere). Retrying this request another time might result in success.
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
{
"error": "The resource is still referenced elsewhere",
"hint": "You can only delete resources that are not referenced elsewhere",
"dbMessage": "string"
}
Schema of the response body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Conflict message",
"description": "Error message provided with 409 codes",
"type": "object",
"properties": {
"error": {
"description": "A descriptive error message",
"type": "string",
"example": "The resource is still referenced elsewhere"
},
"hint": {
"description": "Further explaination and steps to remediate the error",
"type": "string",
"example": "You can only delete resources that are not referenced elsewhere"
},
"dbMessage": {
"description": "The error message generated by the database",
"type": "string"
}
},
"required": [
"error",
"hint"
],
"additionalProperties": false
}
422
Request is syntactically correct but violates some validation logic. Retrying will not result in success.
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
{
"error": "Device cant be inserted since the combined depth 400+400 would exceed the depth of the rack 600",
"hint": "",
"dbMessage": "string",
"dbConstraint": "string"
}
Schema of the response body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Unprocessable entity message",
"description": "Error message provided with 422 codes",
"type": "object",
"properties": {
"error": {
"description": "A descriptive error message",
"type": "string",
"example": "Device cant be inserted since the combined depth 400+400 would exceed the depth of the rack 600"
},
"hint": {
"description": "Further explaination and steps to remediate the error",
"type": "string",
"example": ""
},
"dbMessage": {
"description": "The error message generated by the database",
"type": "string"
},
"dbConstraint": {
"description": "The constraint in the database that was violated",
"type": "string"
}
},
"required": [
"error",
"hint"
],
"additionalProperties": false
}
500
Internal server error
JSON
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
{
"error": "Internal server error",
"hint": "If this error persists, please contact your administrator."
}
Schema of the response body
JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Error message",
"description": "Error message provided with 500 codes",
"type": "object",
"properties": {
"error": {
"description": "A descriptive error message",
"type": "string",
"example": "Internal server error"
},
"hint": {
"description": "Further explaination and steps to remediate the error",
"type": "string",
"example": "If this error persists, please contact your administrator."
}
},
"required": [
"error",
"hint"
],
"additionalProperties": false
}
Common parameters
This section describes common parameters that are reused across operations.
siteId
| Name | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
siteId |
query | string | No |
buildingId
| Name | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
buildingId |
query | string | No |
roomId
| Name | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
roomId |
query | string | No |
rackId
| Name | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
rackId |
query | string | No |
startRackId
| Name | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
startRackId |
query | string | No |
startRoomId
| Name | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
startRoomId |
query | string | No |
startBuildingId
| Name | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
startBuildingId |
query | string | No |
endRackId
| Name | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
endRackId |
query | string | No |
endRoomId
| Name | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
endRoomId |
query | string | No |
endBuildingId
| Name | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
endBuildingId |
query | string | No |
manufacturerId
| Name | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
manufacturerId |
query | string | No |
This page is generated using the OAD Plugin by Roberto Prevato.