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

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

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

Paràmetre	Tipus
serviceids	string/array	Retorna només els serveis amb els identificadors proporcionats.
parentids	string/array	Retorna només els serveis relacionats amb els serveis dels pares donats.
deep_parentids	flag	Retornar tots els serveis directes i indirectes als fills. S'empra amb `parentids`.
childids	string/array	Retorna només els serveis relacionats amb els serveis per a fills donats.
evaltype	integer	Regles de cerca d'etiquetes. Valors possibles: 0 - (per defecte) I/O; 2 - O.
tags	object/array of objects	Retorna només els serveis amb etiquetes especificades. Concordança exacta per etiqueta i cerca entre majúscules i minúscules o no 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 ho ésés igual; 4 - Existeix; 5 - No existeix.
problem_tags	object/array of objects	Retorna només els serveis amb etiquetes de problema donades. Concordança exacta per etiqueta i cerca entre majúscules i minúscules o no 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	Retorna només els serveis sense una etiqueta de problema.
assassinat	string/array	Retorna només els serveis relacionats amb els SLA específics.
selectChildren	query	Retorna una propietat `children` amb serveis per a fills. Admet `count`.
selectParents	query	Retorna una propietat `parents` amb serveis pare. Admet `count`.
selectTags	query	Retorna una propietat etiquetes 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) ID de l'esdeveniment; `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	object/array of objects	Retorna una propietat `status_timeline` que conté canvis d'estat del servei per a períodes de temps determinats. Format `[{"period_from": "<period_from>", "period_to": "<period_to>"}, ...]` - on `period_from` és una data d'inici (inclosa; marca de temps sencera) i `period_to` és una data de finalització (exclusiva; marca de temps sencera) per al període d'interès. Retorna una matriu d'entrades que contenen un `start_value` i una matriu alarmes per als canvis d'estat en períodes de temps especificats.

sortfield	string/array	Ordena el resultat segons les propietats donades. Els valors possibles són: `serviceid`, `name`, `status`, `sortorder` i `created_at`.
countOutput	boolean	Aquests paràmetres es descriuen en detall a la pàgina comentaris de referència.
editable	boolean
excludeSearch	boolean
filter	object
limit	integer
output	query
preservekeys	boolean
search	object
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

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

Recuperar totes les dades sobre tots els serveis i le seves dependències.

Petició:

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

Resposta:

{
           "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
       }

Font

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

Documentation