Anschluss-Status

Verwaltung von Anschluss-Status einer Ader.

Seitenverzeichnis:

cable.wire_pin_status.read

Beschreibung

Gibt die Anschluss-Status zurück.

Beispielaufruf

Lesen eines speziellen Anschluss-Status:

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

Filtern von Ader-Anschlüssen:

{
	"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 Anschluss-Status

Der Filter unterstützt alle Eigenschaften des Anschluss-Status (siehe Rückgabewerte).

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

ab Version 1.0

Rückgabewert

Liste aller Anschluss-Status.

Wert	Typ	Beschreibung	Version
id	int	ID des Datenbankeintrages	ab Version 1.0
const	int	Konstante des Anschluss-Status	ab Version 1.0
description	string	Beschreibung des Anschluss-Status	ab Version 1.0
obj_id	int	ID des zugewiesenen Bildes	ab Version 1.0
color	string	Hexadezimaler Wert der Farbe des Anschluss-Status	ab Version 1.0
upper_transition_damping	float	Obere Übergangsdämpfung	ab Version 1.0

cable.wire_pin_status.create

Beschreibung

Erstellt einen Anschluss-Status.

Beispielaufruf

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

Parameter

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	Optional: Beschreibung des Anschluss-Status	ab Version 1.0
obj_id	int	Optional: ID des zugewiesenen Bildes	ab Version 1.0
color	string	Optional: Hexadezimaler Wert der Farbe des Anschluss-Status	ab Version 1.0
upper_transition_damping	float	Optional: Obere Übergangsdämpfung	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

cable.wire_pin_status.update

Beschreibung

Aktualisiert einen bestehenden Anschluss-Status.

Beispielaufruf

{
	"method":"cable.wire_pin_status.update",
	"params":{
		"apikey":"24174j3tqj",
		"id":4,
		"data": {
			"const": "H"
			"description": "hängend",
			"obj_id": 1234,
            "color": "00CC12",
			"upper_transition_damping": 0.4
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

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 Anschluss-Status	ab Version 1.0
obj_id	int	ID des zugewiesenen Bildes	ab Version 1.0
color	string	Hexadezimaler Wert der Farbe des Anschluss-Status	ab Version 1.0
upper_transition_damping	float	Obere Übergangsdämpfung	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

cable.wire_pin_status.delete

Beschreibung

Löscht einen bestehenden Anschluss-Status.

Beispielaufruf

{
	"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