Documentation
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；
- 如果使用了
countOutput参数，则为检索到的 objects 的数量。
示例
检索报告数据
执行请求:
{
"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 中。