Table of Contents
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が「毎週」に設定されている場合は必須 |
| 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 | エラーの説明または追加情報。 プロパティの動作: - 読み取り専用 |
ユーザー
ユーザーオブジェクトには以下のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| userid | ID | レポートを送信するユーザーのID。 プロパティの動作: - 必須 |
| access_userid | ID | レポートを生成するユーザーのID。 0 - (デフォルト) 受信者によってレポートを生成する。 |
| exclude | integer | ユーザーをメーリングリストから除外するかどうか。 可能な値: 0 - (デフォルト) 含める; 1 - 除外する。 |
ユーザーグループ
ユーザーグループオブジェクトには以下のプロパティがあります。