report.create

Descrizione

object report.create(object/array reports)

Questo metodo consente di creare nuovi report pianificati.

Questo metodo è disponibile solo per i tipi di utente Admin e Super admin. Le autorizzazioni per chiamare il metodo possono essere revocate nelle impostazioni del ruolo utente. Per ulteriori informazioni, vedere Ruoli utente.

Parametri

(object/array) Report pianificati da creare.

Oltre alle proprietà standard dei report pianificati, il metodo accetta i seguenti parametri.

Parametro Type Descrizione
users object/array Utenti a cui inviare il report.

Comportamento del parametro:
- obbligatorio se user_groups non è impostato
user_groups object/array Gruppi di utenti a cui inviare il report.

Comportamento del parametro:
- obbligatorio se users non è impostato

Valori restituiti

(object) Restituisce un oggetto contenente gli ID dei report pianificati creati nella proprietà reportids. L'ordine degli ID restituiti corrisponde all'ordine dei report pianificati passati.

Esempi

Creazione di un report pianificato

Creare un report settimanale che verrà preparato per la settimana precedente ogni lunedì-venerdì alle 12:00 dal 2021-04-01 al 2021-08-31.

Richiesta:

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

Risposta:

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

Vedi anche

Fonte

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