Patch-Editor
Abfrage von Informationen des Patch-Editors.
Seitenverzeichnis:
patch.patch_editor.get_rack
Beschreibung
Gibt alle Informationen zu einem Schrank aus.
Beispielaufruf
{ "method":"patch.patch_editor.get_rack", "params":{ "apikey":"24174j3tqj", "rack_id": 80338 }, "version":"2.0", "id": 1 }
Parameter
Parameter | Typ | Beschreibung | Version |
---|---|---|---|
rack_id | int | ID des betreffenden Schrank-Objektes | ab Version 1.0 |
device_id | int | Optional: ID eines eingebauten Objektes Wurde keine rack_id angegeben wird versucht auf Basis der device_id den Schrank zu ermitteln, in dem das Objekt eingebaut wurde. | ab Version 1.0 |
Rückgabewert
Eigenschaften einer Rahmen-Vorlage.
Wert | Typ | Beschreibung | Version |
---|---|---|---|
id | int | ID des Schrankes | ab Version 1.0 |
title | string | Titel des Schrankes | ab Version 1.0 |
units | int | Anzahl der Höheneinheiten | ab Version 1.0 |
has_half_he | boolean | Angabe, ob der Schrank halbe Höheneinheiten benutzt oder nicht | ab Version 1.0 |
sorting | string | Angabe der Sortierreihenfolge Mögliche Werte sind:
| ab Version 1.0 |
devices_front | array | Auflistung aller Objekte, welche von der Vorderseite eingebaut sind | ab Version 1.0 |
devices_back | array | Auflistung aller Objekte, welche von der Rückseite eingebaut sind | ab Version 1.0 |
vertical_slots_front | int | Anzahl vertikaler Slots auf der Vorderseite | ab Version 1.0 |
vertical_slots_back | int | Anzahl vertikaler Slots auf der Rückseite | ab Version 1.0 |
print_url | string | URL zur Druckausgabe des Schrankes im Browser | ab Version 1.0 |
patch.patch_editor.get_grid
Beschreibung
Gibt alle Informationen zu einem im Schrank eingebauten Objekt aus.
Beispielaufruf
{ "method":"patch.patch_editor.get_grid", "params":{ "apikey":"24174j3tqj", "obj_id": 80432 }, "version":"2.0", "id": 1 }
Parameter
Parameter | Typ | Beschreibung | Version |
---|---|---|---|
obj_id | int | ID eines eingebauten Objektes. | ab Version 1.0 |
Rückgabewert
Wert | Typ | Beschreibung | Version |
---|---|---|---|
device | array | Auflistung von Stammdaten zum betreffenden Objekt | ab Version 1.0 |
connectors | array | Auflistung aller Anschlüsse des Objektes | ab Version 1.0 |
patch.patch_editor.get_connector
Beschreibung
Gibt alle Informationen zu einem Anschluss eines Objektes im Schrank aus.
Beispielaufruf
{ "method":"patch.patch_editor.get_connector", "params":{ "apikey":"24174j3tqj", "connector_id": 1 }, "version":"2.0", "id": 1 }
Parameter
Parameter | Typ | Beschreibung | Version |
---|---|---|---|
connector_id | int | ID des Anschlusses | ab Version 1.0 |
Rückgabewert
Wert | Typ | Beschreibung | Version |
---|---|---|---|
connector_id | int | ID des Anschlusses | ab Version 1.0 |
connector_title | string | Titel des Anschlusses | ab Version 1.0 |
connector_type | int | Einbau-Seite des Anschlusses Mögliche Werte sind:
| ab Version 1.0 |
connector_type_id | int | ID der Anschlussart des Anschlusses | ab Version 1.0 |
connector_type_title | string | Titel der Anschlussart des Anschlusses | ab Version 1.0 |
connector_status | int | Status des Anschlusses | ab Version 1.0 |
sibling_id | int | ID des verbundenen Ein- bzw. Ausganges | ab Version 1.0 |
url | string | URL zur Grafik des Anschlusses, sofern konfiguriert | ab Version 1.0 |
link_type | string | Typ des Links Mögliche Werte sind:
| ab Version 1.0 |
patch | array | Auflistung von Informationen zum verbundenen Patch | ab Version 1.0 |
link | array | Auflistung von Informationen zum verbundenen Link | ab Version 1.0 |
(c) 2024 SHD System-Haus-Dresden GmbH | Impressum https://www.shd-online.de/impressum/