...
Gibt die Adern eines Kabels zurück.
Beispielaufruf
Lesen einer speziellen Ader:
| Codeblock |
|---|
{
"method":"cable.wire.read",
"params":{
"apikey":"24174j3tqj",
"id": 4
},
"version":"2.0"
} |
Filtern von Adern:
| Codeblock |
|---|
{ "method":"cable.wire.read", "params":{ "apikey":"24174j3tqj", "filter": { "description": "Ader %" } }, |
...
"version":"2.0" } |
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| id | int | Optional: ID des Datenbankeintrages | ab Version 1.0 |
| filter | array | Optional: Filter für Adern Der Filter unterstützt alle Eigenschaften der Ader (siehe Rückgabewerte). Als Suchkriterium kann das Prozent-Zeichen "%" als Wildcard verwendet werden. | ab Version 1.0 |
...
Legt eine neue Ader zu einem Kabel an.
Beispielaufruf
| Codeblock |
|---|
{ "method":"cable.wire.create", "params":{ "apikey":"24174j3tqj", "data": { "obj_id":19, "description":"Ader 1", "number":1 } |
...
}, "version":"2.0" } |
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| obj_id | int | ID des referenzierten Kabels | ab Version 1.0 |
| description | string | Beschreibung der Ader | ab Version 1.0 |
| color | string | Optional: Farbe der Ader | ab Version 1.0 |
| classification | string | Optional: Leiter-Typ | ab Version 1.0 |
...
Aktualisiert eine bestehende Ader zu einem Kabel.
Beispielaufruf
| Codeblock |
|---|
{ "method":"cable.wire.update", "params":{ "apikey":"24174j3tqj", " |
...
id":4, "data": { "description":"Ader 1", "number":1 } |
...
}, "version":"2.0" } |
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| wire_id | int | ID des Datenbankeintrages | ab Version 1.0 |
| description | string | Beschreibung der Ader | ab Version 1.0 |
| color | string | Optional: Farbe der Ader | ab Version 1.0 |
| classification | string | Optional: Leiter-Typ | ab Version 1.0 |
...
Generiert automatisch alle Adern eines Kabels, basierend auf dessen Kabeltyp.
Beispielaufruf
| Codeblock |
|---|
{ "method":"cable.wire.generate_wires", "params":{ "apikey":"24174j3tqj", " |
...
id":123, "data": { "prefix":"MyWire" } }, |
...
"version":"2.0" } |
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| obj_id | int | ID des referenzierten Kabels | ab Version 1.0 |
| prefix | string | Optional: Vorsilbe, welche vor den Namen jeder Ader angefügt wird | ab Version 1.0 |
| start_pattern | string | Optional: Anfangs-Muster, anhand dessen die laufenden Nummern der Adern gebildet werden. Unterstützt werden:
| ab Version 1.0 |
| end_pattern | string | Optional: End-Muster, bis zu welchem die laufenden Nummern der Adern gebildet werden. Unterstützt werden:
Beispiel 1:
Beispiel 2:
| ab Version 1.0 |
...
Löscht eine Ader eines Kabels.
Beispielaufruf
| Codeblock |
|---|
{ "method":"cable.wire.delete", "params":{ "apikey":"24174j3tqj", " |
...
id":4 }, |
...
"version":"2.0" } |
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| wire_idwid | int | ID des zu löschenden Datenbankeintrages | ab Version 1.0 |
...
Löscht alle Adern eines Kabels.
Beispielaufruf
| Codeblock |
|---|
{ "method":"cable.wire.delete_all", "params":{ "apikey":"24174j3tqj", " |
...
id":123 }, |
...
"version":"2.0" } |
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| obj_id | int | ID des referenzierten Kabels | ab Version 1.0 |
...