Se encuentra viendo la documentación de la versión en desarrollo, puede estar incompleta.
Esta página fue traducida automáticamente. Si detectas un error, selecciónalo y presiona Ctrl+Enter para informarlo a los editores.

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 Admin y Super admin. Los permisos para llamar al método pueden ser revocados en la configuración de roles de usuario. Consulte Roles de usuario para obtener más información.

Parámetros

(objeto/array) Informes programados a crear.

Además de las propiedades estándar de informes programados, el método acepta los siguientes parámetros.

Parámetro Tipo Descripción
users objeto/array Usuarios a los que enviar el informe.

Comportamiento del parámetro:
- obligatorio si user_groups no está establecido
user_groups objeto/array Grupos de usuarios a los que enviar el informe.

Comportamiento del parámetro:
- obligatorio si users no está establecido

Valores de retorno

(object) Devuelve un objeto que contiene los IDs de los informes programados creados bajo la propiedad reportids. El orden de los IDs devueltos coincide con el orden de los informes programados enviados.

Ejemplos

Creación de un informe programado

Cree un informe semanal que se preparará para la semana anterior todos los lunes-viernes a las 12:00 desde 2021-04-01 hasta 2021-08-31.

Solicitud:

{
           "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
       }

Véase también

Fuente

CReport::create() en ui/include/classes/api/services/CReport.php.