templategroup.get

Descrição

integer/array templategroup.get(object parameters)

O método permite recuperar grupos de templates 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
graphids	ID/array	Retorna apenas grupos de templates que contenham templates com os gráficos informados.
groupids	ID/array	Retorna apenas grupos de templates com os IDs de grupo de template informados.
templateids	ID/array	Retorna apenas grupos de templates que contenham os templates informados.
triggerids	ID/array	Retorna apenas grupos de templates que contenham templates com os triggers informados.
with_graphs	flag	Retorna apenas grupos de templates que contenham templates com gráficos.
with_graph_prototypes	flag	Retorna apenas grupos de templates que contenham templates com protótipos de gráficos.
with_httptests	flag	Retorna apenas grupos de templates que contenham templates com verificações web.
with_items	flag	Retorna apenas grupos de templates que contenham templates com items. Sobrescreve os parâmetros `with_simple_graph_items`.
with_item_prototypes	flag	Retorna apenas grupos de templates que contenham templates com protótipos de item. Sobrescreve o parâmetro `with_simple_graph_item_prototypes`.
with_simple_graph_item_prototypes	flag	Retorna apenas grupos de templates que contenham templates com protótipos de item, que estejam habilitados para criação e tenham tipo de informação numérica.
with_simple_graph_items	flag	Retorna apenas grupos de templates que contenham templates com items numéricos.
with_templates	flag	Retorna apenas grupos de templates que contenham templates.
with_triggers	flag	Retorna apenas grupos de templates que contenham templates com triggers.
selectTemplates	query	Retorna uma propriedade `templates` com os templates que pertencem ao grupo de template. Suporta `count`.
limitSelects	integer	Limita o número de registros retornados por subconsultas. Aplica-se às seguintes subconsultas: `selectTemplates` - os resultados serão classificados por `template`.
sortfield	string/array	Classifica o resultado pelas propriedades informadas. Valores possíveis: `groupid`, `name`.
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 dados pelo nome

Recupere todos os dados sobre dois grupos de templates chamados "Templates/Databases" e "Templates/Modules".

Requisição:

{
           "jsonrpc": "2.0",
           "method": "templategroup.get",
           "params": {
               "output": "extend",
               "filter": {
                   "name": [
                       "Templates/Databases",
                       "Templates/Modules"
                   ]
               }
           },
           "id": 1
       }

Resposta:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "groupid": "13",
                   "name": "Templates/Databases",
                   "uuid": "748ad4d098d447d492bb935c907f652f"
               },
               {
                   "groupid": "8",
                   "name": "Templates/Modules",
                   "uuid": "57b7ae836ca64446ba2c296389c009b7"
               }
           ],
           "id": 1
       }

Veja também

Template

Origem

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

Documentation