Documentation
Table of Contents
templatedashboard.get
¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô
integer/array templatedashboard.get(object parameters)
El m¨¦todo permite recuperar plantillas de tableros 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 | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô |
|---|---|---|
| dashboardids | ID/matriz | Devuelve solo paneles de plantilla con los ID proporcionados. |
| templateids | ID/matriz | Devuelve solo paneles de plantilla que pertenecen a las plantillas dadas. |
| selectPages | query | Devuelve una propiedad pages con p¨¢ginas de panel de plantilla, ordenadas correctamente. |
| sortfield | string/array | Ordena el resultado seg¨²n las propiedades dadas. Valores posibles: dashboardid, name. |
| countOutput | boolean | Estos par¨¢metros, que son comunes para todos los m¨¦todos get, se describen en detalle en el comentario de referencia. |
| editable | booleano | |
| excluirBuscar | booleano | |
| filtro | objeto | |
| ±ô¨ª³¾¾±³Ù±ð | entero | |
| salida | consulta | |
| preservekeys | booleano | |
| buscar | objeto | |
| searchByAny | booleano | |
| searchWildcardsEnabled | booleano | |
| ³¦±ô²¹²õ¾±´Ú¾±³¦²¹³¦¾±¨®²Ô | cadena/matriz | |
| iniciarBuscar | booleano |
Valores de retorno
(entero/matriz) Devuelve:
- una matriz de objetos;
- el recuento de objetos recuperados, si el par¨¢metro
countOutputha sido usado.
Ejemplos
Recuperar plantillas de dashboards
Recupere todas las plantillas de dashboards con widgets para una plantilla espec¨ªfica.
{
"jsonrpc": "2.0",
"method": "templatedashboard.get",
"params": {
"output": "extend",
"selectPages": "extend",
"templateids": "10001"
},
"id": 1
}Respuesta:
{
"jsonrpc": "2.0",
"result": [
{
"dashboardid": "23",
"name": "Docker overview",
"templateid": "10001",
"display_period": "30",
"auto_start": "1",
"uuid": "6dfcbe0bc5ad400ea9c1c2dd7649282f",
"pages": [
{
"dashboard_pageid": "1",
"name": "",
"display_period": "0",
"widgets": [
{
"widgetid": "220",
"type": "graph",
"name": "",
"x": "0",
"y": "0",
"width": "36",
"height": "5",
"view_mode": "0",
"fields": [
{
"type": "6",
"name": "graphid",
"value": "1125"
}
]
},
{
"widgetid": "221",
"type": "graph",
"name": "",
"x": "12",
"y": "0",
"width": "36",
"height": "5",
"view_mode": "0",
"fields": [
{
"type": "6",
"name": "graphid",
"value": "1129"
}
]
},
{
"widgetid": "222",
"type": "graph",
"name": "",
"x": "0",
"y": "5",
"width": "36",
"height": "5",
"view_mode": "0",
"fields": [
{
"type": "6",
"name": "graphid",
"value": "1128"
}
]
},
{
"widgetid": "223",
"type": "graph",
"name": "",
"x": "12",
"y": "5",
"width": "36",
"height": "5",
"view_mode": "0",
"fields": [
{
"type": "6",
"name": "graphid",
"value": "1126"
}
]
},
{
"widgetid": "224",
"type": "graph",
"name": "",
"x": "0",
"y": "10",
"width": "36",
"height": "5",
"view_mode": "0",
"fields": [
{
"type": "6",
"name": "graphid",
"value": "1127"
}
]
}
]
}
]
}
],
"id": 1
}Ver tambi¨¦n
- [P¨¢gina de plantilla de tablero] (object#template_dashboard_page)
- [Widget deplantilla de tablero] (object#template_dashboard_widget)
- Campo de Widget de plantilla de tablero
Fuente
CTemplateDashboard::get() en ui/include/classes/api/services/CTemplateDashboard.php.