このページで
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 | レポートを作成して送信する時刻。1日の開始からの秒数で指定します。 デフォルト: 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 - 除外。 |
ユーザーグループ
ユーザーグループオブジェクトには、以下のプロパティがあります。