报告.获取

说明

integer/array report.get(object parameters)

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

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

参数

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

该方法支持如下参数。

参数类型说明
reportids字符串/数组根据设定的ID号返回对应定时报表。
expired布尔值若设定为true则只返回失效的定时报表，若设定为false，则只返回有效的定时报表。
selectUsers搜索请求返回报告所设定的发送目标的用户属性。
selectUserGroups搜索请求返回报告所定的发送目标的用户组 属性。
sortfield字符串/数组设定属性参数用来分类返回数据。

可设定的参数包括：reportid, name, status.
countOutput布尔值该类参数在所有的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.            "auth": "038e1d7b1735c6a5436ee9eae095879e",
  11.            "id": 1
  12.        }

响应：

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

另请参考

参考来源

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