Versionen im Vergleich

Schlüssel

  • Diese Zeile wurde hinzugefügt.
  • Diese Zeile wurde entfernt.
  • Formatierung wurde geändert.

Verwaltung von Anschluss-LayoutsVorlagen.

Seitenverzeichnis:

Inhalt
maxLevel2
indent10px
stylesquare

...

patch.

...

connector_

...

template.read

Beschreibung

Gibt alle konfigurierten Anschluss-Layouts Vorlagen zurück.

Beispielaufruf

Lesen eines einer speziellen Anschluss-LayoutsVorlage:

Codeblock
languagebash
themeRDark
{
	"method":"patch.portconnector_layouttemplate.read",
	"params":{
		"apikey":"24174j3tqj",
		"id": 4
	},
	"version":"2.0",
    "id": 1
}

Filtern nach Anschluss-LayoutsVorlagen:

Codeblock
languagebash
themeRDark
{
	"method":"patch.portconnector_layouttemplate.read",
	"params":{
		"apikey":"24174j3tqj",
		"filter": {
			"title": "Port %"
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

ParameterTypBeschreibungVersion
idintOptional: ID des Datenbankeintragesab Version 1.0
filterarray

Optional: Filter für Anschluss-LayoutsVorlagen

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

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

ab Version 1.0

Rückgabewert

Eigenschaften eines einer Anschluss-LayoutsVorlage.

WertTypBeschreibungVersion
idintID des Datenbankeintragesab Version 1.0
devicegrid_layouttemplate_idintID des dazugehörigen Geräte-Layoutsder dazugehörigen Rahmen-Vorlageab Version 1.0
connector_titlestringName des Anschlussesab Version 1.0
connector_typeint

ID der Anschluss-Art

  • 1: eingehender Anschluss
  • 2: ausgehender Anschluss
ab Version 1.0
connector_type_idintID des zugewiesenen AnschlussesAnschluss-Typsab Version 1.0
titlestringTitel des Anschlussesab Version 1.0
numberint

Nummer des Anschlusses

ab Version 1.0
row_titlestringName der Port-Zeileab Version 1.0
pos_xintPosition horizontalab Version 1.0
pos_yintPosition vertikalab Version 1.0
label_orientationstringPosition der Beschriftung am Anschlussab Version 1.0
statusstringStatus des Anschlussesab Version 1.0
anglestring

Jeweilige Seite des Rahmens

  • F: Vorderseite
  • B: Rückseite
ab Version 1.0


...

patch.

...

connector_

...

template.create

Beschreibung

Legt ein neues eine neue Anschluss-Layout Vorlage an.

Beispielaufruf

Codeblock
languagebash
themeRDark
{
	"method":"patch.portconnector_layouttemplate.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

zugewiesenen Anschlusses
ParameterTypBeschreibungVersion
devicegrid_layouttemplate_idintID des dazugehörigen Geräte-Layoutsder dazugehörigen Rahmen-Vorlageab Version 1.0
connector_titlestringName des Anschlussesab Version 1.0
connector_typeint

ID der Anschluss-Art

Zulässige Werte:

  • 1: eingehender Anschluss
  • 2: ausgehender Anschluss
ab Version 1.0
connector_type_idintID des Anschluss-Typsab Version 1.0
pos_xintPosition horizontalab Version 1.0
pos_yintPosition vertikalab Version 1.0
titlestringOptional: Titel des Anschlussesab Version 1.0
numberint

Optional: Nummer des Anschlusses

ab Version 1.0
row_titlestringOptional: Name der Port-Zeileab Version 1.0
label_orientationstringOptional: Position der Beschriftung am Anschlussab Version 1.0
statusstringOptional: Status des Anschlussesab Version 1.0
anglestring

Jeweilige Seite des Rahmens

Zulässige Werte:

  • F: Vorderseite
  • B: Rückseite
ab Version 1.0

Rückgabewert

WertTypVersion
current_datestringab Version 1.0
idintab Version 1.0
messagestringab Version 1.0


...

patch.

...

connector_

...

template.update

Beschreibung

Aktualisiert ein bestehendes eine bestehende Anschluss-LayoutVorlage.

Beispielaufruf

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

Parameter

ParameterTypBeschreibungVersion
connector_titlestringName des Anschlussesab Version 1.0
connector_typeint

ID der Anschluss-Art

Zulässige Werte:

  • 1: eingehender Anschluss
  • 2: ausgehender Anschluss
ab Version 1.0
connector_type_idintID des Anschluss-Typsab Version 1.0
titlestringTitel des Anschlussesab Version 1.0
numberint

Nummer des Anschlusses

ab Version 1.0
row_titlestringName der Port-Zeileab Version 1.0
pos_xintPosition horizontalab Version 1.0
pos_yintPosition vertikalab Version 1.0
label_orientationstringPosition der Beschriftung am Anschlussab Version 1.0
statusstringStatus des Anschlussesab Version 1.0
anglestring

Jeweilige Seite des Rahmens

Zulässige Werte:

  • F: Vorderseite
  • B: Rückseite
ab Version 1.0

Rückgabewert

WertTypVersion
current_datestringab Version 1.0
idintab Version 1.0
messagestringab Version 1.0


...

patch.

...

connector_

...

template.delete

Beschreibung

Löscht ein bestehendes eine bestehende Anschluss-LayoutVorlage.

Beispielaufruf

Codeblock
languagebash
themeRDark
{
	"method":"patch.portconnector_layouttemplate.delete",
	"params":{
		"apikey":"24174j3tqj",
		"id":4
	},
	"version":"2.0",
    "id": 1
}

Parameter

ParameterTypBeschreibungVersion
idintID des der zu löschenden Anschluss-LayoutsVorlageab Version 1.0

Rückgabewert

WertTypVersion
current_datestringab Version 1.0
idintab Version 1.0
messagestringab Version 1.0

...