report.get
描述
integer/array report.get(object parameters)
该方法允许根据给定参数检索预定的报告。
此方法可供任何类型的用户使用。调用该方法的权限可以在用户角色设置中撤销。有关更多信息，请参阅User roles。
参数
(object) 定义期望输出的参数.
该方法支持以下参数.
| 参数 | 数据类型 | 描述 |
|---|---|---|
| reportids | ID/array | 仅返回具有指定报告ID的定时报告. |
| expired | boolean | 若设为true则仅返回已过期的定时报告, 若为false则仅返回活跃的定时报告. |
| selectUsers | query | 返回包含报告发送目标用户的users属性. |
| selectUserGroups | query | 返回包含报告发送目标用户组的user_groups属性. |
| sortfield | string/array | 按指定属性排序结果. 可选值: reportid, name, status. |
| countOutput | boolean | 这些参数在通用get方法参数中有详细说明. |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
返回值
(integer/array) 返回以下两种结果之一:
- 一个包含array的objects数组
- 检索到的objects数量（当使用
countOutput参数时）
示例
检索报告数据
执行请求:
{ "jsonrpc": "2.0", "method": "report.get", "params": [ "output": "extend", "selectUsers": "extend", "selectUserGroups": "extend", "reportids": ["1", "2"] ], "id": 1 }响应:
{ "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 }另请参阅
来源
CReport::get() 位于 ui/include/classes/api/services/CReport.php 文件中。