Zum Ende der Metadaten springen
Zum Anfang der Metadaten

You are viewing an old version of this content. View the current version.

Unterschiede anzeigen View Version History

Version 1 Nächste Version anzeigen »

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

ParameterTypBeschreibungVersion
filterarray

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.

WertTypBeschreibungVersion
idintID des Datenbankeintragesab Version 1.0
wire_idintID der referenzierten Aderab Version 1.0
descriptionstringBeschreibung des Ader-Anschlussesab Version 1.0
statestring

Status des Ader-Anschlüsses

zulässige Werte:

  • H = hängend
  • VH = vorbereitet, hängend
  • R = reserviert
ab Version 1.0
sibling_idint

ID des dazugehörigen zweiten Ader-Anschlusses

Hinweis: Ist die sibling_id kleiner der ID des Ader-Anschlusses

ab Version 1.0
connected_pin_idstring

ausgehender Status der Ader

zulässige Werte:

  • H = hängend
  • VH = vorbereitet, hängend
  • R = reserviert
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

ParameterTypBeschreibungVersion
wire_idintID des Datenbankeintragesab Version 1.0
descriptionstringBeschreibung der Aderab Version 1.0
colorstringOptional: Farbe der Aderab Version 1.0
state_instring

Optional: eingehender Status der Ader

zulässige Werte:

  • H = hängend
  • VH = vorbereitet, hängend
  • R = reserviert
ab Version 1.0
state_outstring

Optional: ausgehender Status der Ader

zulässige Werte:

  • H = hängend
  • VH = vorbereitet, hängend
  • R = reserviert
ab Version 1.0
description_incomingstringOptional: Bezeichnung eingehendab Version 1.0
description_outgoingstringOptional: Bezeichnung ausgehendab Version 1.0
classificationstringOptional: Leiter-Typab Version 1.0

Rückgabewert

WertTypVersion
current_datestringab Version 1.0
idintab Version 1.0
messagestringab Version 1.0
  • Keine Stichwörter