Ramp - レコードの検索アクション
Search records(レコードの検索)アクションでは、Rampのレコードを一覧表示して絞り込みます。
カーソルベースのページネーション
Rampのリストエンドポイントでは、ページ番号ではなくカーソルを使用してページネーションを行います。検索フィルターには通常、Start(開始)フィールド(再開位置となるID)とPage size(ページサイズ)フィールド(1ページあたり2~10,000件、デフォルトは1,000件)があります。出力のPage(ページ)フィールドには、さらに結果がある場合に次のページを取得するためのNext(次へ) URLが含まれます。
入力
入力フィールドは、選択したオブジェクトと検索操作に応じて動的に生成されます。次のフィールドはすべてのオブジェクトに共通です。入力フィールドの一覧については、RampのREST APIドキュメントを参照してください。
| 入力フィールド | 説明 |
|---|---|
| オブジェクト | 検索するRampオブジェクトを選択します。たとえば、Transactions(トランザクション)、Cards(カード)、Users(ユーザー)です。 |
Transactions(トランザクション)を選択した後に使用できるフィルターの例は、card_id、department_id、user_id、state、from_date、to_date、page_sizeです。
出力
出力フィールドは、選択したオブジェクトに基づいて動的に生成されます。出力フィールドの一覧については、RampのREST APIドキュメントを参照してください。
| 出力フィールド | 説明 |
|---|---|
| データ | 一致するレコードの配列です。各レコードのフィールドは、選択したオブジェクトのRamp APIスキーマに対応します。 |
| ページ | ページネーション情報。 Next(次へ)フィールドには、次のページを取得するためのURLが含まれます。結果がそれ以上ない場合、Next(次へ)フィールドは空です。 |
このアクションのフィルターフィールドは、各レコードで返されるフィールドではなく、返されるレコードを絞り込みます。 RampのAPIはフィールドの一部のみを選択する機能をサポートしていないため、Data(データ)内の各レコードには常にすべてのフィールドが含まれます。
最終更新日: