...
Gibt die spezifische Eigenschaften eines Kabels zurück.
Beispielaufruf
Lesen eines speziellen Kabels:
| Codeblock |
|---|
{
"method":"cable.cable.read",
"params":{
"apikey":"24174j3tqj",
"id": 4
},
"version":"2.0"
} |
Filtern von Kabeln:
| Codeblock |
|---|
{ "method":"cable.cable.read", "params":{ "apikey":"24174j3tqj", "filter": { "state": "ok" } }, |
...
"version":"2.0" } |
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| id | int | Optional: ID des Datenbankeintrages | ab Version 1.0 |
| 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 |
...
Legt neue Eigenschaften zu einem Kabel an.
Beispielaufruf
| Codeblock |
|---|
{ "method":"cable.cable.create", "params":{ "apikey":"24174j3tqj", "data": { "obj_id":19, "state":"verlegt", "group_id": |
...
8, "length":100 } }, |
...
"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 |
...
Aktualisiert bestehende Eigenschaften zu einem Kabel.
Beispielaufruf
| Codeblock |
|---|
{ "method":"cable.cable.update", "params":{ "apikey":"24174j3tqj", " |
...
id":4, "data": { "state":"verlegt", "group_id": |
...
14, "length":100 } }, |
...
"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 |
...
Löscht die spezifischen Eigenschaften eines Kabels.
Beispielaufruf
| Codeblock |
|---|
{ "method":"cable.cable.delete", "params":{ "apikey":"24174j3tqj", " |
...
id":4 }, |
...
"version":"2.0" } |
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| cable_id | int | ID des zu löschenden Datenbankeintrages | ab Version 1.0 |
...