...
Gibt die Anschlüsse einer Ader zurück.
Beispielaufruf
Lesen eines speziellen Ader-Anschlusses:
| Codeblock |
|---|
|
{
"method":"cable.wire_pin.read",
"params":{
"apikey":"24174j3tqj",
"id": 4
},
"version":"2.0",
"id": 1
} |
Filtern von Ader-Anschlüssen:
| Codeblock |
|---|
|
{
"method":"cable.wire_pin.read",
"params":{
"apikey":"24174j3tqj",
"filter": {
"wire_id": 123
}
}, |
...
"version":"2.0",
"id": 1
} |
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|
| id | int | Optional: ID des Datenbankeintrages | ab Version 1.0 |
| 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 |
...
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 |
statestring| int | ID des Status des Ader- |
Anschlüsseszulässige Werte:
- H = hängend
- VH = vorbereitet, hängend
- R = reserviert
0| 1 |
| sibling_id | int | ID des dazugehörigen zweiten Ader-Anschlusses Hinweis: Ist die sibling_id größer der ID des Ader-Anschlusses, handelt es sich bei diesem Anschluss um den Eingang bzw. die "linke Seite" | ab Version 1.0 |
| connected_pin_id | int | ID des verbundenen Anschlusses eines Objektes. | ab Version 1.0 |
...
cable.wire_pin.update
Beschreibung
Aktualisiert eine bestehende Ader zu einem Kabel.
Beispielaufruf
| Codeblock |
|---|
|
{
"method":"cable.wire_pin.update",
"params":{
"apikey":"24174j3tqj",
" |
...
id":4,
"data": {
"description":"Ader-Anschluss 1", |
...
"status_id":4
}
},
"version":"2.0",
"id": 1
} |
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|
wire_| id | int | ID des Datenbankeintrages | ab Version 1.0 |
| description | string | Beschreibung |
der | des Ader-Anschlusses | ab Version 1.0 |
colorstring Farbe der Ader0stateinstring eingehender Status der Aderzulässige Werte:
- H = hängend
- VH = vorbereitet, hängend
- R = reserviert
ab Version 1.0 | state_out | string | Optional: ausgehender Status der Ader
zulässige Werte:
H = hängendVH = vorbereitet, hängendR = reserviert| ID des verbundenen Anschlusses eines Objektes. | ab Version 1.0 |
Rückgabewert
| Wert | Typ | Version |
|---|
| current_date | string | ab Version 1.0 |
| id | int | ab Version 1.0 |
description_incoming| message | string | Optional: Bezeichnung eingehend | ab Version 1.0 |
| description_outgoing | string | Optional: Bezeichnung ausgehend | ab Version 1.0 |
classification | string | Optional: Leiter-Typ
...
cable.wire_pin.batch_reconnect_pins
Beschreibung
Verbindet eine Auswahl bestehender Adern mit neuen Objekt-Anschlüssen, während dabei bestehende Verbindungen, Strecken und Netzwege erhalten bleiben.
Beispielaufruf
| Codeblock |
|---|
|
{
"method":"cable.wire_pin.batch_reconnect_pins",
"params":{
"apikey":"24174j3tqj",
"data": {
"mapping": {
"1544801": "546665",
"1544807": "546671"
}
}
},
"version":"2.0",
"id": 1
} |
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|
| mapping | array | Mapping der neuen Ader-Verbindungen. Auf der linken Seite werden der IDs der Objekt-PINs angegeben. Auf der rechten Seite werden die IDs der Ader-Anschlüsse angegeben, welche auf die korrespondierenden Objekt-PINs umgezogen werden. Hinweis: Bestehende Verbindungen über die Adern bleiben bei der neuen Zuweisung erhalten. | 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 |