报告.创建

说明

object report.create(object/array reports)

该方法允许用户用于创建新的规划报告。

该方式仅对管理员超级管理员类型的用户有效。 用户可以在用户职责设置中对该方式的使用权限进行设定修改。请参考 用户角色以获取更多信息。

参数说明

(object/array) 创建规划报告。 除此之外,根据定时报表属性,该方式允许配置以下参数。

参数 类型 说明
users 对象/包含对象的数组 需要发送报告的用户
user_groups 对象/包含对象的数组 需要发送报告的用户组

返回值

根据reportids的特性,(object)会返回一个对象,包含已创建的规划报告ID。 返回的ID顺序与发送的规划报告顺序保持一致。

参考示例

创建计划报告

创建一个周报,从2021-04-01到2021-08-31,每周一到周五12:00,发送上一周的报告。

请求:

{
    "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"
            }
        ]
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

响应:

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

另请参考

参考来源

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