Table of Contents

报告对象

接下来介绍有关report(报告) API 的相关内容。

报表

报表对象具有以下属性:

属性 类型 描述
reportid ID 报表的ID。

属性行为:
- 只读
- 更新操作时所需
userid ID 创建报表的用户的ID。

属性行为:
- 创建操作时所需
name 字符串 报表的唯一名称。

属性行为:
- 创建操作时所需
dashboardid ID 报表所基于的仪表盘的ID。

属性行为:
- 创建操作时所需
period 整数 报表将要准备的周期。

可能的值:
0 - (默认) 前一天;
1 - 前一周;
2 - 前一个月;
3 - 前一年。
cycle 整数 周期重复计划。

可能的值:
0 - (默认) 每日;
1 - 每周;
2 - 每月;
3 - 每年。
start_time 整数 一天中的时间,以秒为单位,报表将准备发送的时间。

默认值:0。
weekdays 整数 发送报表的工作日。

可能的位图值:
1 - 星期一;
2 - 星期二;
4 - 星期三;
8 - 星期四;
16 - 星期五;
32 - 星期六;
64 - 星期日。

这是一个位字段;任何可能的位图值的总和都是可接受的(例如,21表示星期一、星期三和星期五)。

默认值:0。

属性行为:
- 如果cycle设置为“每周”时所需
active_since 字符串 从哪一天开始。

可能的值:
空字符串 - (默认) 未指定(存储为0);
具体日期,格式为YYYY-MM-DD(存储为一天开始(00:00:00)的时间戳)。
active_till 字符串 在哪一天结束。

可能的值:
空字符串 - (默认) 未指定(存储为0);
具体日期,格式为YYYY-MM-DD(存储为一天结束(23:59:59)的时间戳)。
subject 字符串 报表消息的主题。
message 字符串 报表消息的文本。
status 整数 报表是否启用或禁用。

可能的值:
0 - 禁用;
1 - (默认) 启用。
description 文本 报表的描述。
state 整数 报表的状态。

可能的值:
0 - (默认) 报表尚未处理;
1 - 报表已生成并成功发送给所有收件人;
2 - 报表生成失败;"info"包含错误信息;
3 - 报表已生成,但发送给某些(或所有)收件人失败;"info"包含错误信息。

属性行为:
- 只读
lastsent 时间戳 最后一次成功发送报表的Unix时间戳。

属性行为:
- 只读
info 字符串 错误描述或附加信息。

属性行为:
- 只读

用户

用户对象包含了以下属性:

属性 类型 描述
userid ID 接收报告的用户ID。

属性行为:
- 必须
access_userid ID 生成报告的用户ID。

0 - (默认) 按照接收人生成报告。
exclude integer 是否从邮件列表中排除用户。

可选值:
0 - (默认) 包含;
1 - 不包含.

用户组

用户组对象具有以下属性:

属性 类型 说明
usrgrpid ID 要向其发送报表的用户组的 ID。

属性行为:
- 必需
access_userid ID 将代表其生成报表的用户的 ID。

0 - (默认) 按收件人生成报表。