Skip to main content
本製品の最新リリースがご利用いただけます。
日本語は機械翻訳による参考訳です。内容に矛盾や不一致があった場合には、英語の内容が優先されます。

コレクションを操作する

共同作成者
PDF

Astra Control REST API には、定義されたクエリパラメータを使用してリソースコレクションにアクセスするためのさまざまな方法があります。

値の選択

を使用して、各リソースインスタンスに対して返すキーと値のペアを指定できます include パラメータすべてのインスタンスが応答の本文で返されます。

フィルタリング

収集リソースのフィルタリングを使用すると、 API ユーザは、応答の本文でリソースが返されるかどうかを決定する条件を指定できます。。 filter パラメータは、フィルタリング条件を示すために使用されます。

並べ替え

収集リソースのソートを使用すると、 API ユーザは応答の本文でリソースが返される順序を指定できます。。 orderBy パラメータは、フィルタリング条件を示すために使用されます。

ページ付け

ページ付けを適用するには、を使用して要求に対して返されるリソースインスタンスの数を制限します limit パラメータ

カウント

Booleanパラメータを含める場合 count をに設定します `true`の場合、返される特定の応答について返されるアレイ内のリソースの数がメタデータセクションに表示されます。