Table of Contents
report.get
Descripción
integer/array report.get(parámetros del objeto)
El método permite recuperar informes programados según los parámetros proporcionados.
Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método pueden ser revocados en la configuración del rol de usuario. Consulte 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 |
|---|---|---|
| reportids | ID/array | Devolver solo los informes programados con los IDs de informe indicados. |
| expired | booleano | Si se establece en true devuelve solo los informes programados caducados, si es false - solo los informes programados activos. |
| selectUsers | consulta | Devuelve una propiedad users con los usuarios a los que se ha configurado el envío del informe. |
| selectUserGroups | consulta | Devuelve una propiedad user_groups con los grupos de usuarios a los que se ha configurado el envío del informe. |
| sortfield | string/array | Ordena el resultado por las propiedades indicadas. Valores posibles: reportid, name, status. |
| countOutput | booleano | Estos parámetros se describen en el comentario de referencia. |
| excludeSearch | booleano | |
| filter | objeto | |
| limit | entero | |
| output | consulta | |
| preservekeys | booleano | |
| search | objeto | |
| searchByAny | booleano | |
| searchWildcardsEnabled | booleano | |
| sortorder | string/array | |
| startSearch | booleano |
Valores de retorno
(integer/array) Devuelve:
- un array de objetos;
- el número de objetos recuperados, si se ha utilizado el parámetro
countOutput.
Ejemplos
Recuperar datos de informes
{
"jsonrpc": "2.0",
"method": "report.get",
"params": [
"output": "extend",
"selectUsers": "extend",
"selectUserGroups": "extend",
"reportids": ["1", "2"]
],
"id": 1
}Respuesta:
{
"jsonrpc": "2.0",
"result": [
{
"reportid": "1",
"userid": "1",
"name": "Informe semanal",
"dashboardid": "1",
"period": "1",
"cycle": "1",
"start_time": "43200",
"weekdays": "31",
"active_since": "2021-04-01",
"active_till": "2021-08-31",
"subject": "Informe semanal",
"message": "Texto de acompañamiento del informe",
"status": "1",
"description": "Descripción del informe",
"state": "1",
"lastsent": "1613563219",
"info": "",
"users": [
{
"userid": "1",
"access_userid": "1",
"exclude": "0"
},
{
"userid": "2",
"access_userid": "0",
"exclude": "1"
}
],
"user_groups": [
{
"usrgrpid": "7",
"access_userid": "0"
}
]
},
{
"reportid": "2",
"userid": "1",
"name": "Informe mensual",
"dashboardid": "2",
"period": "2",
"cycle": "2",
"start_time": "0",
"weekdays": "0",
"active_since": "2021-05-01",
"active_till": "",
"subject": "Informe mensual",
"message": "Texto de acompañamiento del informe",
"status": "1",
"description": "",
"state": "0",
"lastsent": "0",
"info": "",
"users": [
{
"userid": "1",
"access_userid": "1",
"exclude": "0"
}
],
"user_groups": []
}
],
"id": 1
}Véase también
Fuente
CReport::get() en ui/include/classes/api/services/CReport.php.