获取

说明

integer/array report.get(object parameters)

该方法帮助用户根据所提供的参数来检索计划报表。

该方法可供所有类型的用户使用。 用户可以在用户角色设置中对该方式的使用权限进行设定修改。请参考 用户角色以获取更多信息。

参数

(object) 定义了需求输出的参数。

该方法支持如下参数。

参数类型说明
reportidsID/array根据指定的ID返回对应计划报表。
expiredboolean若设定为true则只返回失效的计划报表，若设定为false，则只返回有效的计划报表。
selectUsersquery返回报告所设定的发送目标的用户属性。
selectUserGroupsquery返回报告所定的发送目标的用户组 属性。
sortfieldstring/array设定属性参数用来分类返回数据。

可设定的参数包括：reportid, name, status.
countOutputboolean该类参数在所有的get方法中应用广泛，用户可以参考引用评论 页面来获取更多详细信息。
excludeSearchboolean
filterobject
limitinteger
outputquery
preservekeysboolean
searchobject
searchByAnyboolean
searchWildcardsEnabledboolean
sortorderstring/array
startSearchboolean

返回值

(integer/array) 返回下列两种数值之一：

  • 一组对象；
  • 在countOutput参数应用的情况下，返回检索对象的数量。

参考示例

检索报告数据

请求:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "method": "report.get",
  4.            "params": [
  5.                "output" :  "extend",
  6.                "selectUsers" : "extend",
  7.                "selectUserGroups" : "extend",
  8.                "reportids" :  ["1", "2"]
  9.            ],
  10.            "id": 1
  11.        }

响应:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "result": [{
  4.                "reportid": "1",
  5.                "userid": "1",
  6.                "name": "Weekly report",
  7.                "dashboardid": "1",
  8.                "period": "1",
  9.                "cycle": "1",
  10.                "start_time": "43200",
  11.                "weekdays": "31",
  12.                "active_since": "2021-04-01",
  13.                "active_till": "2021-08-31",
  14.                "subject": "Weekly report",
  15.                "message": "Report accompanying text",
  16.                "status": "1",
  17.                "description": "Report description",
  18.                "state": "1",
  19.                "lastsent": "1613563219",
  20.                "info": "",
  21.                "users": [{
  22.                    "userid": "1",
  23.                    "access_userid": "1",
  24.                    "exclude": "0"
  25.                }, {
  26.                    "userid": "2",
  27.                    "access_userid": "0",
  28.                    "exclude": "1"
  29.                }],
  30.                "user_groups": [{
  31.                    "usrgrpid": "7",
  32.                    "access_userid": "0"
  33.                }]
  34.            }, {
  35.                "reportid": "2",
  36.                "userid": "1",
  37.                "name": "Monthly report",
  38.                "dashboardid": "2",
  39.                "period": "2",
  40.                "cycle": "2",
  41.                "start_time": "0",
  42.                "weekdays": "0",
  43.                "active_since": "2021-05-01",
  44.                "active_till": "",
  45.                "subject": "Monthly report",
  46.                "message": "Report accompanying text",
  47.                "status": "1",
  48.                "description": "",
  49.                "state": "0",
  50.                "lastsent": "0",
  51.                "info": "",
  52.                "users": [{
  53.                    "userid": "1",
  54.                    "access_userid": "1",
  55.                    "exclude": "0"
  56.                }],
  57.                "user_groups": []
  58.            }],
  59.            "id": 1
  60.        }

另请参考

参考来源

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