report.create

Leírás

object report.create(object/array reports)

Ez a módszer lehetővé teszi új ütemezett jelentések létrehozását.

Ez a módszer csak az Admin és a Kiemelt rendszergazda számára érhető el felhasználói típusok. A metódus meghívására vonatkozó engedélyek felhasználói szerepkörben visszavonhatók beállítások. Lásd: User roles további információért.

Paraméterek

(objektum/tömb) Ütemezett jelentések létrehozása.

A standard ütemezett jelentés mellett property, a metódus a következő paramétereket fogadja el.

Paraméter Típus Leírás
felhasználók objektum/objektumtömb Felhasználók, akiknek el kell küldeni a jelentést.
user_groups objektum/objektumok tömbje Felhasználói csoportok a jelentés küldéséhez.

Visszatérési értékek

(object) Egy objektumot ad vissza, amely tartalmazza a létrehozott ütemezés azonosítóit jelentések a "reportids" tulajdonság alatt. A visszaküldött azonosítók sorrendje megfelel az átadott ütemezett jelentések sorrendjének.

Példák

Creating a scheduled report

Create a weekly report that will be prepared for the previous week every Monday-Friday at 12:00 from 2021-04-01 to 2021-08-31.

Request:

{
    "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"
            }
        ]
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": {
        "reportids": [
            "1"
        ]
    },
    "id": 1
}

Lásd még

Forrás

CReport::create() az ui/include/classes/api/services/CReport.php-ban.