Esta es una traducción de la página de documentación original en español. Ayúdanos a mejorarla.

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 cadena/matriz Devuelve solo grupos de plantillas que contengan plantillas con los gráficos proporcionados.
groupids cadena/matriz Devuelve solo grupos de plantillas con los ID de grupo de plantillas proporcionados.
templateids cadena/matriz Devuelve solo grupos de plantillas que contienen las plantillas dadas.
triggerids cadena/matriz Devuelve solo grupos de plantillas que contengan plantillas con los iniciadores dados.
with_graphs flag Devuelve solo grupos de plantillas que contienen plantillas con gráficos.
with_graph_prototypes flag Devuelve solo grupos de plantillas que contienen plantillas con prototipos de gráficos.
with_httptests flag Devuelve sólo grupos de plantillas que contengan plantillas con comprobaciones web.
with_items flag Devuelve solo grupos de plantillas que contienen plantillas con métricas.

Anula los parámetros with_simple_graph_items.
with_item_prototypes flag Devuelve solo grupos de plantillas que contienen plantillas con prototipos de métricas.

Anula el parámetro with_simple_graph_item_prototypes.
with_simple_graph_item_prototypes flag Devuelve solo grupos de plantillas que contienen plantillas con prototipos de métricas, que están habilitados para la creación y tienen tipo de información numérica.
with_simple_graph_items flag Devuelve solo grupos de plantillas que contienen plantillas con métricas numéricas.
with_templates flag Devuelve sólo grupos de plantillas que contienen plantillas.
with_triggers flag Devuelve solo grupos de plantillas que contienen plantillas con iniciadores.
selectTemplates query Devuelve una propiedad templates con las plantillas que pertenecen al grupo de plantillas.

Admite count.
limitSelects integer Limita el número de registros devueltos por las subselecciones.

Se aplica a las siguientes subselecciones:
selectTemplates: los resultados se ordenarán por plantilla.
sortfield string/array Ordena el resultado según las propiedades dadas.

Valores posibles: groupid, name.
countOutput booleano Estos parámetros, que son comunes para todos los métodos get, se describen en detalle en la página comentario de referencia.
editable booleano
excludeSearch booleano
filter objeto
limit entero
output consulta
preservekeys booleano
search objeto
searchByAny booleano
searchWildcardsEnabled booleano
sortorder cadena/matriz
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

Fuente

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