Anschluss

Verwaltung von Anschlüssen an einem beliebigen Objekt.

cable.pin.read

Gibt alle konfigurierten Anschlüsse eines Objektes zurück.

{"method":"cable.pin.read","params":{"apikey":"24174j3tqj", filter: {"description": "PIN %"}},"obj_"version":"2.0"}

Typ

Beschreibung

Version

filter

array

Optional: Filter für Anschlüsse

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

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

ab Version 1.0

Liste aller Anschlüsse zum angegebenen Objekt.

Wert	Typ	Beschreibung	Version
id	int	ID des Datenbankeintrages	ab Version 1.0
obj_id	int	ID des referenzierten Kabels	ab Version 1.0
description	string	Beschreibung des Anschlusses	ab Version 1.0
number	int	Nummer des Anschlusses	ab Version 1.0
type	string	Typ des Anschlusses (zulässige Werte: "in" oder "out")	ab Version 1.0
internal_pin_id	int	Optional: Referenz auf einen anderen Anschluss, mit welchem dieser Anschluss intern verbunden ist (bspw. wenn ein Eingang mit einem Ausgang eines Gerätes verbunden ist)	ab Version 1.0
patch_pin_id	int	Optional: Referenz auf einen anderen Anschluss, mit welchem dieser Anschluss über einen Patch verbunden ist (bspw. wenn Verbindungen an einem Gerät per Patch verbunden sind)	ab Version 1.0
classification	string	Anschluss-Typ	ab Version 1.0

Legt einen neuen Anschluss an.

{"method":"cable.pin.create","params":{"apikey":"24174j3tqj","obj_id":19,"description":"Anschluss 1","number":1,"type":"in"},"id":1,"version":"2.0"}

Parameter	Typ	Beschreibung	Version
obj_id	int	ID des referenzierten Kabels	ab Version 1.0
description	string	Beschreibung des Anschlusses	ab Version 1.0
number	int	Nummer des Anschlusses	ab Version 1.0
type	string	Typ des Anschlusses (zulässige Werte: "in" oder "out")	ab Version 1.0
internal_pin_id	int	Optional: Referenz auf einen anderen Anschluss, mit welchem dieser Anschluss intern verbunden ist (bspw. wenn ein Eingang mit einem Ausgang eines Gerätes verbunden ist)	ab Version 1.0
patch_pin_id	int	Optional: Referenz auf einen anderen Anschluss, mit welchem dieser Anschluss über einen Patch verbunden ist (bspw. wenn Verbindungen an einem Gerät per Patch verbunden sind)	ab Version 1.0

Aktualisiert einen bestehenden Anschluss.

{"method":"cable.pin.update","params":{"apikey":"24174j3tqj","pin_id":4,"description":"Anschluss 1","number":1,"type":"in"},"id":1,"version":"2.0"}

Parameter	Typ	Beschreibung	Version
pin_id	int	ID des Datenbankeintrages	ab Version 1.0
description	string	Beschreibung des Anschlusses	ab Version 1.0
number	int	Nummer des Anschlusses	ab Version 1.0
type	string	Typ des Anschlusses (zulässige Werte: "in" oder "out")	ab Version 1.0
internal_pin_id	int	Optional: Referenz auf einen anderen Anschluss, mit welchem dieser Anschluss intern verbunden ist (bspw. wenn ein Eingang mit einem Ausgang eines Gerätes verbunden ist)	ab Version 1.0
patch_pin_id	int	Optional: Referenz auf einen anderen Anschluss, mit welchem dieser Anschluss über einen Patch verbunden ist (bspw. wenn Verbindungen an einem Gerät per Patch verbunden sind)	ab Version 1.0

Löscht einen bestehenden Anschluss.

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

Parameter	Typ	Beschreibung	Version
pin_id	int	ID des zu löschenden Anschlusses	ab Version 1.0