Documentation
Table of Contents
templatedashboard.get
Descripción
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.
Parámetros
(object) Parámetros que definen la salida deseada.
El método admite los siguientes parámetros.
| Parámetro | Tipo | Descripción |
|---|---|---|
| imageids | cadena/matriz | Devuelve solo imágenes con los IDs proporcionados. |
| sysmapids | cadena/matriz | Devuelve imágenes que se utilizan en los mapas dados. |
| select_image | flag | Devuelve una propiedad image con la imagen codificada en Base64. |
| sortfield | cadena/matriz | Ordena el resultado según las propiedades dadas. Los valores posibles son: imageid y name. |
| countOutput | booleano | Estos parámetros, que son comunes para todos los métodos get, se describen en detalle en el reference commentary. |
| editable | booleano | |
| excluirBuscar | booleano | |
| filtro | objeto | |
| límite | número entero | |
| salida | consulta | |
| preservekeys | booleano | |
| buscar | objeto | |
| searchByAny | booleano | |
| searchWildcardsEnabled | booleano | |
| clasificación | 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 tableros
Recupere todas las plantillas de tableros con widgets para una plantilla específicada.
Solicitud:
{
"jsonrpc": "2.0",
"method": "templatedashboard.get",
"params": {
"output": "extend",
"selectPages": "extend",
"templateids": "10001"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"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": "12",
"height": "5",
"view_mode": "0",
"fields": [
{
"type": "6",
"name": "graphid",
"value": "1125"
}
]
},
{
"widgetid": "221",
"type": "graph",
"name": "",
"x": "12",
"y": "0",
"width": "12",
"height": "5",
"view_mode": "0",
"fields": [
{
"type": "6",
"name": "graphid",
"value": "1129"
}
]
},
{
"widgetid": "222",
"type": "graph",
"name": "",
"x": "0",
"y": "5",
"width": "12",
"height": "5",
"view_mode": "0",
"fields": [
{
"type": "6",
"name": "graphid",
"value": "1128"
}
]
},
{
"widgetid": "223",
"type": "graph",
"name": "",
"x": "12",
"y": "5",
"width": "12",
"height": "5",
"view_mode": "0",
"fields": [
{
"type": "6",
"name": "graphid",
"value": "1126"
}
]
},
{
"widgetid": "224",
"type": "graph",
"name": "",
"x": "0",
"y": "10",
"width": "12",
"height": "5",
"view_mode": "0",
"fields": [
{
"type": "6",
"name": "graphid",
"value": "1127"
}
]
}
]
}
]
}
],
"id": 1
}Ver también
- [Página de la plantilla de tablero] (object#template_dashboard_page)
- [Widget de la plantilla de tablero] (object#template_dashboard_widget)
- Campo de Widget de la plantilla de tablero
Fuente
CTemplateDashboard::get() en ui/include/classes/api/services/CTemplateDashboard.php.