report.get

Descripción

integer/array report.get(object parameters)

El método permite recuperar informes programados 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 pueden revocar en la configuración de roles de usuario. Ver Roles de usuario para obtener más información.

Parameters

(object) Parameters defining the desired output.

The method supports the following parameters.

Parameter	Type	Description
reportids	string/array	Return only scheduled reports with the given report IDs.
expired	boolean	If set to `true` returns only expired scheduled reports, if `false` - only active scheduled reports.
selectUsers	query	Return a users property the report is configured to be sent to.
selectUserGroups	query	Return a user_groups property the report is configured to be sent to.
sortfield	string/array	Sort the result by the given properties. Possible values are: `reportid`, `name`, `status`.
countOutput	boolean	These parameters being common for all `get` methods are described in detail in the reference commentary page.
excludeSearch	boolean
filter	object
limit	integer
output	query
preservekeys	boolean
search	object
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

Valores de retorno

(entero/matriz) Devuelve:

una matriz de objetos;
el recuento de objetos recuperados, si el parámetro countOutput ha sido usado.

Ejemplos

Recuperando datos del informe

Solicitud:

{
           "jsonrpc": "2.0",
           "method": "report.get",
           "params": [
               "output": "extend",
               "selectUsers": "extend",
               "selectUserGroups": "extend",
               "reportids": ["1", "2"]
           ],
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Respuesta:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "reportid": "1",
                   "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",
                   "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": "Monthly report",
                   "dashboardid": "2",
                   "period": "2",
                   "cycle": "2",
                   "start_time": "0",
                   "weekdays": "0",
                   "active_since": "2021-05-01",
                   "active_till": "",
                   "subject": "Monthly report",
                   "message": "Report accompanying text",
                   "status": "1",
                   "description": "",
                   "state": "0",
                   "lastsent": "0",
                   "info": "",
                   "users": [
                       {
                           "userid": "1",
                           "access_userid": "1",
                           "exclude": "0"
                       }
                   ],
                   "user_groups": []
               }
           ],
           "id": 1
       }

Ver también

Fuente

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

Documentation