Table of Contents
#service.get
Beschrijving
integer/array service.get(object parameters)
De methode maakt het mogelijk om services 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 de volgende parameters.
| Parameter | Type | |
|---|---|---|
| serviceids | string/array | Alleen services met de opgegeven IDs retourneren. |
| parentids | string/array | Alleen services retourneren die zijn gekoppeld aan de opgegeven ouderdiensten. |
| deep_parentids | flag | Alle directe en indirecte kindservices retourneren. Samen met parentids gebruikt. |
| childids | string/array | Alleen services retourneren die zijn gekoppeld aan de opgegeven kindservices. |
| evaltype | integer | Regels voor het zoeken naar tags. Mogelijke waarden: 0 - (standaard) And/Of; 2 - Of. |
| tags | object/array | Alleen services retourneren met de opgegeven tags. Exacte overeenkomst op tag en hoofdlettergevoelige of hoofdletterongevoelige zoekopdracht op tagwaarde, afhankelijk van de operatorwaarde. Formaat: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].Een lege array retourneert alle services. 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 | Alleen services retourneren met de opgegeven probleemtags. Exacte overeenkomst op tag en hoofdlettergevoelige of hoofdletterongevoelige zoekopdracht op tagwaarde, afhankelijk van de operatorwaarde. Formaat: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].Een lege array retourneert alle services. 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 | Alleen services retourneren zonder probleemtags. |
| slaids | string/array | Alleen services retourneren die zijn gekoppeld aan de specifieke SLA('s). |
| selectChildren | query | Een children eigenschap retourneren met de kindservices.Ondersteunt count. |
| selectParents | query | Een parents eigenschap retourneren met de ouderdiensten.Ondersteunt count. |
| selectTags | query | Een tags eigenschap retourneren met services-tags. Ondersteunt count. |
| selectProblemEvents | query | Een problem_events eigenschap retourneren met een array van probleemgebeurtenis-objecten.Het probleemgebeurtenis-object heeft de volgende eigenschappen: eventid - (string) Event-ID;severity - (string) Huidige gebeurtenisernst;name - (string) Naam van opgeloste gebeurtenis.Ondersteunt count. |
| selectProblemTags | query | Een problem_tags eigenschap retourneren met probleemtags. Ondersteunt count. |
| selectStatusRules | query | Een status_rules eigenschap retourneren met statusregels. Ondersteunt count. |
| selectStatusTimeline | object/array | Een status_timeline eigenschap retourneren met wijzigingen in de status van de service voor opgegeven perioden.Formaat [{"period_from": "<period_from>", "period_to": "<period_to>"}, ...] - period_from is een startdatum (inclusief; integer-tijdstempel) en period_to is een einddatum (exclusief; integer-tijdstempel) voor de periode waarin je geïnteresseerd bent.Retourneert een array van items met een start_value eigenschap en een alarms array voor de statuswijzigingen binnen de gespecificeerde periodes. |
| sortfield | string/array | De resultaten sorteren op de opgegeven eigenschappen. Mogelijke waarden zijn: serviceid, name, status, sortorder en created_at. |
| countOutput | boolean | Deze parameters zijn gebruikel |
ijk voor alle get-methoden en worden in detail beschreven in de referentie-commentaar. | | 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
countOutputparameter heeft gebruikt.
Voorbeelden
Alle services ophalen
Haal alle gegevens op over alle services en hun afhankelijkheden.
Verzoek:
{
"jsonrpc": "2.0",
"method": "service.get",
"params": {
"output": "extend",
"selectChildren": "extend",
"selectParents": "extend"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Antwoord:
{
"jsonrpc": "2.0",
"result": [
{
"serviceid": "1",
"name": "My Service - 0001",
"status": "-1",
"algorithm": "2",
"sortorder": "0",
"weight": "0",
"propagation_rule": "0",
"propagation_value": "0",
"description": "My Service Description 0001.",
"uuid": "dfa4daeaea754e3a95c04d6029182681",
"created_at": "946684800",
"readonly": false,
"parents": [],
"children": []
},
{
"serviceid": "2",
"name": "My Service - 0002",
"status": "-1",
"algorithm": "2",
"sortorder": "0",
"weight": "0",
"propagation_rule": "0",
"propagation_value": "0",
"description": "My Service Description 0002.",
"uuid": "20ea0d85212841219130abeaca28c065",
"created_at": "946684800",
"readonly": false,
"parents": [],
"children": []
}
],
"id": 1
}Bron
CService::get() in ui/include/classes/api/services/CService.php.