report.create

Apraksts

object report.create(object/array reports)

Šī metode ļauj izveidot jaunus ieplānotus pārskatus.

Šī metode ir pieejama tikai Admin un Super admin lietotāju tipiem. Atļaujas izsaukt šo metodi var tikt atsauktas lietotāja lomas iestatījumos. Plašāku informāciju skatiet Lietotāju lomas.

Parametri

(object/array) Ieplānotie pārskati, ko izveidot.

Papildus standarta ieplānotā pārskata īpašībām metode pieņem šādus parametrus.

Parametrs Type Apraksts
users object/array Lietotāji, kuriem nosūtīt pārskatu.

Parametra darbība:
- obligāts, ja user_groups nav iestatīts
user_groups object/array Lietotāju grupas, kurām nosūtīt pārskatu.

Parametra darbība:
- obligāts, ja users nav iestatīts

Atgrieztās vērtības

(object) Atgriež objektu, kas satur izveidoto ieplānoto atskaišu ID īpašībā reportids. Atgriezto ID secība atbilst nodoto ieplānoto atskaišu secībai.

Piemēri

Ieplānota pārskata izveide

Izveidojiet nedēļas pārskatu, kas tiks sagatavots par iepriekšējo nedēļu katru pirmdienu–piektdienu plkst. 12:00 no 2021-04-01 līdz 2021-08-31.

Pieprasījums:

{
    "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
}

Atbilde:

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

Skatiet arī

Avots

CReport::create() failā ui/include/classes/api/services/CReport.php.