service.get

Descrição

integer/array service.get(object parameters)

O método permite recuperar serviços de acordo com os parâmetros fornecidos.

Este método está disponível para usuários de qualquer tipo. As permissões para chamar o método podem ser revogadas nas configurações de função do usuário. Consulte Funções do usuário para obter mais informações.

Parâmetros

(object) Parâmetros que definem a saída desejada.

O método suporta os seguintes parâmetros.

Parâmetro	Tipo
serviceids	string/array	Retornar apenas serviços com os IDs fornecidos.
parentids	string/array	Retornar apenas serviços vinculados aos serviços pai fornecidos.
deep_parentids	flag	Retornar todos os serviços filhos diretos e indiretos. Usado junto com `parentids`.
childids	string/array	Retornar apenas serviços vinculados aos serviços filho fornecidos.
evaltype	integer	Regras para pesquisa de etiquetas. Valores possíveis: 0 - (padrão) E/Ou; 2 - Ou.
tags	object/array of objects	Retornar apenas serviços com as etiquetas fornecidas. Correspondência exata por etiqueta e pesquisa com distinção entre maiúsculas e minúsculas por valor de etiqueta, dependendo do valor do operador. Formato: `[{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...]`. Uma array vazia retorna todos os serviços. Valores de operador possíveis: 0 - (padrão) Contém; 1 - Igual a; 2 - Não contém; 3 - Não é igual; 4 - Existe; 5 - Não existe.
problem_tags	object/array of objects	Retornar apenas serviços com as etiquetas de problema fornecidas. Correspondência exata por etiqueta e pesquisa com distinção entre maiúsculas e minúsculas por valor de etiqueta, dependendo do valor do operador. Formato: `[{"tag": "<tag>", "value": "<value>", " operator": "<operator>"}, ...]`. Um array vazio retorna todos os serviços. Possíveis valores de operador: 0 - (padrão) Contém;<br >1 - É igual; 2 - Não contém; 3 - Não é igual; 4 - Existe; 5 - Não existe.
without_problem_tags	flag	Retornar apenas serviços sem etiquetas de problema.
slaids	string/array	Retornar apenas os serviços vinculados ao(s) SLA(s) específico(s).
selectChildren	query	Retornar uma propriedade `children` com os serviços filho. Suporta `count`.
selectParents	query	Retornar uma propriedade `parents` com os serviços pai. Suporta `count`.
selectTags	query	Retornar uma propriedade etiquetas com etiquetas de serviço. Suporta `count`.
selectProblemEvents	query	Retornar uma propriedade `problem_events` com uma matriz de objetos de evento de problema. O objeto de evento de problema tem as seguintes propriedades: `eventid` - (string) ID do evento; `severity` - (string) Gravidade do evento atual; `name` - (string) Nome do evento resolvido. Suporta `count`.
selectProblemTags	query	Retornar uma propriedade etiquetas de problema com etiquetas de problema. Suporta `count`.
selectStatusRules	query	Return a status_rules property with status rules. Supports `count`.
selectStatusTimeline	object/array of objects	Retorne uma propriedade `status_timeline` contendo alterações de estado do serviço para determinados períodos. Formato `[{"period_from": "<period_from>", "period_to": "<period_to>"}, ...]` - `period_from` sendo uma data inicial (inclusive; timestamp inteiro) e `period_to` sendo uma data final (exclusiva; timestamp inteiro) para o período em que você está interessado. Retorna um array de entradas contendo uma propriedade `start_value` e um array alarmes para as mudanças de estado dentro de períodos especificados.

sortfield	string/array	Classifique o resultado pelas propriedades fornecidas. Os valores possíveis são: `serviceid`, `name`, `status`, `sortorder` e 'created_at`. \| \| countOutput \| boolean \| Esses parâmetros sendo comuns para todos os métodos`get` são descritos em detalhes no comentário 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

Valores de retorno

(integer/array) Retorna:

uma matriz de objetos;
a contagem de objetos recuperados, se o parâmetro countOutput foi usado.

Exemplos

Recuperando todos os serviços

Recupere todos os dados sobre todos os serviços e suas dependências.

Request:

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

Response:

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

Fonte

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

Documentation