現在の認証スコープ内の判定レコードをページ単位で取得します。Session で絞り込むこともできます。
Decision API は現在 Beta 機能です。インターフェイス定義、レスポンス構造、動作は今後のバージョンで変更される可能性があります。ドキュメントの更新を確認し、本番環境で使用する前に互換性を検証してください。
GET /api/v1/forward/decisions
リクエストヘッダー
| Header | 必須 | 説明 |
|---|---|---|
| Authorization | はい | Bearer <PAT or SAT>。管理者および Identity レベルの SAT をサポートします。 |
クエリパラメーター
| パラメーター | 型 | 必須 | デフォルト | 説明 |
|---|---|---|---|---|
| session_id | string | いいえ | — | この Session の判定レコードのみを取得します。Session は現在の認証スコープ内にあり、アーカイブされていない必要があります。 |
| after_id | string | いいえ | — | 前ページの last_id を渡し、古いレコードの方向へページを進めます。 |
| before_id | string | いいえ | — | 現在のページの first_id を渡し、新しいレコードの方向へページを進めます。 |
| limit | integer | いいえ | 20 | 1 ページの件数。範囲は 1~100。 |
after_id と before_id は同時に指定できません。ID パラメーターは 1~256 バイトで、先頭・末尾の空白、制御文字、/、\\、?、# を含めることはできません。identity_id、status、order など、ほかのクエリパラメーターは受け付けません。
リクエスト例
現在のスコープ内のレコードを照会します。
after_id には前ページが返した last_id を使用します。
レスポンス例
HTTP 200 OK(実行中のレコードを含む)
レスポンスフィールドとページネーション
| フィールド | 型 | 説明 |
|---|---|---|
| data | array | 現在のページの Decision オブジェクト。running、completed、failed のレコードを含む場合があります。 |
| has_more | boolean | 現在の照会方向にさらにレコードがあるかどうか。デフォルトと after_id は古い方向、before_id は新しい方向を示します。 |
| first_id | string または null | 現在のページの最初のレコード ID。空のページでは null。 |
| last_id | string または null | 現在のページの最後のレコード ID。空のページでは null。 |
session_id フィルターに一致する必要があります。一致しない場合は 404 を返します。
session_id を省略すると、明示的な state 入力と Session 入力の両方から生成されたレコードを返すことができます。Identity レベルの SAT は、紐付けられた Identity のスコープ内のレコードのみ取得できます。
エラー
| HTTP | Code | 発生条件 |
|---|---|---|
| 400 | invalid_decision_input または Code なし | パラメーターの重複、空値、未知のパラメーター、形式不正、limit の範囲外、または両カーソルの同時指定。 |
| 401 | — | 認証情報が未指定、無効、または期限切れです。 |
| 403 | — | 現在の認証情報に必要なアクセス権限がありません。 |
| 404 | — | フィルター対象の Session がアクセス不可またはアーカイブ済み、その Identity が利用不可、またはカーソルが現在のフィルター範囲外です。 |
| 500 | — | サービス内部エラー。 |