Documentation
Table of Contents
templategroup.get
¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô
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.
±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç²õ
(objeto) ±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç²õ que definen la salida deseada.
El m¨¦todo admite los siguientes par¨¢metros.
| ±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç | Tipo | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô |
|---|---|---|
| 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
countOutputha sido usado.
Ejemplos
Recuperando datos por nombre
Recupere todos los datos sobre dos grupos de plantillas denominados "Templates/Databases" y "Templates/Modules".
{
"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.