Reportオブジェクト

次のオブジェクトは、reportAPIに直接関連しています。

レポート

レポートオブジェクトには、以下のプロパティがあります。

プロパティ 型 説明
reportid ID レポートのID。

プロパティの動作:
- 読み取り専用
- 更新操作では 必須
userid ID レポートを作成したユーザーのID。

プロパティの動作:
- 作成操作では 必須
name string レポートの一意な名前。

プロパティの動作:
- 作成操作では 必須
dashboardid ID レポートのベースとなるダッシュボードのID。

プロパティの動作:
- 作成操作では 必須
period integer レポートを作成する対象期間。

指定可能な値:
0 - (デフォルト) 前日;
1 - 前週;
2 - 前月;
3 - 前年。
cycle integer 期間の繰り返しスケジュール。

指定可能な値:
0 - (デフォルト) 毎日;
1 - 毎週;
2 - 毎月;
3 - 毎年。
start_time integer レポートを送信するために作成する時刻を、その日の開始からの秒数で表したもの。

デフォルト: 0。
weekdays integer レポートを送信する曜日。

指定可能なビットマップ値:
1 - 月曜日;
2 - 火曜日;
4 - 水曜日;
8 - 木曜日;
16 - 金曜日;
32 - 土曜日;
64 - 日曜日。

これはビットマスクフィールドです。指定可能なビットマップ値の任意の合計を指定できます（たとえば、月曜日・水曜日・金曜日の場合は 21）。

デフォルト: 0。

プロパティの動作:
- cycle が "weekly" に設定されている場合は 必須
active_since string 開始日。

指定可能な値:
空文字列 - (デフォルト) 未指定（0 として保存）;
YYYY-MM-DD 形式の特定の日付（その日の開始時刻 (00:00:00) のタイムスタンプとして保存）。
active_till string 終了日。

指定可能な値:
空文字列 - (デフォルト) 未指定（0 として保存）;
YYYY-MM-DD 形式の特定の日付（その日の終了時刻 (23:59:59) のタイムスタンプとして保存）。
subject string レポートメッセージの件名。
message string レポートメッセージの本文。
status integer レポートが有効か無効か。

指定可能な値:
0 - 無効;
1 - (デフォルト) 有効。
description text レポートの説明。
state integer レポートの状態。

指定可能な値:
0 - (デフォルト) レポートはまだ処理されていない;
1 - レポートが生成され、すべての受信者への送信に成功した;
2 - レポートの生成に失敗した; "info" にエラー情報が含まれる;
3 - レポートは生成されたが、一部（またはすべて）の受信者への送信に失敗した; "info" にエラー情報が含まれる。

プロパティの動作:
- 読み取り専用
lastsent timestamp 最後に正常に送信されたレポートのUnixタイムスタンプ。

プロパティの動作:
- 読み取り専用
info string エラーの説明または追加情報。

プロパティの動作:
- 読み取り専用

ユーザー

users オブジェクトには、以下のプロパティがあります。

プロパティ 型 説明
userid ID レポートの送信先ユーザーのID。

プロパティの動作:
- 必須
access_userid ID レポートの生成時に代理として使用するユーザーのID。

0 - (デフォルト) 受信者としてレポートを生成。
exclude integer ユーザーをメーリングリストから除外するかどうか。

使用可能な値:
0 - (デフォルト) 含める;
1 - 除外。

ユーザーグループ

ユーザーグループオブジェクトには、次のプロパティがあります。

プロパティ Type 説明
usrgrpid ID レポートの送信先となるユーザーグループのID。

プロパティの動作:
- 必須
access_userid ID レポートの生成時に代理として使用されるユーザーのID。

0 - (デフォルト) 受信者としてレポートを生成。