report.create

Beschrijving

object report.create(object/array reports)

Deze methode maakt het mogelijk om nieuwe geplande rapporten te maken.

Deze methode is alleen beschikbaar voor gebruikers van het type Admin en Superadmin. Toestemmingen om de methode te gebruiken, kunnen worden ingetrokken in de instellingen van de gebruikersrol. Zie Gebruikersrollen voor meer informatie.

Parameters

(object/array) Geplande rapporten om te maken.

Naast de standaardeigenschappen van gepland rapport accepteert de methode de volgende parameters.

Parameter	Type	Omschrijving
users	object/array	Gebruikers om het rapport naartoe te sturen. Gedrag van parameters: - vereist als `user_groups` niet is ingesteld
user_groups	object/array	Gebruikersgroepen om het rapport naartoe te sturen. Gedrag van parameters: - vereist als `users` niet is ingesteld

Retourwaarden

(object) Retourneert een object met de ID's van de gemaakte geplande rapporten onder de eigenschap reportids. De volgorde van de geretourneerde ID's komt overeen met de volgorde van de doorgegeven geplande rapporten.

Voorbeelden

Een gepland rapport maken

Maak een wekelijks rapport aan dat elke maandag tot en met vrijdag om 12:00 uur wordt voorbereid voor de voorgaande week, vanaf 1 april 2021 tot en met 31 augustus 2021.

Aanvraag:

{
           "jsonrpc": "2.0",
           "method": "report.create",
           "params": {
               "userid": "1",
               "name": "Wekelijks rapport",
               "dashboardid": "1",
               "period": "1",
               "cycle": "1",
               "start_time": "43200",
               "weekdays": "31",
               "active_since": "2021-04-01",
               "active_till": "2021-08-31",
               "subject": "Wekelijks rapport",
               "message": "Bijbehorende tekst van het rapport",
               "status": "1",
               "description": "Rapportbeschrijving",
               "users": [
                   {
                       "userid": "1",
                       "access_userid": "1",
                       "exclude": "0"
                   },
                   {
                       "userid": "2",
                       "access_userid": "0",
                       "exclude": "1"
                   }
               ],
               "user_groups": [
                   {
                       "usrgrpid": "7",
                       "access_userid": "0"
                   }
               ]
           },
           "id": 1
       }

Reactie:

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

Zie ook

Bron

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

Documentation