report.create
Descripción
object report.create(object/array reports)
Este método permite crear nuevos informes programados.
Este método solo está disponible para los tipos de usuario Administrador y Superadministrador. Los permisos para llamar al método se pueden revocar en la configuración del rol de usuario. Ver Roles de usuario para más información.
Parámetros
(object/array) Informes programados a crear.
Además de las propiedades estándar del informe programado , el método acepta los siguientes parámetros.
| Parámetro | Tipo | Descripción |
|---|---|---|
| users | object/array | Usuarios a los que enviar el informe. Comportamiento del parámetro: - obligatorio si user_groups no está establecido |
| user_groups | object/array | Grupos de usuarios a los que enviar el informe. Comportamiento del parámetro: - obligatorio si users no está establecido |
Valores de retorno
(objeto) Devuelve un objeto que contiene los ID de los informes programados creados
bajo la propiedad reportids. El orden de las identificaciones devueltas.
coincide con el orden de los informes programados pasados.
Ejemplos
Creando un informe programado
Crear un informe semanal que se preparará para la semana anterior de lunes a viernes a las 12:00 horas del 01-04-2021 al 31-08-2021.
{
"jsonrpc": "2.0",
"method": "report.create",
"params": {
"userid": "1",
"name": "Weekly report",
"dashboardid": "1",
"period": "1",
"cycle": "1",
"start_time": "43200",
"weekdays": "31",
"active_since": "2021-04-01",
"active_till": "2021-08-31",
"subject": "Weekly report",
"message": "Report accompanying text",
"status": "1",
"description": "Report description",
"users": [
{
"userid": "1",
"access_userid": "1",
"exclude": "0"
},
{
"userid": "2",
"access_userid": "0",
"exclude": "1"
}
],
"user_groups": [
{
"usrgrpid": "7",
"access_userid": "0"
}
]
},
"id": 1
}Respuesta:
{
"jsonrpc": "2.0",
"result": {
"reportids": [
"1"
]
},
"id": 1
}Ver también
Fuente
CReport::create() en ui/include/classes/api/services/CReport.php.