Anschluss-Status

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

Lesen eines speziellen Ader-Anschlusses:

{
	"method":"cable.wire_pin.read",
	"params":{
		"apikey":"24174j3tqj",
		"id": 4
	},
	"version":"2.0",
    "id": 1
}

Filtern von Ader-Anschlüssen:

{
	"method":"cable.wire_pin.read",
	"params":{
		"apikey":"24174j3tqj",
		"filter": {
			"wire_id": 123
		}
	},
	"version":"2.0",
    "id": 1
}

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

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: H = hängend VH = vorbereitet, hängend R = reserviert	ab Version 1.0
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

{
	"method":"cable.wire_pin.update",
	"params":{
		"apikey":"24174j3tqj",
		"id":4,
		"data": {
			"description":"Ader-Anschluss 1",
			"state":"H"
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version
id	int	ID des Datenbankeintrages	ab Version 1.0
description	string	Beschreibung des Ader-Anschlusses	ab Version 1.0
state	string	Optional: Status des Ader-Anschlüsses zulässige Werte: H = hängend VH = vorbereitet, hängend R = reserviert	ab Version 1.0
connected_pin_id	int	Optional: 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
message	string	ab Version 1.0