Verwaltung von Anschluss-LayoutsVorlagen.
Seitenverzeichnis:
Inhalt | ||||||
---|---|---|---|---|---|---|
|
...
patch.
...
connector_
...
template.read
Beschreibung
Gibt alle konfigurierten Anschluss-Layouts Vorlagen zurück.
Beispielaufruf
Lesen eines einer speziellen Anschluss-LayoutsVorlage:
Codeblock | ||||
---|---|---|---|---|
| ||||
{ "method":"patch.portconnector_layouttemplate.read", "params":{ "apikey":"24174j3tqj", "id": 4 }, "version":"2.0", "id": 1 } |
Filtern nach Anschluss-LayoutsVorlagen:
Codeblock | ||||
---|---|---|---|---|
| ||||
{ "method":"patch.portconnector_layouttemplate.read", "params":{ "apikey":"24174j3tqj", "filter": { "title": "Port %" } }, "version":"2.0", "id": 1 } |
Parameter
Parameter | Typ | Beschreibung | Version |
---|---|---|---|
id | int | Optional: ID des Datenbankeintrages | ab Version 1.0 |
filter | array | 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.
Wert | Typ | Beschreibung | Version |
---|---|---|---|
id | int | ID des Datenbankeintrages | ab Version 1.0 |
devicegrid_layouttemplate_id | int | ID des dazugehörigen Geräte-Layoutsder 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
| ab Version 1.0 |
connector_type_id | int | ID des zugewiesenen AnschlussesAnschluss-Typs | 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
| ab Version 1.0 |
...
patch.
...
connector_
...
template.create
Beschreibung
Legt ein neues eine neue Anschluss-Layout Vorlage an.
Beispielaufruf
Codeblock | ||||
---|---|---|---|---|
| ||||
{ "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
Parameter | Typ | Beschreibung | Version | |
---|---|---|---|---|
devicegrid_layouttemplate_id | int | ID des dazugehörigen Geräte-Layoutsder 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:
| ab Version 1.0 | |
connector_type_id | int | ID des | zugewiesenen AnschlussesAnschluss-Typs | 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:
| 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 ein bestehendes eine bestehende Anschluss-LayoutVorlage.
Beispielaufruf
Codeblock | ||||
---|---|---|---|---|
| ||||
{ "method":"patch.portconnector_layouttemplate.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:
| ab Version 1.0 |
connector_type_id | int | ID des Anschluss-Typs | 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:
| 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 ein bestehendes eine bestehende Anschluss-LayoutVorlage.
Beispielaufruf
Codeblock | ||||
---|---|---|---|---|
| ||||
{ "method":"patch.portconnector_layouttemplate.delete", "params":{ "apikey":"24174j3tqj", "id":4 }, "version":"2.0", "id": 1 } |
Parameter
Parameter | Typ | Beschreibung | Version |
---|---|---|---|
id | int | ID des der zu löschenden Anschluss-LayoutsVorlage | 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 |
...