Kabelgruppe
Verwaltung von Kabelgruppen.
Seitenverzeichnis:
cable.group.read
Beschreibung
Gibt alle Kabelgruppen zurück.
Beispielaufruf
Lesen einer speziellen Kabelgruppe:
{ "method":"cable.group.read", "params":{ "apikey":"24174j3tqj", "id": 4 }, "version":"2.0", "id": 1 }
Filtern nach Kabelgruppen:
{ "method":"cable.group.read", "params":{ "apikey":"24174j3tqj", "filter": { "description": "Gruppe %" } }, "version":"2.0", "id": 1 }
Parameter
Parameter | Typ | Beschreibung | Version |
---|---|---|---|
id | int | Optional: ID des Datenbankeintrages | ab Version 1.0 |
filter | array | Optional: Filter für Kabelgruppe Der Filter unterstützt alle Eigenschaften der Kabelgruppe (siehe Rückgabewerte). Als Suchkriterium kann das Prozent-Zeichen "%" als Wildcard verwendet werden. | ab Version 1.0 |
Rückgabewert
Liste aller Eigenschaften der Kabelgruppen.
Wert | Typ | Beschreibung | Version |
---|---|---|---|
id | int | ID des Datenbankeintrages | ab Version 1.0 |
description | string | Beschreibung der Kabelgruppe | ab Version 1.0 |
classification | string | Kabelklasse | ab Version 1.0 |
cable.group.create
Beschreibung
Legt eine neue Kabelgruppe an.
Beispielaufruf
{ "method":"cable.group.create", "params":{ "apikey":"24174j3tqj", "data": { "description":"Gruppe 1", "classification":"LAN-Kabel" } }, "version":"2.0", "id": 1 }
Parameter
Parameter | Typ | Beschreibung | Version |
---|---|---|---|
description | string | Beschreibung der Kabelgruppe | ab Version 1.0 |
classification | string | Kabelklasse | ab Version 1.0 |
Rückgabewert
Wert | Typ | Version |
---|---|---|
current_date | string | ab Version 1.0 |
id | int | ab Version 1.0 |
message | string | ab Version 1.0 |
cable.group.update
Beschreibung
Aktualisiert eine bestehende Kabelgruppe.
Beispielaufruf
{ "method":"cable.group.update", "params":{ "apikey":"24174j3tqj", "id":4, "data": { "description":"Gruppe 1", "classification":"LAN-Kabel" } }, "version":"2.0", "id": 1 }
Parameter
Parameter | Typ | Beschreibung | Version |
---|---|---|---|
id | int | ID des Datenbankeintrages | ab Version 1.0 |
description | string | Beschreibung der Kabelgruppe | ab Version 1.0 |
classification | string | Kabelklasse | ab Version 1.0 |
Rückgabewert
Wert | Typ | Version |
---|---|---|
current_date | string | ab Version 1.0 |
id | int | ab Version 1.0 |
message | string | ab Version 1.0 |
cable.group.delete
Beschreibung
Löscht eine Kabelgruppe.
Beispielaufruf
{ "method":"cable.group.delete", "params":{ "apikey":"24174j3tqj", "id":4 }, "version":"2.0", "id": 1 }
Parameter
Parameter | Typ | Beschreibung | Version |
---|---|---|---|
id | int | ID der zu löschenden Kabelgruppe | ab Version 1.0 |
Rückgabewert
Wert | Typ | Version |
---|---|---|
current_date | string | ab Version 1.0 |
id | int | ab Version 1.0 |
message | string | ab Version 1.0 |
(c) 2024 SHD System-Haus-Dresden GmbH | Impressum https://www.shd-online.de/impressum/