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

(objeto) 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 plantillas que contienen plantillas con los gráficos indicados.
groupids	ID/array	Devolver solo los grupos de plantillas con los IDs de grupo de plantillas indicados.
templateids	ID/array	Devolver solo los grupos de plantillas que contienen las plantillas indicadas.
triggerids	ID/array	Devolver solo los grupos de plantillas que contienen plantillas con las acciones indicadas.
with_graphs	flag	Devolver solo los grupos de plantillas que contienen plantillas con gráficos.
with_graph_prototypes	flag	Devolver solo los grupos de plantillas que contienen plantillas con prototipos de gráficos.
with_httptests	flag	Devolver solo los grupos de plantillas que contienen plantillas con comprobaciones web.
with_items	flag	Devolver solo los grupos de plantillas que contienen plantillas con elementos. Sobrescribe los parámetros `with_simple_graph_items`.
with_item_prototypes	flag	Devolver solo los grupos de plantillas que contienen plantillas con prototipos de elementos. Sobrescribe el parámetro `with_simple_graph_item_prototypes`.
with_simple_graph_item_prototypes	flag	Devolver solo los grupos de plantillas que contienen plantillas con prototipos de elementos, que están habilitados para la creación y tienen tipo de información numérica.
with_simple_graph_items	flag	Devolver solo los grupos de plantillas que contienen plantillas con elementos numéricos.
with_templates	flag	Devolver solo los grupos de plantillas que contienen plantillas.
with_triggers	flag	Devolver solo los grupos de plantillas que contienen plantillas con acciones.
selectTemplates	query	Devolver una propiedad `templates` con las plantillas que pertenecen al grupo de plantillas. Admite `count`.
limitSelects	entero	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	booleano	Estos parámetros se describen en el comentario de referencia.
editable	booleano
excludeSearch	booleano
filter	objeto
limit	entero
output	query
preservekeys	booleano
search	objeto
searchByAny	booleano
searchWildcardsEnabled	booleano
sortorder	string/array
startSearch	booleano

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