report.create

Descripció

object report.create(object/array reports)

Aquest mètode permet crear nous informes programats.

Tenim aquest mètode disponible només per als usuaris Admin i Super admin. Els permisos per cridar el mètode es poden revocar a la configuració dels rols d'usuari. Per a més informació, veieu Rols d'usuari.

Paràmetres

(object/array) Informes programats per crear.

A més de les [propietats d'informe programat estàndard] (object#report), el mètode admet els paràmetres següents.

Paràmetre	Tipus	Descripció
users	object/array of objects	Usuaris als qui enviar l'informe. Comportament de la propietat: - obligatori si no s'ha establert `user_groups`
user_groups	object/array of objects	Grups d'usuaris als qui enviar l'informe. Comportament de la propietat: - obligatori si no s'ha establert `users`

Valors de retorn

(object) Retorna un objecte que conté els ID dels informes programats creats amb la propietat reportids. L'ordre dels ID retornats coincideix amb l'ordre enviat dels informes programats.

Exemples

Crear un informe planificat

Crear un informe setmanal que es prepararà per la setmana anterior tots els dies de dilluns a divendres a les 1 del migdia des de l'01.04.2021 fins al 31.08.2021.

Petició:

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

Resposta:

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

Veieu també

Usuaris
[Grups d'usuaris] (object#user_groups)

Font

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

Documentation