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. Veja Funções de usuário para 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	Descrição
serviceids	ID/array	Retorna apenas os serviços com os IDs fornecidos.
parentids	ID/array	Retorna apenas os serviços que estão vinculados aos serviços pai fornecidos.
deep_parentids	flag	Retorna todos os serviços filhos diretos e indiretos. Usado junto com `parentids`.
childids	ID/array	Retorna apenas os serviços que estão vinculados aos serviços filhos fornecidos.
evaltype	integer	Regras para busca de tags. Valores possíveis: 0 - (padrão) E/OU; 2 - OU.
tags	object/array	Retorna apenas os serviços com as tags fornecidas. Correspondência exata por tag e busca sensível ou não a maiúsculas/minúsculas pelo valor da tag, dependendo do valor do operador. Formato: `[{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...]`. Um array vazio retorna todos os serviços. Valores possíveis para o operador: 0 - (padrão) Contém (correspondência de substring, não sensível a maiúsculas/minúsculas); 1 - Igual (sensível a maiúsculas/minúsculas); 2 - Não contém (correspondência de substring, não sensível a maiúsculas/minúsculas); 3 - Diferente (sensível a maiúsculas/minúsculas); 4 - Existe; 5 - Não existe.
problem_tags	object/array	Retorna apenas os serviços com as tags de problema fornecidas. Correspondência exata por tag e busca sensível ou não a maiúsculas/minúsculas pelo valor da tag, dependendo do valor do operador. Formato: `[{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...]`. Um array vazio retorna todos os serviços. Valores possíveis para o operador: 0 - (padrão) Contém (correspondência de substring, não sensível a maiúsculas/minúsculas); 1 - Igual (sensível a maiúsculas/minúsculas); 2 - Não contém (correspondência de substring, não sensível a maiúsculas/minúsculas); 3 - Diferente (sensível a maiúsculas/minúsculas); 4 - Existe; 5 - Não existe.
without_problem_tags	flag	Retorna apenas os serviços sem tags de problema.
slaids	ID/array	Retorna apenas os serviços que estão vinculados ao(s) SLA(s) específico(s).
selectChildren	query	Retorna uma propriedade `children` com os serviços filhos. Suporta `count`.
selectParents	query	Retorna uma propriedade `parents` com os serviços pais. Suporta `count`.
selectTags	query	Retorna uma propriedade `tags` com as tags do serviço. Suporta `count`.
selectProblemEvents	query	Retorna uma propriedade `problem_events` com um array de objetos de eventos de problema. O objeto de evento de problema possui as seguintes propriedades: `eventid` - `(ID)` ID do evento; `severity` - `(string)` Gravidade atual do evento; `name` - `(string)` Nome do evento resolvido. Suporta `count`.
selectProblemTags	query	Retorna uma propriedade `problem_tags` com as tags de problema. Suporta `count`.
selectStatusRules	query	Retorna uma propriedade `status_rules` com as regras de status. Suporta `count`.
selectStatusTimeline	object/array	Retorna uma propriedade `status_timeline` contendo as mudanças de estado do serviço para os períodos fornecidos. Formato `[{"period_from": "<period_from>", "period_to": "<period_to>"}, ...]` - `period_from` sendo a data de início (inclusiva; timestamp inteiro) e `period_to` sendo a data de término (exclusiva; timestamp inteiro) para o período de interesse. Retorna um array de entradas contendo uma propriedade `start_value` e um array `alarms` para as mudanças de estado dentro dos períodos especificados.
sortfield	string/array	Ordena o resultado pelas propriedades fornecidas. Valores possíveis: `serviceid`, `name`, `status`, `sortorder`, `created_at`.
countOutput	boolean	Esses parâmetros são descritos 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:

um array de objetos;
a contagem de objetos recuperados, se o parâmetro countOutput tiver sido usado.

Exemplos

Recuperando todos os serviços

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

Requisição:

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

Origem

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

Documentation