Rahmen-Zuweisung

Zuweisung von Rahmen-Vorlagen zur Kategorie an einem Objekt.

Seitenverzeichnis:

patch.grid.read

Beschreibung

Gibt alle konfigurierten Rahmen zurück.

Beispielaufruf

Lesen eines speziellen Rahmens:

{
	"method":"patch.grid.read",
	"params":{
		"apikey":"24174j3tqj",
		"id": 4
	},
	"version":"2.0",
    "id": 1
}

Filtern nach Rahmen:

{
	"method":"patch.grid.read",
	"params":{
		"apikey":"24174j3tqj",
		"filter": {
			"description": "Patchpanel %"
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

Typ

Beschreibung

Version

id

int

Optional: ID des Datenbankeintrages

ab Version 1.0

filter

array

Optional: Filter für Rahmen

Der Filter unterstützt alle Eigenschaften des Rahmens (siehe Rückgabewerte).

Als Suchkriterium kann das Prozent-Zeichen "%" als Wildcard verwendet werden.

ab Version 1.0

Rückgabewert

Eigenschaften eines Rahmens.

Wert	Typ	Beschreibung	Version
id	int	ID des Datenbankeintrages	ab Version 1.0
obj_id	int	ID des referenzierten Gerätes / Objektes	ab Version 1.0
description	string	Titel des Layouts	ab Version 1.0
grid_template_id	int	ID der referenzierten Rahmen-Vorlage	ab Version 1.0

patch.grid.list_connectors

Beschreibung

Listet alle dem Gerät / Objekt zugewiesenen Anschlüsse auf.

Beispielaufruf

{
	"method":"patch.grid.list_connectors",
	"params":{
		"apikey":"24174j3tqj",
		"data": {
			"obj_id":19
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version
obj_id	int	ID des referenzierten Gerätes / Objektes	ab Version 1.0

Rückgabewert

Liste aller konfigurierten Anschlüsse.

Wert	Typ	Beschreibung	Version
id	int	ID des Anschlusses	ab Version 1.0
title	string	Name des Anschlusses	ab Version 1.0
type	int	ID des Anschluss-Typs	ab Version 1.0
url	string	URL zum zugewiesenen Bild des Anschlusses, falls konfiguriert	ab Version 1.0

patch.grid.create

Beschreibung

Legt einen neuen Rahmen an.

Beispielaufruf

{
	"method":"patch.grid.create",
	"params":{
		"apikey":"24174j3tqj",
		"data": {
			"obj_id":19,
			"description":"Panel Layout 1",
			"column_count": 4,
            "row_count": 1
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version
obj_id	int	ID des referenzierten Objektes	ab Version 1.0
description	string	Optional: Titel des Layouts	ab Version 1.0
grid_template_id	int	Optional: ID der referenzierten Rahmen-Vorlage	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.grid.update

Beschreibung

Aktualisiert einen bestehenden Rahmen.

Beispielaufruf

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

Parameter

Parameter	Typ	Beschreibung	Version
id	int	ID des Datenbankeintrages	ab Version 1.0
description	string	Titel des Layouts	ab Version 1.0
grid_template_id	int	ID der referenzierten Rahmen-Vorlage	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.grid.delete

Beschreibung

Löscht einen bestehenden Rahmen.

Beispielaufruf

{
	"method":"patch.grid.delete",
	"params":{
		"apikey":"24174j3tqj",
		"id":4
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version
id	int	ID des zu löschenden Rahmens	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