report.update

Beschrijving

object report.update(object/array reports)

Deze methode maakt het mogelijk om bestaande geplande rapporten bij te werken.

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) Eigenschappen van gepland rapport om bij te werken.

De eigenschap reportid moet worden gedefinieerd voor elk gepland rapport, alle andere eigenschappen zijn optioneel. Alleen de doorgegeven eigenschappen worden bijgewerkt, alle andere blijven ongewijzigd.

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

Parameter Type Omschrijving
users object/array Gebruikers om de huidige gebruikers die aan het geplande rapport zijn toegewezen te vervangen.

Gedrag van parameters:
- vereist als user_groups niet is ingesteld
user_groups object/array Gebruikersgroepen om de huidige gebruikersgroepen die aan het geplande rapport zijn toegewezen te vervangen.

Gedrag van parameters:
- vereist als users niet is ingesteld

Retourwaarden

(object) Retourneert een object met de ID's van de bijgewerkte geplande rapporten onder de eigenschap reportids.

Voorbeelden

Uitschakelen van gepland rapport

Aanvraag:

{
           "jsonrpc": "2.0",
           "method": "report.update",
           "params": {
               "reportid": "1",
               "status": "0"
           },
           "id": 1
       }

Reactie:

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

Zie ook

Bron

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