[comment]: # translation:outdated

[comment]: # ({c7f20528-f9e8f670})
# templategroup.get

[comment]: # ({/c7f20528-f9e8f670})

[comment]: # ({97635317-b5ff62ed})
### Descripción

`integer/array templategroup.get(object parameters)`

El método permite recuperar grupos de plantillas de acuerdo con los
parámetros dados.

::: noteclassic
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](/manual/web_interface/frontend_sections/users/user_roles)
para obtener más información.
:::

[comment]: # ({/97635317-b5ff62ed})

[comment]: # ({e487392c-6102edd8})
### Parámetros

`(objeto)` Parámetros que definen la salida deseada.

El método admite los siguientes parámetros.

|Parámetro|[Tipo](/manual/api/reference_commentary#data_types)|Descripción|
|--|--|------|
|graphids|ID/array|Devuelve solo grupos de plantillas que contengan plantillas con los gráficos proporcionados.|
|groupids|ID/matriz|Devuelve solo grupos de plantillas con los ID de grupo de plantillas proporcionados.|
|templateids|ID/matriz|Devuelve solo los grupos de plantillas que contienen las plantillas proporcionadas.|
|triggerids|ID/matriz|Devuelve solo grupos de plantillas que contengan plantillas con los activadores 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 elementos.<br><br>Anula los parámetros `with_simple_graph_items`.|
|with\_item\_prototypes|flag|Devuelve solo grupos de plantillas que contienen plantillas con prototipos de elementos.<br><br>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 elementos, 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 elementos numéricos.|
|with\_templates|flag|Devuelve sólo grupos de plantillas que contienen plantillas.|
|with\_triggers|flag|Devuelve solo grupos de plantillas que contienen plantillas con activadores.|
|selectTemplates|query|Devuelve una propiedad [`templates`](/manual/api/reference/template/object) con las plantillas que pertenecen al grupo de plantillas.<br><br>Admite `count`.|
|limitSelects|integer|Limita el número de registros devueltos por las subselecciones.<br><br>Se aplica a las siguientes subselecciones:<br>`selectTemplates`: los resultados se ordenarán por `plantilla`.|
|sortfield|string/array|Ordena el resultado según las propiedades dadas.<br><br>Valores posibles: `groupid`, `name`.|
|countOutput|boolean|Estos parámetros, que son comunes para todos los métodos `get`, se describen en detalle en la página [comentario de referencia](/manual/api/reference_commentary#common_get_method_parameters).|
|editable|booleano|^|
|excluirBuscar|booleano|^|
|filtro|objeto|^|
|límite|entero|^|
|salida|consulta|^|
|preservekeys|booleano|^|
|buscar|objeto|^|
|searchByAny|booleano|^|
|searchWildcardsEnabled|booleano|^|
|clasificación|cadena/matriz|^|
|iniciarBuscar|booleano|^|

[comment]: # ({/e487392c-6102edd8})

[comment]: # ({7223bab1-2bc18eb2})
### Valores de retorno

`(entero/matriz)` Devuelve:

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

[comment]: # ({/7223bab1-2bc18eb2})

[comment]: # ({b41637d2-802b3dd1})
### Ejemplos

[comment]: # ({/b41637d2-802b3dd1})

[comment]: # ({3ca44c43-c32b9462})
#### Recuperando datos por nombre

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

[Solicitud](/manual/api#performing-requests):

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

Respuesta:

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

[comment]: # ({/3ca44c43-c32b9462})

[comment]: # ({f3cd9368-585b4960})
### Ver también

- [Plantilla](/manual/api/reference/template/object#template)

[comment]: # ({/f3cd9368-585b4960})

[comment]: # ({9f94aa1e-31239fd5})
### Fuente

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

[comment]: # ({/9f94aa1e-31239fd5})
