Anschluss-Vorlage

Verwaltung von Anschluss-Vorlagen.

Seitenverzeichnis:

patch.connector_template.read

Beschreibung

Gibt alle konfigurierten Anschluss-Vorlagen zurück.

Beispielaufruf

Lesen einer speziellen Anschluss-Vorlage:

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

Filtern nach Anschluss-Vorlagen:

{
	"method":"patch.connector_template.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-Vorlagen

Der Filter unterstützt alle Eigenschaften der Anschluss-Vorlage (siehe Rückgabewerte).

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

ab Version 1.0

Rückgabewert

Eigenschaften einer Anschluss-Vorlage.

Wert	Typ	Beschreibung	Version
id	int	ID des Datenbankeintrages	ab Version 1.0
grid_template_id	int	ID der dazugehörigen Rahmen-Vorlage	ab Version 1.0
connector_title	string	Name des Anschlusses	ab Version 1.0
connector_type	int	ID der Anschluss-Art 1: eingehender Anschluss 2: ausgehender Anschluss	ab Version 1.0
connector_type_id	int	ID des Anschluss-Typs (siehe Hinweis am Ende dieses Abschnittes)	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
angle	string	Jeweilige Seite des Rahmens F: Vorderseite B: Rückseite	ab Version 1.0

Hinweis: Die verfügbaren Anschluss-Typen können über folgende Abfrage ermittelt werden:

{
	"method":"cmdb.dialog.read",
	"params":{
		"apikey":"24174j3tqj",
		"category":"C__CATG__CONNECTOR",
		"property":"connection_type"
	},
	"version":"2.0",
    "id": 1
}

patch.connector_template.create

Beschreibung

Legt eine neue Anschluss-Vorlage an.

Beispielaufruf

{
	"method":"patch.connector_template.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
grid_template_id	int	ID der dazugehörigen Rahmen-Vorlage	ab Version 1.0
connector_title	string	Name des Anschlusses	ab Version 1.0
connector_type	int	ID der Anschluss-Art Zulässige Werte: 1: eingehender Anschluss 2: ausgehender Anschluss	ab Version 1.0
connector_type_id	int	ID des Anschluss-Typs (siehe Hinweis am Ende des ersten Abschnittes)	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
angle	string	Jeweilige Seite des Rahmens Zulässige Werte: F: Vorderseite B: Rückseite	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.connector_template.update

Beschreibung

Aktualisiert eine bestehende Anschluss-Vorlage.

Beispielaufruf

{
	"method":"patch.connector_template.update",
	"params":{
		"apikey":"24174j3tqj",
		"id":4,
		"data": {
			"title":"Port Nr. 1",
			"pos_x": 1
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version
connector_title	string	Name des Anschlusses	ab Version 1.0
connector_type	int	ID der Anschluss-Art Zulässige Werte: 1: eingehender Anschluss 2: ausgehender Anschluss	ab Version 1.0
connector_type_id	int	ID des Anschluss-Typs (siehe Hinweis am Ende des ersten Abschnittes)	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
angle	string	Jeweilige Seite des Rahmens Zulässige Werte: F: Vorderseite B: Rückseite	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.connector_template.delete

Beschreibung

Löscht eine bestehende Anschluss-Vorlage.

Beispielaufruf

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

Parameter

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