Anschluss-Layout

Verwaltung von Anschluss-Layouts.

Seitenverzeichnis:

patch.port_layout.read

Beschreibung

Gibt alle konfigurierten Anschluss-Layouts zurück.

Beispielaufruf

Lesen eines speziellen Anschluss-Layouts:

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

Filtern nach Anschluss-Layouts:

{
	"method":"patch.port_layout.read",
	"params":{
		"apikey":"24174j3tqj",
		"filter": {
			"title": "Port %"
		}
	},
	"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 Anschluss-Layouts

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

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

ab Version 1.0

Rückgabewert

Eigenschaften eines Anschluss-Layouts.

Wert	Typ	Beschreibung	Version
id	int	ID des Datenbankeintrages	ab Version 1.0
device_layout_id	int	ID des dazugehörigen Geräte-Layouts	ab Version 1.0
connector_id	int	ID des zugewiesenen Anschlusses	ab Version 1.0
title	string	Titel des Anschlusses	ab Version 1.0
number	int	Nummer des Anschlusses	ab Version 1.0
row_title	string	Name der Port-Zeile	ab Version 1.0
pos_x	int	Position horizontal	ab Version 1.0
pos_y	int	Position vertikal	ab Version 1.0
label_orientation	string	Position der Beschriftung am Anschluss	ab Version 1.0
status	string	Status des Anschlusses	ab Version 1.0

patch.port_layout.create

Beschreibung

Legt ein neues Anschluss-Layout an.

Beispielaufruf

{
	"method":"patch.port_layout.create",
	"params":{
		"apikey":"24174j3tqj",
		"data": {
			"device_layout_id": 4,
            "connector_id": 14,
			"pos_x": 4,
            "pos_y": 1,
            "title": "Port 1"
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version
device_layout_id	int	ID des dazugehörigen Geräte-Layouts	ab Version 1.0
connector_id	int	ID des zugewiesenen Anschlusses	ab Version 1.0
pos_x	int	Position horizontal	ab Version 1.0
pos_y	int	Position vertikal	ab Version 1.0
title	string	Optional: Titel des Anschlusses	ab Version 1.0
number	int	Optional: Nummer des Anschlusses	ab Version 1.0
row_title	string	Optional: Name der Port-Zeile	ab Version 1.0
label_orientation	string	Optional: Position der Beschriftung am Anschluss	ab Version 1.0
status	string	Optional: Status des Anschlusses	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.port_layout.update

Beschreibung

Aktualisiert ein bestehendes Anschluss-Layout.

Beispielaufruf

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

Parameter

Parameter	Typ	Beschreibung	Version
title	string	Titel des Anschlusses	ab Version 1.0
number	int	Nummer des Anschlusses	ab Version 1.0
row_title	string	Name der Port-Zeile	ab Version 1.0
pos_x	int	Position horizontal	ab Version 1.0
pos_y	int	Position vertikal	ab Version 1.0
label_orientation	string	Position der Beschriftung am Anschluss	ab Version 1.0
status	string	Status des Anschlusses	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.port_layout.delete

Beschreibung

Löscht ein bestehendes Anschluss-Layout.

Beispielaufruf

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

Parameter

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