すべてのイベントを取得
リクエスト
GET <REST API URL>/events?fields=string&$skip=int&$top=int&query=string&orderBy=stringパラメーター | 説明 |
|---|---|
fields | オプション。各イベントのフィールドの指定されたサブセットのみを返します。フィールド構文を使用してサブセットを定義します。 |
$skip | オプション。最初のイベントを返す前にスキップするイベントの数を設定できます。 |
$top | オプション。返すイベントの最大数を設定できます。 |
query | オプション。検索クエリを指定して、返された結果をフィルタリングできます。サポートされている論理演算構文の定義については、照会の構文を参照してください。イベントでは、次のフィールドとタプルがサポートされています。 after : instant — 与えられた瞬間の後のイベント afterId : number — 指定された ID の後のイベント (排他的) author : user — ユーザー、グループ、サービスによってトリガーされるイベント author : group — ユーザー、グループ、サービスによってトリガーされるイベント author : service — ユーザー、グループ、サービスによってトリガーされるイベント before : instant — 与えられた瞬間の前のイベント beforeId : number — 指定された ID より前のイベント (包括的) entityType : entityType — 指定されたタイプのエンティティを持つイベント event : auditEventType — 作成、更新、削除された特定のタイプのイベント target : value — 指定されたイベントターゲットを持つイベント target : authModule — 指定されたイベントターゲットを持つイベント target : role — 指定されたイベントターゲットを持つイベント target : service — 指定されたイベントターゲットを持つイベント target : user — 指定されたイベントターゲットを持つイベント target : group — 指定されたイベントターゲットを持つイベント |
orderBy | オプション。指定されたフィールドでソートされたイベントのリストを返します。詳細については、ソート構文を参照してください。イベントは、次のフィールドによる順序付けをサポートします: id、timestamp |
レスポンス
レスポンスコード | 意味 |
|---|---|
200 OK | リクエストが成功しました。 |
400 不正な要求 | リクエストパラメーターの少なくとも 1 つが無効です。例: 渡された JSON オブジェクトの必須フィールドがありません。詳細については、応答のエラーメッセージを確認してください。 |
403 禁止します | 要求元は、要求されたリソースにアクセスできません。 |
404 お探しのページが見つかりませんでした | 要求されたリソースが見つかりませんでした。 |
500 内部サーバーエラー | サーバーエラーのため、リクエストの処理に失敗しました。詳細については、応答のエラーメッセージを確認してください。 |
レスポンスボディ
{
"skip": int,
"top": int,
"total": int,
"events": [event, ...]
}
