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

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: asc desc	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

Legt eine neue Rahmen-Vorlage an.

Beispielaufruf

{
	"method":"patch.grid_template.create",
	"params":{
		"apikey":"24174j3tqj",
		"data": {
			"title":"Panel 1",
			"column_count": 4,
            "row_count": 1
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version
title	string	Titel der Vorlage	ab Version 1.0
column_count	int	Anzahl der Spalten	ab Version 1.0
row_count	int	Anzahl der Zeilen	ab Version 1.0
version	string	Optional: Version der Rahmen-Vorlage	ab Version 1.0
is_template	int	Optional: Flag, ob dieses Element als Vorlage für mehrere Rahmen dienen kann. Zulässige Werte: 0: keine Vorlage für weitere Rahmen 1: Vorlage für weitere Rahmen	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

patch.patch_editor.get_connector

Beschreibung

Aktualisiert eine bestehende Rahmen-Vorlage.

Beispielaufruf

{
	"method":"patch.grid_template.update",
	"params":{
		"apikey":"24174j3tqj",
		"id":4,
		"data": {
			"title":"Panel 2",
			"column_count": 8
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version
id	int	ID des Datenbankeintrages	ab Version 1.0
title	string	Titel der Vorlage	ab Version 1.0
column_count	int	Anzahl der Spalten	ab Version 1.0
row_count	int	Anzahl der Zeilen	ab Version 1.0
version	string	Version der Rahmen-Vorlage	ab Version 1.0
is_template	int	Optional: Flag, ob dieses Element als Vorlage für mehrere Rahmen dienen kann. Zulässige Werte: 0: keine Vorlage für weitere Rahmen 1: Vorlage für weitere Rahmen	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