Verwaltung von Eigenschaften eines Kabels.
Seitenverzeichnis:
cable.cable.read
Beschreibung
Gibt die spezifische Eigenschaften eines Kabels zurück.
Beispielaufruf
{"method":"cable.cable.read","params":{"apikey":"24174j3tqj"},"id":1,"version":"2.0"}
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| obj_id | int | Optional: ID des Kabels, dessen Eigenschaften ausgegeben werden sollen | ab Version 1.0 |
Rückgabewert
Liste aller Eigenschaften 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 |
| state | string | Status des Kabels | ab Version 1.0 |
| group | string | Zugehörige Kabelgruppe | ab Version 1.0 |
| length | int | Länge des Kabels | ab Version 1.0 |
| capacity | int | Optional: Angabe zur Kabelauslastung in Prozent | ab Version 1.0 |
| usage | string | Optional:Verwendungszweck des Kabels | ab Version 1.0 |
cable.cable.create
Beschreibung
Legt neue Eigenschaften zu einem Kabel an.
Beispielaufruf
{"method":"cable.cable.create","params":{"apikey":"24174j3tqj","obj_id":19,"state":"verlegt","group":"50-adrig","length":100},"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.cable.update
Beschreibung
Aktualisiert bestehende Eigenschaften zu einem Kabel.
Beispielaufruf
{"method":"cable.pin.update","params":{"apikey":"24174j3tqj","cable_id":4,"state":"verlegt","group":"50-adrig","length":100},"id":1,"version":"2.0"}
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| cable_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 |
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.cable.delete
Beschreibung
Löscht die spezifischen Eigenschaften eines Kabels.
Beispielaufruf
{"method":"cable.pin.delete","params":{"apikey":"24174j3tqj","cable_id":4},"id":1,"version":"2.0"}
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| cable_id | int | ID des zu löschenden 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 |