Verwaltung von Verwaltungseinheiten.
Seitenverzeichnis:
cable.admin_unit.read
Beschreibung
Gibt alle Verwaltungseinheiten zurück.
Beispielaufruf
{
"method":"cable.admin_unit.read",
"params": {
"apikey":"24174j3tqj",
"filter": {
"description": "Einheit %"
}
},
"id":1,
"version":"2.0"
}
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| filter | array | Optional: Filter für Verwaltungseinheiten Der Filter unterstützt alle Eigenschaften der Verwaltungseinheit (siehe Rückgabewerte). Als Suchkriterium kann das Prozent-Zeichen "%" als Wildcard verwendet werden. | ab Version 1.0 |
Rückgabewert
Liste aller Eigenschaften der Verwaltungseinheiten.
| Wert | Typ | Beschreibung | Version |
|---|---|---|---|
| id | int | ID des Datenbankeintrages | ab Version 1.0 |
| description | string | Beschreibung der Verwaltungseinheit | ab Version 1.0 |
| classification | string | Verwaltungsklasse | ab Version 1.0 |
| parent_id | int | Optional: ID der Eltern-Verwaltungseinheit | ab Version 1.0 |
cable.admin_unit.create
Beschreibung
Legt eine neue Verwaltungseinheit an.
Beispielaufruf
{"method":"cable.admin_unit.create","params":{"apikey":"24174j3tqj","description":"LAN-Kabel","classification":"Netzwerk"},"id":1,"version":"2.0"}
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| description | string | Beschreibung der Verwaltungseinheit | ab Version 1.0 |
| classification | string | Verwaltungsklasse | ab Version 1.0 |
| parent_id | int | Optional: ID der Eltern-Verwaltungseinheit | 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.admin_unit.update
Beschreibung
Aktualisiert eine bestehende Verwaltungseinheit.
Beispielaufruf
{"method":"cable.admin_unit.update","params":{"apikey":"24174j3tqj","admin_unit_id":4,"description":"LAN-Kabel","classification":"Netzwerk"},"id":1,"version":"2.0"}
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| admin_unit_id | int | ID des Datenbankeintrages | ab Version 1.0 |
| description | string | Beschreibung der Verwaltungseinheit | ab Version 1.0 |
| classification | string | Verwaltungsklasse | ab Version 1.0 |
| parent_id | int | Optional: ID der Eltern-Verwaltungseinheit | 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.admin_unit.delete
Beschreibung
Löscht eine Verwaltungseinheit.
Beispielaufruf
{"method":"cable.admin_unit.delete","params":{"apikey":"24174j3tqj","admin_unit_id":4},"id":1,"version":"2.0"}
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| admin_unit_id | int | ID der zu löschenden Verwaltungseinheit | 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 |