service.get

Descripción

integer/array service.get(object parameters)

El método permite recuperar servicios de acuerdo con los parámetros dados.

Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método se puede revocar en la configuración de roles de usuario. Ver Roles de usuario para obtener más información.

Parámetros

(objeto) Parámetros que definen la salida deseada.

El método admite los siguientes parámetros.

Parámetro	Tipo	Descripción
serviceids	ID/array	Devolver solo los servicios con los IDs indicados.
parentids	ID/array	Devolver solo los servicios que están vinculados a los servicios padre indicados.
deep_parentids	flag	Devolver todos los servicios hijos directos e indirectos. Se utiliza junto con `parentids`.
childids	ID/array	Devolver solo los servicios que están vinculados a los servicios hijos indicados.
evaltype	entero	Reglas para la búsqueda de etiquetas. Valores posibles: 0 - (por defecto) Y/O; 2 - O.
tags	objeto/array	Devolver solo los servicios con las etiquetas indicadas. Coincidencia exacta por etiqueta y búsqueda sensible o no sensible a mayúsculas/minúsculas por valor de etiqueta dependiendo del valor del operador. Formato: `[{"tag": "<etiqueta>", "value": "<valor>", "operator": "<operador>"}, ...]`. Un array vacío devuelve todos los servicios. Valores posibles del operador: 0 - (por defecto) Contiene (coincidencia de subcadena, no sensible a mayúsculas/minúsculas); 1 - Igual (sensible a mayúsculas/minúsculas); 2 - No contiene (coincidencia de subcadena, no sensible a mayúsculas/minúsculas); 3 - No es igual (sensible a mayúsculas/minúsculas); 4 - Existe; 5 - No existe.
problem_tags	objeto/array	Devolver solo los servicios con las etiquetas de problema indicadas. Coincidencia exacta por etiqueta y búsqueda sensible o no sensible a mayúsculas/minúsculas por valor de etiqueta dependiendo del valor del operador. Formato: `[{"tag": "<etiqueta>", "value": "<valor>", "operator": "<operador>"}, ...]`. Un array vacío devuelve todos los servicios. Valores posibles del operador: 0 - (por defecto) Contiene (coincidencia de subcadena, no sensible a mayúsculas/minúsculas); 1 - Igual (sensible a mayúsculas/minúsculas); 2 - No contiene (coincidencia de subcadena, no sensible a mayúsculas/minúsculas); 3 - No es igual (sensible a mayúsculas/minúsculas); 4 - Existe; 5 - No existe.
without_problem_tags	flag	Devolver solo los servicios sin etiquetas de problema.
slaids	ID/array	Devolver solo los servicios que están vinculados a los SLA(s) específicos.
selectChildren	consulta	Devolver una propiedad `children` con los servicios hijos. Admite `count`.
selectParents	consulta	Devolver una propiedad `parents` con los servicios padre. Admite `count`.
selectTags	consulta	Devolver una propiedad `tags` con las etiquetas del servicio. Admite `count`.
selectProblemEvents	consulta	Devolver una propiedad `problem_events` con un array de objetos de eventos de problema. El objeto de evento de problema tiene las siguientes propiedades: `eventid` - `(ID)` ID del evento; `severity` - `(cadena)` Severidad actual del evento; `name` - `(cadena)` Nombre del evento resuelto. Admite `count`.
selectProblemTags	consulta	Devolver una propiedad `problem_tags` con las etiquetas de problema. Admite `count`.
selectStatusRules	consulta	Devolver una propiedad `status_rules` con las reglas de estado. Admite `count`.
selectStatusTimeline	objeto/array	Devolver una propiedad `status_timeline` que contiene los cambios de estado del servicio para los periodos indicados. Formato `[{"period_from": "<periodo_desde>", "period_to": "<periodo_hasta>"}, ...]` - `period_from` es la fecha de inicio (inclusive; marca de tiempo entera) y `period_to` es la fecha de fin (exclusiva; marca de tiempo entera) para el periodo de interés. Devuelve un array de entradas que contienen una propiedad `start_value` y un array `alarms` para los cambios de estado dentro de los periodos especificados.
sortfield	cadena/array	Ordenar el resultado por las propiedades indicadas. Valores posibles: `serviceid`, `name`, `status`, `sortorder`, `created_at`.
countOutput	booleano	Estos parámetros se describen en el comentario de referencia.
editable	booleano
excludeSearch	booleano
filter	objeto
limit	entero
output	consulta
preservekeys	booleano
search	objeto
searchByAny	booleano
searchWildcardsEnabled	booleano
sortorder	cadena/array
startSearch	booleano

Valores de retorno

(entero/matriz) Devuelve:

una matriz de objetos;
el recuento de objetos recuperados, si el parámetro countOutput ha sido usado.

Ejemplos

Recuperando todos los servicios

Recupere todos los datos sobre todos los servicios y sus dependencias.

Solicitud:

{
           "jsonrpc": "2.0",
           "method": "service.get",
           "params": {
               "output": "extend",
               "selectChildren": "extend",
               "selectParents": "extend"
           },
           "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.

Documentation