Documentation
Table of Contents
service.get
¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô
integer/array service.get(object parameters)
El m¨¦todo permite recuperar alertas seg¨²n los par¨¢metros dados.
Este m¨¦todo est¨¢ disponible para usuarios de cualquier tipo. Los permisos para activar el m¨¦todo se pueden revocar en la configuraci¨®n de roles de usuario. Ver User roles para m¨¢s informaci¨®n.
±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç²õ
(object) Parametros para definir la salida deseada.
El m¨¦todo soporta los siguientes par¨¢metros.
| Parametro | Tipo | |
|---|---|---|
| serviceids | cadena/matriz | Devuelve solo servicios con IDs dados. |
| parentids | cadena/matriz | Devuelve solo servicios que est¨¢n conectados a los servicios de padres dados. |
| deep_parentids | flag | Devuelve todos los servicios para ni?os directos y indirectos. Usado conjuntamente con parentids. |
| childids | cadena/matriz | Devuelve solo los servicios que est¨¢n conectados a los servicios para ni?os dados. |
| evaltype | n¨²mero entero | Reglas para b¨²squeda de etiqueta. Valores posibles: 0 - (predeterminado) y/o; 2 - o. |
| etiquetas | objeto/matriz | Devuelve solo servicios con las etiquetas dadas. Coincidencia exacta por etiqueta y b¨²squeda sensible a may¨²sculas y min¨²sculas o insensible a may¨²sculas por valor de etiqueta en funci¨®n del valor del operador. Formato: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].Una matriz vac¨ªa devuelve todos los servicios. Posibles valores de operador: 0 - (predeterminado) Contiene; 1 - Equivale a; 2 - No contiene; 3 - No equivale a; 4 - Existe; 5 - No existe. |
| problem_tags | objeto/matriz | Devuelve solo servicios con etiquetas de problemas dadas. Coincidencia exacta por etiqueta y b¨²squeda sensible a may¨²sculas y min¨²sculas o insensible a may¨²sculas por valor de etiqueta en funci¨®n del valor del operador. Formato: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].Una matriz vac¨ªa devuelve todos los servicios. Posibles valores de operador: 0 - (predeterminado) Contiene; 1 - Equivale a; 2 - No contiene; 3 - No equivale a; 4 - Existe; 5 -No existe. |
| without_problem_tags | flag | Devuelve solo servicios sin etiquetas de problema. |
| slaids | cadena/matriz | Devuelve solo servicios que est¨¢n conectados a SLA(s) espec¨ªficas. |
| selectChildren | consulta | Devuelve a la propiedadchildren con los servicios para ni?os.Soporta count. |
| selectParents | consulta | Devuelve a la propiedad parents con servicios para padres.Soporta count. |
| selectTags | consulta | Devuelve a la propiedad tags con etiquetas de servicio. Soporta count. |
| selectProblemEvents | consulta | Devuelve a la propiedad problem_events con una matriz de objetos de problemas de evento.O objeto de problema de evento tiene las siguientes propiedades: eventid - (cadena) Evento ID;severity - (cadena) Severidad de evento actual;name - (cadena) Nombre de evento resuelto.Soporta count. |
| selectProblemTags | consulta | Devuelve una propiedad problem_tags con etiquetas de problema. Soporta count. |
| selectStatusRules | consulta | Devuelve una propiedad status_rules con reglas de estados. Soporta count. |
| selectStatusTimeline | objeto/matriz | Devuelve una propiedad status_timeline conteniendo cambios de estado containing para periodos dados.Formato [{"period_from": "<period_from>", "period_to": "<period_to>"}, ...] - period_from siendo una fecha inicial (incluso; n¨²mero entero marcadetiempo) y period_to siendo una fecha final (exclusivo; n¨²mero de tiempo marcadetiempo) para los periodos que le interesan.Devuelve una matriz de entradas conteniendo una propiedad start_value y una matriz alarms para los cambios de estado dentro de periodos espec¨ªficos. |
| sortfield | cadena/matriz | Ordenar el resultado por las propiedades dadas. Los valores posibles son: serviceid, name, status, sortorder y created_at. |
| countOutput | booleano | Estos parametros siendo comunes para todos los m¨¦todos get son are descriptos en detalle en reference commentary. |
| editable | booleano | |
| excludeSearch | booleano | |
| filter | objeto | |
| limit | n¨²mero entero | |
| output | consulta | |
| preservekeys | booleano | |
| search | objeto | |
| searchByAny | booleano | |
| searchWildcardsEnabled | booleano | |
| sortorder | cadena/matriz | |
| startSearch | booleano |
Valores de retorno
(integer/array) Devuelve:
- una matriz de objetos;
- el recuento de objetos recuperados, si el par¨¢metro
countOutputha sido usado.
Ejemplos
Recuperar todos los servicios
Recupere toda la data sobre todos los servicios y sus relaciones.
Solicitud:
{
"jsonrpc": "2.0",
"method": "service.get",
"params": {
"output": "extend",
"selectChildren": "extend",
"selectParents": "extend"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Respuesta:
{
"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
}Fuente
CService::get() en ui/include/classes/api/services/CService.php.