Geräte-Layout

Verwaltung von Geräte-Layouts.

Seitenverzeichnis:

patch.device_layout.read

Beschreibung

Gibt alle konfigurierten Geräte-Layouts zurück.

Beispielaufruf

Lesen eines speziellen Geräte-Layouts:

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

Filtern nach Geräte-Layouts:

{
	"method":"patch.device_layout.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 Geräte-Layouts

Der Filter unterstützt alle Eigenschaften des Geräte-Layouts (siehe Rückgabewerte).

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

ab Version 1.0

Rückgabewert

Eigenschaften eines Geräte-Layouts.

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
column_count	int	Anzahl der Spalten	ab Version 1.0
row_count	int	Anzahl der Zeilen	ab Version 1.0

patch.device_layout.create

Beschreibung

Legt ein neues Geräte-Layout an.

Beispielaufruf

{
	"method":"patch.device_layout.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
column_count	int	Anzahl der Spalten	ab Version 1.0
row_count	int	Anzahl der Zeilen	ab Version 1.0
description	string	Optional: Titel des Layouts	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.device_layout.update

Beschreibung

Aktualisiert ein bestehendes Geräte-Layout.

Beispielaufruf

{
	"method":"patch.device_layout.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
column_count	int	Anzahl der Spalten	ab Version 1.0
row_count	int	Anzahl der Zeilen	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.device_layout.delete

Beschreibung

Löscht ein bestehendes Geräte-Layout.

Beispielaufruf

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

Parameter

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