templategroup.get

Descripción

integer/array templategroup.get(object parameters)

El método permite recuperar grupos de plantillas 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

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

El método admite los siguientes parámetros.

Parámetro	Tipo	Descripción
graphids	ID/array	Devolver solo los grupos de templates que contienen templates con los gráficos indicados.
groupids	ID/array	Devolver solo los grupos de templates con los IDs de grupo de templates indicados.
templateids	ID/array	Devolver solo los grupos de templates que contienen los templates indicados.
triggerids	ID/array	Devolver solo los grupos de templates que contienen templates con los triggers indicados.
with_graphs	boolean	Devolver solo los grupos de templates que contienen templates con gráficos.
with_graph_prototypes	boolean	Devolver solo los grupos de templates que contienen templates con prototipos de gráficos.
with_httptests	boolean	Devolver solo los grupos de templates que contienen templates con comprobaciones web.
with_items	boolean	Devolver solo los grupos de templates que contienen templates con items. Sobrescribe los parámetros `with_simple_graph_items`.
with_item_prototypes	boolean	Devolver solo los grupos de templates que contienen templates con prototipos de items. Sobrescribe el parámetro `with_simple_graph_item_prototypes`.
with_simple_graph_item_prototypes	boolean	Devolver solo los grupos de templates que contienen templates con prototipos de items, que están habilitados para la creación y tienen tipo de información numérica.
with_simple_graph_items	boolean	Devolver solo los grupos de templates que contienen templates con items numéricos.
with_templates	boolean	Devolver solo los grupos de templates que contienen templates.
with_triggers	boolean	Devolver solo los grupos de templates que contienen templates con triggers.
selectTemplates	query	Devolver una propiedad `templates` con los templates que pertenecen al grupo de templates. Admite `count`.
limitSelects	integer	Limita el número de registros devueltos por subconsultas. Se aplica a las siguientes subconsultas: `selectTemplates` - los resultados se ordenarán por `template`.
sortfield	string/array	Ordenar el resultado por las propiedades indicadas. Valores posibles: `groupid`, `name`.
countOutput	boolean	Estos parámetros se describen en el comentario de referencia.
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

(entero/matriz) Devuelve:

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

Ejemplos

Recuperando datos por nombre

Recupere todos los datos sobre dos grupos de plantillas denominados "Templates/Databases" y "Templates/Modules".

Solicitud:

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

Respuesta:

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

Ver también

Plantilla

Fuente

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

Documentation