Verwaltung von Anschlüssen an einem beliebigen Objekt.
Seitenverzeichnis:
| Inhalt | ||||||
|---|---|---|---|---|---|---|
|
...
cable.pin.read
Beschreibung
Gibt alle konfigurierten Anschlüsse eines Objektes zurück.
Beispielaufruf
{"method":"cable.pin.read","params":{"apikey":"24174j3tqj"},"id":1,"version":"2.0"}
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| obj_id | int | Optional: ID des Objektes, dessen Anschluss ausgegeben werden sollen | ab Version 1.0 |
Rückgabewert
Liste aller Anschlüsse zum angegebenen Objekt.
| Wert | Typ | Beschreibung | Version |
|---|---|---|---|
| id | int | ID des Datenbankeintrages | ab Version 1.0 |
| isys_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 |
...
cable.pin.create
Beschreibung
Legt einen neuen Anschluss an.
Beispielaufruf
{"method":"cable.pin.create","params":{"apikey":"24174j3tqj","obj_id":19,"description":"Anschluss 1","number":1,"type":"in"},"id":1,"version":"2.0"}
Parameter
| 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 |
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.pin.update
Beschreibung
Aktualisiert einen bestehenden Anschluss.
Beispielaufruf
{"method":"cable.pin.update","params":{"apikey":"24174j3tqj","pin_id":4,"description":"Anschluss 1","number":1,"type":"in"},"id":1,"version":"2.0"}
Parameter
Rückgabewert
...
cable.pin.delete
Beschreibung
Löscht einen bestehenden Anschluss.
Beispielaufruf
{"method":"cable.pin.delete","params":{"apikey":"24174j3tqj","pin_id":4},"id":1,"version":"2.0"}