huishouding.get

Beschrijving

object housekeeping.get(object parameters)

De methode maakt het mogelijk om het huishoudobject op te halen volgens de gegeven parameters.

Deze methode is beschikbaar voor gebruikers van elk type. Rechten om de methode aan te roepen, kan worden ingetrokken in de instellingen van de gebruikersrol. Zie Gebruiker rollen voor meer informatie.

Parameters

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

De methode ondersteunt slechts één parameter.

Parameter	Type	Beschrijving
output	query	Deze parameter is gebruikelijk voor alle `get`-methoden die worden beschreven in de referentiecommentaar.

Retourwaarden

(object) Retourneert huishoudobject.

Voorbeelden

Verzoek:

{
           "jsonrpc": "2.0",
           "method": "housekeeping.get",
           "params": {
               "output": "extend"
           },
           "id": 1
       }

Antwoord:

{
           "jsonrpc": "2.0",
           "result": {
               "hk_events_mode": "1",
               "hk_events_trigger": "365d",
               "hk_events_service": "1d",
               "hk_events_internal": "1d",
               "hk_events_discovery": "1d",
               "hk_events_autoreg": "1d",
               "hk_services_mode": "1",
               "hk_services": "365d",
               "hk_audit_mode": "1",
               "hk_audit": "365d",
               "hk_sessions_mode": "1",
               "hk_sessions": "365d",
               "hk_history_mode": "1",
               "hk_history_global": "0",
               "hk_history": "90d",
               "hk_trends_mode": "1",
               "hk_trends_global": "0",
               "hk_trends": "365d",
               "db_extension": "",
               "compression_status": "0",
               "compress_older": "7d"
           },
           "id": 1
       }

Bron

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

Documentation