report.create

描述

object report.create(object/array reports)

此方法允许create新的定时报告。

此方法仅适用于AdminSuper admin用户类型。可以在用户角色设置中撤销调用该方法的权限。更多信息请参见User roles

参数

(object/array) 用于创建的计划报告。

除了 报告,该方法还接受以下参数。

参数 数据类型 描述
users object/array 要将报告发送到的用户

参数行为
- 如果未设置 user_groups,则为必填
user_groups object/array 要将报告发送到的用户组

参数行为
- 如果未设置 users,则为必填

返回值

(object) 返回一个 object,其中包含在 reportids 属性下列出的已创建计划报告的 ID。返回的 ID 顺序与传入的计划报告顺序一致。

示例

创建定时报告

创建一份每周报告,该报告将在每个周一至周五的 12:00 为前一周生成,时间范围为 2021-04-01 至 2021-08-31。

执行请求:

{
           "jsonrpc": "2.0",
           "method": "report.create",
           "params": {
               "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",
               "users": [
                   {
                       "userid": "1",
                       "access_userid": "1",
                       "exclude": "0"
                   },
                   {
                       "userid": "2",
                       "access_userid": "0",
                       "exclude": "1"
                   }
               ],
               "user_groups": [
                   {
                       "usrgrpid": "7",
                       "access_userid": "0"
                   }
               ]
           },
           "id": 1
       }

响应:

{
           "jsonrpc": "2.0",
           "result": {
               "reportids": [
                   "1"
               ]
           },
           "id": 1
       }

另请参阅

来源

CReport::create() 在 ui/include/classes/api/services/CReport.php 中。