service.get

Descripció

integer/array service.get(object parameters)

El mètode permet recuperar serveis segons els paràmetres proveïts.

Aquest mètode és disponible per a usuaris de qualsevol mena. Els permisos per cridar al mètode es poden revocar a les configuracions de rols d'usuari. Per a més informació, veieu Rols d'usuari.

Paràmetres

(objecte) Paràmetres que defineixen la sortida esperada.

El mètode admet els paràmetres següents.

Paràmetre	Tipus	Descripció
serviceids	ID/array	Retorna només serveis amb els ID donats.
parentids	ID/array	Retorna només els serveis que són enllaçats als serveis pare donats.
deep_parentids	flag	Retorna tots els serveis secundaris directes i indirectes. S'empra juntament amb `parentids`.
childids	ID/array	Retorna només els serveis que són enllaçats als serveis secundaris donats.
evaltype	enter	Regles per a la cerca d'etiquetes. Valors possibles: 0 - (per defecte) I/O; 2 - O.
tags	objecte/matriu d'objectes	Retorn només serveis amb etiquetes donades. Concordança exacta per etiqueta i cerca que distingeix entre majúscules i majúscules o minúscules per valor de l'etiqueta en funció del valor de l'operador. Format: `[{"tag": "<etiqueta>", "value": "<valor>", " operator": "<operador>"}, ...]`. Una matriu buida retorna tots els serveis. Possibles valors d'operador: 0 - (per defecte) Conté; 1 - És igual; 2 - No conté; 3 - No és igual; 4 - Existeix; 5 - No existeix.
problem_tags	objecte/matriu d'objectes	Retorn només serveis amb etiquetes de problema donades. Concordança exacta per etiqueta i cerca que distingeix entre majúscules i majúscules o minúscules per valor de l'etiqueta en funció del valor de l'operador. Format: `[{"tag": "<etiqueta>", "valor": "<valor>", " operator": "<operador>"}, ...]`. Una matriu buida retorna tots els serveis. Possibles valors d'operador: 0 - (per defecte) Conté;<br >1 - És igual; 2 - No conté; 3 - No és igual; 4 - Existeix; 5 - No existeix.
without_problem_tags	bandera	Retorn només serveis sense etiquetes de problema.
slaids	ID/array	Retorna només els serveis que són enllaçats amb els SLA específics.
selectChildren	query	Retorna una propietat `fills` amb els serveis secundaris. Admet `count`.
selectParents	query	Retorna una propietat `parents` amb els serveis parentals. Admet `count`.
selectTags	query	Retorna una propietat `tags` amb etiquetes de servei. Admet `count`.
selectProblemEvents	query	Retorna una propietat `problem_events` amb una matriu d'objectes d'esdeveniment problema. L'objecte d'esdeveniment problema té les propietats següents: `eventid` - `(cadena)` Identificador d'esdeveniment;< br>`gravetat` - `(cadena)` Gravetat de l'esdeveniment actual; `nom` - `(cadena)` Nom de l'esdeveniment resolt. Admet `count`.
selectProblemTags	query	Retorna una propietat `problem_tags` amb etiquetes de problema. Admet `count`.
selectStatusRules	query	Retorna una propietat `status_rules` amb regles d'estat. Admet `count`.
selectStatusTimeline	objecte/matriu d'objectes	Retorna una propietat `status_timeline` que conté canvis d'estat del servei per a períodes determinats. Format `[{"period_from": "<period_from>", "period_to": "<period_to >"}, ...]` - `period_from` és una data d'inici (inclosa; marca de temps entera) i `period_to` és una data de finalització (exclusiu; marca de temps enter) per al període que t'interessa. < br>Retorna una matriu d'entrades que contenen una propietat `start_value` i una matriu alarmes per als canvis d'estat dins dels períodes especificats.
sortfield	string/array	Ordena el resultat per les propietats donades. Valors possibles: `serviceid`, `name`, `status`, `sortorder`, `created_at`.
countOutput	boolean	Aquests paràmetres es descriuen en detall al comentari de referència.
editable	booleà
excludeSearch	booleà
filter	objecte
limit	enter
output	consulta
preservekeys	boolean
search	objecte
searchByAny	booleà
searchWildcardsEnabled	booleà
sortorder	cadena/matriu
startSearch	booleà

Valors de retorn

(integer/array) Retorna un d'entre:

una taula d'objectes;
el recompte d'objectes recuperats, si s'empra el paràmetre countOutput.

Exemples

Recuperar tots els serveis

Recupera tota la informació de tots els serveis i les seves dependències.

Petició:

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

Resposta:

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

Font

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

Documentation