Verwaltung von Anschlüssen einer Ader.
Hinweis: Die Anschlüsse einer Ader werden automatisch beim Anlegen einer Ader erzeugt. Zudem werden die Anschlüsse beim Löschen einer Ader automatisch wieder entfernt.
Seitenverzeichnis:
cable.wire_pin.read
Beschreibung
Gibt die Anschlüsse einer Ader zurück.
Beispielaufruf
{"method":"cable.wire_pin.read","params":{"apikey":"24174j3tqj", filter: {"wire_id": 123}},"id":1,"version":"2.0"}
Parameter
Parameter | Typ | Beschreibung | Version |
---|---|---|---|
filter | array | Optional: Filter für Ader-Anschlüsse Der Filter unterstützt alle Eigenschaften der Ader-Anschlüsse (siehe Rückgabewerte). Als Suchkriterium kann das Prozent-Zeichen "%" als Wildcard verwendet werden. | ab Version 1.0 |
Rückgabewert
Liste aller Adern zum angegebenen Kabel.
Wert | Typ | Beschreibung | Version |
---|---|---|---|
id | int | ID des Datenbankeintrages | ab Version 1.0 |
wire_id | int | ID der referenzierten Ader | ab Version 1.0 |
description | string | Beschreibung des Ader-Anschlusses | ab Version 1.0 |
state | string | Status des Ader-Anschlüsses zulässige Werte:
| ab Version 1.0 |
sibling_id | int | ID des dazugehörigen zweiten Ader-Anschlusses Hinweis: Ist die sibling_id kleiner der ID des Ader-Anschlusses | ab Version 1.0 |
connected_pin_id | string | ausgehender Status der Ader zulässige Werte:
| ab Version 1.0 |
cable.wire_pin.update
Beschreibung
Aktualisiert eine bestehende Ader zu einem Kabel.
Beispielaufruf
{"method":"cable.wire_pin.update","params":{"apikey":"24174j3tqj","wire_id":4,"description":"Ader 1","number":1},"id":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 |
state_in | string | Optional: eingehender Status der Ader zulässige Werte:
| ab Version 1.0 |
state_out | string | Optional: ausgehender Status der Ader zulässige Werte:
| ab Version 1.0 |
description_incoming | string | Optional: Bezeichnung eingehend | ab Version 1.0 |
description_outgoing | string | Optional: Bezeichnung ausgehend | ab Version 1.0 |
classification | string | Optional: Leiter-Typ | 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 |