report.create
Beschreibung
object report.create(object/array reports)
Mit dieser Methode können neue geplante Berichte erstellt werden.
Diese Methode ist nur für die Benutzertypen Admin und Super admin verfügbar. Die Berechtigung zum Aufrufen der Methode kann in den Einstellungen der Benutzerrolle entzogen werden. Weitere Informationen finden Sie unter Benutzerrollen.
Parameter
(object/array) Zu erstellende geplante Berichte.
Zusätzlich zu den standardmäßigen Eigenschaften geplanter Berichte akzeptiert die Methode die folgenden Parameter.
| Parameter | Type | Beschreibung |
|---|---|---|
| users | object/array | Benutzer, an die der Bericht gesendet werden soll. Parameter behavior: - erforderlich, wenn user_groups nicht gesetzt ist |
| user_groups | object/array | Benutzergruppen, an die der Bericht gesendet werden soll. Parameter behavior: - erforderlich, wenn users nicht gesetzt ist |
Rückgabewerte
(object) Gibt ein Objekt zurück, das die IDs der erstellten geplanten
Berichte in der Eigenschaft reportids enthält. Die Reihenfolge der
zurückgegebenen IDs entspricht der Reihenfolge der übergebenen geplanten Berichte.
Beispiele
Erstellen eines geplanten Berichts
Erstellen Sie einen wöchentlichen Bericht, der für die vorherige Woche von Montag bis Freitag jeweils um 12:00 Uhr im Zeitraum vom 2021-04-01 bis 2021-08-31 erstellt wird.
{
"jsonrpc": "2.0",
"method": "report.create",
"params": {
"userid": "1",
"name": "Weekly report",
"dashboardid": "1",
"period": "1",
"cycle": "1",
"start_time": "43200",
"weekdays": "31",
"active_since": "2021-04-01",
"active_till": "2021-08-31",
"subject": "Weekly report",
"message": "Report accompanying text",
"status": "1",
"description": "Report description",
"users": [
{
"userid": "1",
"access_userid": "1",
"exclude": "0"
},
{
"userid": "2",
"access_userid": "0",
"exclude": "1"
}
],
"user_groups": [
{
"usrgrpid": "7",
"access_userid": "0"
}
]
},
"id": 1
}
Antwort:
{
"jsonrpc": "2.0",
"result": {
"reportids": [
"1"
]
},
"id": 1
}
Siehe auch
Quelle
CReport::create() in ui/include/classes/api/services/CReport.php.