service.get

Descripción

integer/array service.get(object parameters)

El método permite recuperar servicios según los parámetros dados.

Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método pueden ser revocados en la configuración de roles de usuario. Consulte Roles de usuario para 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	integer	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 según el valor del operador. Formato: `[{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...]`. Un array vacío devuelve todos los servicios. Valores posibles del operador: 0 - (por defecto) Contiene; 1 - Igual; 2 - No contiene; 3 - No es igual; 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 según el valor del operador. Formato: `[{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...]`. Un array vacío devuelve todos los servicios. Valores posibles del operador: 0 - (por defecto) Contiene; 1 - Igual; 2 - No contiene; 3 - No es igual; 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	query	Devolver una propiedad `children` con los servicios hijos. Soporta `count`.
selectParents	query	Devolver una propiedad `parents` con los servicios padre. Soporta `count`.
selectTags	query	Devolver una propiedad `tags` con las etiquetas del servicio. Soporta `count`.
selectProblemEvents	query	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` - `(string)` Severidad actual del evento; `name` - `(string)` Nombre del evento resuelto. Soporta `count`.
selectProblemTags	query	Devolver una propiedad `problem_tags` con las etiquetas de problema. Soporta `count`.
selectStatusRules	query	Devolver una propiedad `status_rules` con las reglas de estado. Soporta `count`.
selectStatusTimeline	objeto/array	Devolver una propiedad `status_timeline` que contiene los cambios de estado del servicio para los periodos indicados. Formato `[{"period_from": "<period_from>", "period_to": "<period_to>"}, ...]` - `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	string/array	Ordenar el resultado por las propiedades indicadas. Valores posibles: `serviceid`, `name`, `status`, `sortorder`, `created_at`.
countOutput	boolean	Estos parámetros se describen en el comentario de referencia.
editable	boolean
excludeSearch	boolean
filter	objeto
limit	integer
output	query
preservekeys	boolean
search	objeto
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

Valores de retorno

(integer/array) Devuelve:

un array de objetos;
el número de objetos recuperados, si se ha utilizado el parámetro countOutput.

Ejemplos

Recuperar todos los servicios

Recupera 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