Verwaltung von Eigenschaften eines Kabels.
Seitenverzeichnis:
cable.cable.read
Beschreibung
Gibt die spezifische Eigenschaften eines Kabels zurück.
Beispielaufruf
{"method":"cable.cable.read","params":{"apikey":"24174j3tqj", filter: {"state": "ok"}},"id":1,"version":"2.0"}
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| filter | array | Optional: Filter für Kabel Der Filter unterstützt alle Eigenschaften des Kabels (siehe Rückgabewerte). Als Suchkriterium kann das Prozent-Zeichen "%" als Wildcard verwendet werden. | ab Version 1.0 |
Rückgabewert
Liste aller Eigenschaften zum angegebenen Objekt.
| Wert | Typ | Beschreibung | Version |
|---|---|---|---|
| id | int | ID des Datenbankeintrages | ab Version 1.0 |
| obj_id | int | ID des referenzierten Kabels | ab Version 1.0 |
| state | string | Status des Kabels | ab Version 1.0 |
| group_id | int | Zugehörige Kabelgruppe | ab Version 1.0 |
| type_id | int | Zugehöriger Kabeltyp | ab Version 1.0 |
| length | int | Länge des Kabels | ab Version 1.0 |
| capacity | int | Angabe zur Kabelauslastung in Prozent | ab Version 1.0 |
| admin_unit_id | int | Verwaltungseinheit des Kabels | ab Version 1.0 |
| net_type | string | Netzart | ab Version 1.0 |
| connection_type_id | int | Verbindungs-Typ | ab Version 1.0 |
| location_in_id | int | Standort ankommend | ab Version 1.0 |
| location_out_id | int | Standort abgehend | ab Version 1.0 |
cable.cable.create
Beschreibung
Legt neue Eigenschaften zu einem Kabel an.
Beispielaufruf
{"method":"cable.cable.create","params":{"apikey":"24174j3tqj","obj_id":19,"state":"verlegt","group":"50-adrig","length":100},"id":1,"version":"2.0"}
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| obj_id | int | ID des referenzierten Kabels | ab Version 1.0 |
| state | string | Optional: Status des Kabels | ab Version 1.0 |
| group_id | int | Optional: Zugehörige Kabelgruppe | ab Version 1.0 |
| type_id | int | Optional: Zugehöriger Kabeltyp | ab Version 1.0 |
| length | int | Optional: Länge des Kabels | ab Version 1.0 |
| capacity | int | Optional: Angabe zur Kabelauslastung in Prozent | ab Version 1.0 |
| admin_unit_id | int | Optional: Verwaltungseinheit des Kabels | ab Version 1.0 |
| net_type | string | Optional: Netzart | ab Version 1.0 |
| connection_type_id | int | Optional: Verbindungs-Typ | ab Version 1.0 |
| location_in_id | int | Optional: Standort ankommend | ab Version 1.0 |
| location_out_id | int | Optional: Standort abgehend | 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.cable.update
Beschreibung
Aktualisiert bestehende Eigenschaften zu einem Kabel.
Beispielaufruf
{"method":"cable.cable.update","params":{"apikey":"24174j3tqj","cable_id":4,"state":"verlegt","group":"50-adrig","length":100},"id":1,"version":"2.0"}
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| cable_id | int | ID des Datenbankeintrages | ab Version 1.0 |
| state | string | Optional: Status des Kabels | ab Version 1.0 |
| group_id | int | Optional: Zugehörige Kabelgruppe | ab Version 1.0 |
| type_id | int | Optional: Zugehöriger Kabeltyp | ab Version 1.0 |
| length | int | Optional: Länge des Kabels | ab Version 1.0 |
| capacity | int | Optional: Angabe zur Kabelauslastung in Prozent | ab Version 1.0 |
| admin_unit_id | int | Optional: Verwaltungseinheit des Kabels | ab Version 1.0 |
| net_type | string | Optional: Netzart | ab Version 1.0 |
| connection_type_id | int | Optional: Verbindungs-Typ | ab Version 1.0 |
| location_in_id | int | Optional: Standort ankommend | ab Version 1.0 |
| location_out_id | int | Optional: Standort abgehend | 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.cable.delete
Beschreibung
Löscht die spezifischen Eigenschaften eines Kabels.
Beispielaufruf
{"method":"cable.cable.delete","params":{"apikey":"24174j3tqj","cable_id":4},"id":1,"version":"2.0"}
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| cable_id | int | ID des zu löschenden Datenbankeintrages | 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 |