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

ParameterTypBeschreibungVersion
rack_idintID des betreffenden Schrank-Objektesab Version 1.0
device_idint

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.

WertTypBeschreibungVersion
idintID des Schrankesab Version 1.0
titlestringTitel des Schrankesab Version 1.0
unitsint

Anzahl der Höheneinheiten

ab Version 1.0
has_half_hebooleanAngabe, ob der Schrank halbe Höheneinheiten benutzt oder nichtab Version 1.0
sortingstring

Angabe der Sortierreihenfolge

Mögliche Werte sind:

  • asc
  • desc
ab Version 1.0
devices_frontarrayAuflistung aller Objekte, welche von der Vorderseite eingebaut sindab Version 1.0
devices_backarrayAuflistung aller Objekte, welche von der Rückseite eingebaut sindab Version 1.0
vertical_slots_frontintAnzahl vertikaler Slots auf der Vorderseiteab Version 1.0
vertical_slots_backintAnzahl vertikaler Slots auf der Rückseiteab Version 1.0
print_urlstringURL zur Druckausgabe des Schrankes im Browserab 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

ParameterTypBeschreibungVersion
obj_idintID eines eingebauten Objektes.ab Version 1.0

Rückgabewert

WertTypBeschreibungVersion
devicearrayAuflistung von Stammdaten zum betreffenden Objektab Version 1.0
connectorsarrayAuflistung aller Anschlüsse des Objektesab 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

ParameterTypBeschreibungVersion
connector_idintID des Anschlussesab Version 1.0

Rückgabewert

WertTypBeschreibungVersion
connector_idintID des Anschlussesab Version 1.0
connector_titlestringTitel des Anschlussesab Version 1.0
connector_typeint

Einbau-Seite des Anschlusses

Mögliche Werte sind:

  • 1: Eingang
  • 2: Ausgang
ab Version 1.0
connector_type_idintID der Anschlussart des Anschlussesab Version 1.0
connector_type_titlestringTitel der Anschlussart des Anschlussesab Version 1.0
connector_statusintStatus des Anschlussesab Version 1.0
sibling_idintID des verbundenen Ein- bzw. Ausgangesab Version 1.0
urlstringURL zur Grafik des Anschlusses, sofern konfiguriertab Version 1.0
link_typestring

Typ des Links

Mögliche Werte sind:

  • null: kein verbundenes Objekt
  • link: verbunden mit einem Objekt vom Objekttyp "Patch-Panel"
  • dose: verbunden mit einem anderen Objekt
ab Version 1.0
patcharrayAuflistung von Informationen zum verbundenen Patchab Version 1.0
linkarrayAuflistung von Informationen zum verbundenen Linkab Version 1.0

(c) 2024 SHD System-Haus-Dresden GmbH | Impressum https://www.shd-online.de/impressum/