機能
イベントログを一覧表示
処理概要
システムで発生したイベントの情報が一覧で確認できます。
パラメーター
パラメーター名 | 説明 | 指定 | 形式 | タイプ |
---|---|---|---|---|
token | 認証トークン | 必須 | string | query |
filter_cols | フィルターするカラム名を指定します。 | 任意 | string | query |
filter_vals | filter_colsで指定したカラム名に対して、指定順にフィルターの条件を指定します。 | 任意 | string | query |
sort_cols | ソートするカラム名を指定します。 | 任意 | string | query |
sort_vals | sort_colsで指定したカラム名に対して、指定順にソートの条件を指定します。
[例] | 任意 | string | query |
show_cols | 表示するカラム名を指定します。 | 任意 | string | query |
hide_cols | 非表示にするカラム名を指定します。 | 任意 | string | query |
limit | 表示する項目数を指定します。 | 任意 | integer | query |
offset | 項目の表示開始位置を指定します。 | 任意 | integer | query |
ステータスコード
本REST APIの実行が正常終了した場合は、以下のステータスコードで復帰します。
200
ステータスコードの詳細は、「ステータスコード」を参照してください。
ステータスコードに応じてメッセージが出力されます。メッセージの詳細は、「第2章 メッセージ」を参照してください。
レスポンス詳細
JSON形式のレスポンスとして表示されます。
データを格納するキー名: event_logs
オブジェクトの配列を返却
表示形式は、「1.1.2.2 レスポンス」の「レスポンスボディー」を参照してください。
コード | キー | 説明 | 表示 | 形式 | 列挙型定数 |
---|---|---|---|---|---|
200 | id | イベントログID | Yes | integer | |
confirmation | 既読/未読の判別
| Yes | boolean | ||
arose_at | イベント発生日時 | Yes | timestamp | ||
severity | 通知イベントレベル | Yes | enum | Information: Warning: Error: | |
target_name | 操作対象名 | Yes | string | ||
message_id | メッセージID | Yes | string | ||
message | メッセージ | Yes | string |
機能
イベントログの詳細表示
処理概要
イベントの詳細を確認できます。
確認したログは既読になります。
パラメーター
パラメーター名 | 説明 | 指定 | 形式 | タイプ |
---|---|---|---|---|
token | 認証トークン | 必須 | string | query |
id | イベントログのID | 必須 | integer | path |
ステータスコード
本REST APIの実行が正常終了した場合は、以下のステータスコードで復帰します。
200
ステータスコードの詳細は、「ステータスコード」を参照してください。
ステータスコードに応じてメッセージが出力されます。メッセージの詳細は、「第2章 メッセージ」を参照してください。
レスポンス詳細
JSON形式のレスポンスとして表示されます。
データを格納するキー名: event_log
単一のオブジェクトを返却
表示形式は、「1.1.2.2 レスポンス」の「レスポンスボディー」を参照してください。
コード | キー | 説明 | 形式 | 列挙型定数 |
---|---|---|---|---|
200 | id | イベントログID | integer | |
confirmation | 既読/未読の判別
| boolean | ||
arose_at | イベント発生日時 | timestamp | ||
severity | 通知イベントレベル | enum | Information: Warning: Error: | |
target_name | 操作対象名 | string | ||
message_id | メッセージID | string | ||
message | メッセージ | string |