Report
Verwaltung von Reports.
Seitenverzeichnis:
Objektdefinition
In I-Doit muss manuell ein neues Objekt vom Typ C__SHD__REPORT mit der Sprachkonstante LC__SHD__REPORT angelegt werden.
Als Kategorie wird "Reporting Report" zugewiesen.
Als Bild wird "printer.png" und als Icon "images/icons/silk/report.png" ausgewählt.
reporting.report.read
Beschreibung
Gibt alle konfigurierten Reports zurück.
Beispielaufruf
Lesen eines speziellen Reports:
{
"method":"reporting.report.read",
"params":{
"apikey":"24174j3tqj",
"id": 4
},
"version":"2.0",
"id": 1
}Filtern nach Reports:
{
"method":"reporting.report.read",
"params":{
"apikey":"24174j3tqj",
"filter": {
"description": "Report %"
}
},
"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 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 Reports.
Wert | Typ | Beschreibung | Version |
|---|---|---|---|
id | int | ID des Datenbankeintrages | ab Version 1.0 |
obj_id | int | ID des referenzierten Objektes | ab Version 1.0 |
description | 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 |
parameter | string | Parameter des Reports | ab Version 1.0 |
object_types | array | IDs der Objekttypen, welche den Report verwenden können | ab Version 1.0 |
reporting.report.create
Beschreibung
Legt einen neuen Report an.
Beispielaufruf
{
"method":"reporting.report.create",
"params":{
"apikey":"24174j3tqj",
"data": {
"obj_id":19,
"description":"Report 1",
"query":"SELECT * FROM ...",
"parameter": "-p"
}
},
"version":"2.0",
"id": 1
}Parameter
Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
obj_id | int | ID des referenzierten Objektes | ab Version 1.0 |
description | string | Titel des Reports | ab Version 1.0 |
default_template | string | Optional: Standard-Vorlage des Reports | ab Version 1.0 |
query | string | Optional: SQL-Abfrage des Reports | ab Version 1.0 |
parameter | string | Parameter des Reports | ab Version 1.0 |
object_types | array | Optional: IDs der Objekttypen, welche den Report verwenden können | 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 |
reporting.report.update
Beschreibung
Aktualisiert einen bestehenden Report.
Beispielaufruf
{
"method":"reporting.report.update",
"params":{
"apikey":"24174j3tqj",
"id":4,
"data": {
"description":"Anschluss 1",
"query":"SELECT * FROM ...",
"parameter": "-f"
}
},
"version":"2.0",
"id": 1
}Parameter
Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
id | int | ID des Datenbankeintrages | ab Version 1.0 |
description | 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 |
parameter | string | Parameter des Reports | ab Version 1.0 |
object_types | array | IDs der Objekttypen, welche den Report verwenden können | 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 |
reporting.report.delete
Beschreibung
Löscht einen bestehenden Report.
Beispielaufruf
{
"method":"reporting.report.delete",
"params":{
"apikey":"24174j3tqj",
"id":4
},
"version":"2.0",
"id": 1
}Parameter
Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
id | int | ID des zu löschenden Reports | 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 |