Verwaltung von Patch Formfaktor.
Seitenverzeichnis:
patch.formfactor.read
Beschreibung
Gibt alle konfigurierten Formfaktoren zurück.
Beispielaufruf
Lesen eines speziellen Formfaktors:
{
"method":"patch.formfactor.read",
"params":{
"apikey":"24174j3tqj",
"id": 4
},
"version":"2.0"
}
Filtern nach Formfaktoren:
{
"method":"patch.formfactor.read",
"params":{
"apikey":"24174j3tqj",
"filter": {
"obj_id": 2
}
},
"version":"2.0"
}
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| id | int | Optional: ID des Datenbankeintrages | ab Version 1.0 |
| filter | array | Optional: Filter für Reports Der Filter unterstützt alle Eigenschaften des Reports (siehe Rückgabewerte). Als Suchkriterium kann das Prozent-Zeichen "%" als Wildcard verwendet werden. | ab Version 1.0 |
Rückgabewert
Eigenschaften eines Formfaktors.
| Wert | Typ | Beschreibung | Version |
|---|---|---|---|
| id | int | ID des Datenbankeintrages | ab Version 1.0 |
| obj_id | int | ID des referenzierten Objektes | ab Version 1.0 |
| title | string | Titel des Reports | ab Version 1.0 |
| default_template | string | Standard-Vorlage des Reports | ab Version 1.0 |
| query | string | SQL-Abfrage des Reports | ab Version 1.0 |
patch.formfactor.create
Beschreibung
Legt einen neuen Formfaktor an.
Beispielaufruf
{
"method":"patch.formfactor.create",
"params":{
"apikey":"24174j3tqj",
"data": {
"obj_id":4,
"half_he":1
}
},
"version":"2.0"
}
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| obj_id | int | ID des referenzierten Objektes | ab Version 1.0 |
| half_he | int | Formfaktor wird mit halben Höheneinheiten behandelt 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.formfactor.update
Beschreibung
Aktualisiert einen bestehenden Formfaktor.
Beispielaufruf
{
"method":"patch.formfactor.update",
"params":{
"apikey":"24174j3tqj",
"id":4,
"data": {
"half_he":0
}
},
"version":"2.0"
}
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| id | int | ID des Datenbankeintrages | ab Version 1.0 |
| half_he | int | Formfaktor wird mit halben Höheneinheiten behandelt 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.formfactor.delete
Beschreibung
Löscht einen bestehenden Formfaktor.
Beispielaufruf
{
"method":"patch.formfactor.delete",
"params":{
"apikey":"24174j3tqj",
"id":4
},
"version":"2.0"
}
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| id | int | ID des zu löschenden Formfaktors | 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 |