Documentation

Table of Contents

Beschrijving
Parameters
Retourwaarden
Voorbeelden
- Alle services ophalen
Bron

#service.get

Beschrijving

integer/array service.get(object parameters)

Deze methode maakt het mogelijk om services op te halen volgens de opgegeven parameters.

Deze methode is beschikbaar voor gebruikers van elk type. Rechten om de methode op te roepen kunnen worden ingetrokken in de instellingen van gebruikersrollen. Zie Gebruikersrollen voor meer informatie.

Parameters

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

De methode ondersteunt de volgende parameters.

Parameter	Type	Beschrijving
serviceids	string/array	Geef alleen services terug met de opgegeven ID's.
parentids	string/array	Geef alleen services terug die gekoppeld zijn aan de opgegeven ouder services.
deep_parentids	flag	Geef alle directe en indirecte kind services terug. Samen met `parentids` gebruikt.
childids	string/array	Geef alleen services terug die gekoppeld zijn aan de opgegeven kind services.
evaltype	integer	Regels voor tag-zoeken. Mogelijke waarden: 0 - (standaard) And/Or; 2 - Or.
tags	object/array	Geef alleen services terug met gegeven tags. Exacte match op tag en hoofdlettergevoelige of niet-hoofdlettergevoelige zoekopdracht op tag-waarde afhankelijk van de operatorwaarde. Formaat: `[{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...]`. Een lege array geeft alle services terug. Mogelijke operatorwaarden: 0 - (standaard) Bevat; 1 - Is gelijk aan; 2 - Bevat niet; 3 - Is niet gelijk aan; 4 - Bestaat; 5 - Bestaat niet.
problem_tags	object/array	Geef alleen services terug met gegeven probleemtags. Exacte match op tag en hoofdlettergevoelige of niet-hoofdlettergevoelige zoekopdracht op tag-waarde afhankelijk van de operatorwaarde. Formaat: `[{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...]`. Een lege array geeft alle services terug. Mogelijke operatorwaarden: 0 - (standaard) Bevat; 1 - Is gelijk aan; 2 - Bevat niet; 3 - Is niet gelijk aan; 4 - Bestaat; 5 - Bestaat niet.
without_problem_tags	flag	Geef alleen services terug zonder probleemtags.
slaids	string/array	Geef alleen services terug die gekoppeld zijn aan specifieke SLA('s).
selectChildren	query	Geef een eigenschap `children` terug met de kind services. Ondersteunt `count`.
selectParents	query	Geef een eigenschap `parents` terug met de ouder services. Ondersteunt `count`.
selectTags	query	Geef een `tags` eigenschap terug met service tags. Ondersteunt `count`.
selectProblemEvents	query	Geef een eigenschap `problem_events` terug met een array van probleemgebeurtenisobjecten. Het probleemgebeurtenisobject heeft de volgende eigenschappen: `eventid` - `(string)` Gebeurtenis-ID; `severity` - `(string)` Huidige ernst van de gebeurtenis; `name` - `(string)` Naam van opgeloste gebeurtenis. Ondersteunt `count`.
selectProblemTags	query	Geef een `problem_tags` eigenschap terug met probleemtags. Ondersteunt `count`.
selectStatusRules	query	Geef een `status_rules` eigenschap terug met statusregels. Ondersteunt `count`.
selectStatusTimeline	object/array	Geef een `status_timeline` eigenschap terug met service-statuswijzigingen voor opgegeven periodes. Formaat `[{"period_from": "<period_from>", "period_to": "<period_to>"}, ...]` - `period_from` is een startdatum (inclusief; integer timestamp) en `period_to` is een einddatum (exclusief; integer timestamp) voor de periode waarin je geïnteresseerd bent. Geeft een array van items terug met een `start_value` eigenschap en een alarms array voor de statuswijzigingen binnen opgegeven periodes.
sortfield	string/array	Sorteer het resultaat op de opgegeven eigenschappen. Mogelijke waarden: `serviceid`, `name`, `status`, `sortorder`, `created_at`.
countOutput	boolean	Deze parameters die gemeenschappelijk zijn voor alle `get` methoden worden in detail beschreven in het referentiecommentaar.
editable	boolean
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

Alle services ophalen

Haal alle gegevens op over alle services en hun afhankelijkheden.

Aanvraag:

{
           "jsonrpc": "2.0",
           "method": "service.get",
           "params": {
               "output": "extend",
               "selectChildren": "extend",
               "selectParents": "extend"
           },
           "id": 1
       }

Reactie:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "serviceid": "1",
                   "name": "Mijn Service - 0001",
                   "status": "-1",
                   "algorithm": "2",
                   "sortorder": "0",
                   "weight": "0",
                   "propagation_rule": "0",
                   "propagation_value": "0",
                   "description": "Mijn Service Beschrijving 0001.",
                   "uuid": "dfa4daeaea754e3a95c04d6029182681",
                   "created_at": "946684800",
                   "readonly": false,
                   "parents": [],
                   "children": []
               },
               {
                   "serviceid": "2",
                   "name": "Mijn Service - 0002",
                   "status": "-1",
                   "algorithm": "2",
                   "sortorder": "0",
                   "weight": "0",
                   "propagation_rule": "0",
                   "propagation_value": "0",
                   "description": "Mijn Service Beschrijving 0002.",
                   "uuid": "20ea0d85212841219130abeaca28c065",
                   "created_at": "946684800",
                   "readonly": false,
                   "parents": [],
                   "children": []
               }
           ],
           "id": 1
       }

Bron

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