Verwaltung von Rahmen-Vorlagen.
Seitenverzeichnis:
patch.grid_template.read
Beschreibung
Gibt alle konfigurierten Rahmen-Vorlagen zurück.
Beispielaufruf
Lesen einer speziellen Rahmen-Vorlage:
{
"method":"patch.grid_template.read",
"params":{
"apikey":"24174j3tqj",
"id": 4
},
"version":"2.0",
"id": 1
}
Filtern nach Rahmen-Vorlagen:
{
"method":"patch.grid_template.read",
"params":{
"apikey":"24174j3tqj",
"filter": {
"title": "Patchpanel %"
}
},
"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 Rahmen-Vorlagen Der Filter unterstützt alle Eigenschaften der Rahmen-Vorlage (siehe Rückgabewerte). Als Suchkriterium kann das Prozent-Zeichen "%" als Wildcard verwendet werden. | ab Version 1.0 |
Rückgabewert
Eigenschaften einer Rahmen-Vorlage.
| Wert | Typ | Beschreibung | Version |
|---|---|---|---|
| id | int | ID des Datenbankeintrages | ab Version 1.0 |
| title | string | Titel der Vorlage | ab Version 1.0 |
| column_count | int | Anzahl der Spalten | ab Version 1.0 |
| row_count | int | Anzahl der Zeilen | ab Version 1.0 |
| version | string | Version der Rahmen-Vorlage | ab Version 1.0 |
| is_template | int | Flag, ob dieses Element als Vorlage für mehrere Rahmen dienen kann. | ab Version 1.0 |
patch.grid_template.create
Beschreibung
Legt eine neue Rahmen-Vorlage an.
Beispielaufruf
{
"method":"patch.grid_template.create",
"params":{
"apikey":"24174j3tqj",
"data": {
"title":"Panel 1",
"column_count": 4,
"row_count": 1
}
},
"version":"2.0",
"id": 1
}
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| title | string | Titel der Vorlage | ab Version 1.0 |
| column_count | int | Anzahl der Spalten | ab Version 1.0 |
| row_count | int | Anzahl der Zeilen | ab Version 1.0 |
| version | string | Optional: Version der Rahmen-Vorlage | ab Version 1.0 |
| is_template | int | Optional: Flag, ob dieses Element als Vorlage für mehrere Rahmen dienen kann. 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.grid_template.update
Beschreibung
Aktualisiert eine bestehende Rahmen-Vorlage.
Beispielaufruf
{
"method":"patch.grid_template.update",
"params":{
"apikey":"24174j3tqj",
"id":4,
"data": {
"title":"Panel 2",
"column_count": 8
}
},
"version":"2.0",
"id": 1
}
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| id | int | ID des Datenbankeintrages | ab Version 1.0 |
| title | string | Titel der Vorlage | ab Version 1.0 |
| column_count | int | Anzahl der Spalten | ab Version 1.0 |
| row_count | int | Anzahl der Zeilen | ab Version 1.0 |
| version | string | Version der Rahmen-Vorlage | ab Version 1.0 |
| is_template | int | Optional: Flag, ob dieses Element als Vorlage für mehrere Rahmen dienen kann. 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.grid_template.delete
Beschreibung
Löscht eine bestehende Rahmen-Vorlage.
Beispielaufruf
{
"method":"patch.grid_template.delete",
"params":{
"apikey":"24174j3tqj",
"id":4
},
"version":"2.0",
"id": 1
}
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| id | int | ID der zu löschenden Rahmen-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 |