This is a translation of the original English documentation page. Help us make it better.

report.get

Beschrijving

integer/array report.get(object parameters)

Deze methode maakt het mogelijk om geplande rapporten op te halen op basis van de opgegeven parameters.

Deze methode is beschikbaar voor gebruikers van elk type. Toestemmingen om de methode te gebruiken, kunnen worden ingetrokken in gebruikersrolinstellingen. Zie Gebruikersrollen voor meer informatie.

Parameters

(object) Parameters die de gewenste uitvoer definiëren.

De methode ondersteunt de volgende parameters.

Parameter Type Omschrijving
reportids string/array Alleen geplande rapporten retourneren met de opgegeven rapport-ID's.
expired boolean Als ingesteld op true, worden alleen verlopen geplande rapporten geretourneerd, als false - alleen actieve geplande rapporten.
selectUsers query Retourneer een eigenschap users waarvoor het rapport is geconfigureerd om naartoe te worden gestuurd.
selectUserGroups query Retourneer een eigenschap user_groups waarvoor het rapport is geconfigureerd om naartoe te worden gestuurd.
sortfield string/array Sorteer het resultaat op basis van de opgegeven eigenschappen.

Mogelijke waarden: reportid, name, status.
countOutput boolean Deze parameters, die gemeenschappelijk zijn voor alle get-methoden, worden in detail beschreven op de referentiecommentaar-pagina.
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Retourwaarden

(integer/array) Retourneert ofwel:

  • een reeks objecten;
  • het aantal opgehaalde objecten, als de countOutput parameter heeft gebruikt.

Voorbeelden

Ophalen van rapportgegevens

Aanvraag:

{
           "jsonrpc": "2.0",
           "method": "report.get",
           "params": {
               "output": "extend",
               "selectUsers": "extend",
               "selectUserGroups": "extend",
               "reportids": ["1", "2"]
           },
           "id": 1
       }

Reactie:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "reportid": "1",
                   "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",
                   "state": "1",
                   "lastsent": "1613563219",
                   "info": "",
                   "users": [
                       {
                           "userid": "1",
                           "access_userid": "1",
                           "exclude": "0"
                       },
                       {
                           "userid": "2",
                           "access_userid": "0",
                           "exclude": "1"
                       }
                   ],
                   "user_groups": [
                       {
                           "usrgrpid": "7",
                           "access_userid": "0"
                       }
                   ]
               },
               {
                   "reportid": "2",
                   "userid": "1",
                   "name": "Maandelijks rapport",
                   "dashboardid": "2",
                   "period": "2",
                   "cycle": "2",
                   "start_time": "0",
                   "weekdays": "0",
                   "active_since": "2021-05-01",
                   "active_till": "",
                   "subject": "Maandelijks rapport",
                   "message": "Bijbehorende tekst van het rapport",
                   "status": "1",
                   "description": "",
                   "state": "0",
                   "lastsent": "0",
                   "info": "",
                   "users": [
                       {
                           "userid": "1",
                           "access_userid": "1",
                           "exclude": "0"
                       }
                   ],
                   "user_groups": []
               }
           ],
           "id": 1
       }

Zie ook

Bron

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