Seitenvergleich

Verwaltung von Anschlüssen Anschluss-Status 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:

Inhalt

maxLevel	2
indent	10px
style	square

...

cable.wire_pin_status.read

Beschreibung

Gibt die Anschlüsse einer Ader die Anschluss-Status zurück.

Beispielaufruf

Lesen eines speziellen AderAnschluss-AnschlussesStatus:

Codeblock

language	bash
theme	RDark

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

...

Codeblock

language	bash
theme	RDark

{
	"method":"cable.wire_pin_status.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 AderAnschluss-AnschlüsseStatus

Der Filter unterstützt alle Eigenschaften der Aderdes Anschluss-Anschlüsse Status (siehe Rückgabewerte).

Als Suchkriterium kann das Prozent-Zeichen "%" als Wildcard verwendet werden.

ab Version 1.0

Rückgabewert

Liste aller Adern zum angegebenen KabelAnschluss-Status.

Status des Ader-Anschlüsses

zulässige Werte:

H = hängend

VH = vorbereitet, hängend

R = reserviert

Wert	Typ	Beschreibung	Version
id	int	ID des Datenbankeintrages	ab Version 1.0
wire_idconst	intID der referenzierten Ader	Konstante des Anschluss-Status	ab Version 1.0
description	string	Beschreibung des AderAnschluss-AnschlussesStatus	ab Version 1.0	state	string

...

cable.wire_pin_status.create

Beschreibung

Erstellt einen Anschluss-Status.

Beispielaufruf

Codeblock

language	bash
theme	RDark

{
	"method":"cable.wire_pin_status.create",
	"params":{
		"apikey":"24174j3tqj",
		"data": {
			"const": "H"
			"description": "hängend"
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version
id	int	ID des Datenbankeintrages	ab Version 1.0
sibling_idconst	intstring	ID Konstante des dazugehörigen zweiten Ader-AnschlussesHinweis: Ist die sibling_id größer der ID des Ader-Anschlusses, handelt es sich bei diesem Anschluss um den Eingang bzw. die "linke Seite"Anschluss-Status	ab Version 1.0
description	string	Optional: Beschreibung des Anschluss-Status	ab Version 1.0

Rückgabewert

Wert	Typ	Version
current_date	string	ab Version 1.0

connected_pin_

id

int

ID des verbundenen Anschlusses eines Objektes.

ab Version 1.0
message	string	ab Version 1.0

...

cable.wire_pin_status.update

Beschreibung

Aktualisiert eine bestehende Ader zu einem Kabeleinen bestehenden Anschluss-Status.

Beispielaufruf

Codeblock

language	bash
theme	RDark

{
	"method":"cable.wire_pin_status.update",
	"params":{
		"apikey":"24174j3tqj",
		"id":4,
		"data": {
			"descriptionconst": "Ader-Anschluss 1H",
			"statedescription": "Hhängend"
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

state

Parameter	Typ	Beschreibung	Version
id	int	ID des Datenbankeintrages	ab Version 1.0
const	string	Konstante des Anschluss-Status	ab Version 1.0
description	string	Beschreibung des AderAnschluss-AnschlussesStatus	ab Version 1.0

Rückgabewert

Wert	Typ	Version
current_date	string

Optional: Status des Ader-Anschlüsses

zulässige Werte:

H = hängend

VH = vorbereitet, hängend

R = reserviert

	ab Version 1.0
id	int	ab Version 1.0
message	string	ab Version 1.0

connected_pin_idintOptional: ID des verbundenen Anschlusses eines Objektes.

...

cable.wire_pin_status.delete

Beschreibung

Löscht einen bestehenden Anschluss-Status.

Beispielaufruf

Codeblock

language	bash
theme	RDark

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

Parameter

Parameter	Typ	Beschreibung	Version
id	int	ID des Datenbankeintrages	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

...

Versionen im Vergleich

Alte Version 1

Neue Version 2

Schlüssel

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_status.read

Beschreibung

Beispielaufruf

Rückgabewert

cable.wire_pin_status.create

Beschreibung

Beispielaufruf

Parameter

Rückgabewert

cable.wire_pin_status.update

Beschreibung

Beispielaufruf

Parameter

Rückgabewert

cable.wire_pin_status.delete

Beschreibung

Beispielaufruf

Parameter

Rückgabewert