Swaggerのクエリオプションを使用すると、レスポンスで返されるデータと順序を指定することができます。
以下の例をご参照ください。
$expand:拡張オプション
$expand を使用すると、単一のURI(Uniform Resource Identifier)で関連する項目を取得することができます。拡張可能な項目は、プロパティ Modelで確認することができます。
ModelはLMS365 Cloud API下部にあります。
1つまたは複数のプロパティをカンマで区切って指定し、「Execute」をクリックします。
ネストした '$expand' を使用することができます。
$filter:フィルターオプション
$filter オプションを使用して、必要な条件を満たす項目のみを返します。
また、拡張プロパティによるフィルタリングを追加することも可能です。
$select:選択オプション
$select オプションを使用して、レスポンスで取得する個別のプロパティを指定します。
$orderby:並び替えオプション
$orderby オプションを使用して、レスポンスで返される項目を並べ替えることができます。
また、拡張プロパティによる並び替えも可能です。
$top:トップオプション
$top オプションを使用して、検索結果の先頭から指定した数(N個)のデータのみを返すことができます。
参考:$orderby オプションとの併用が便利です。
$skip:スキップオプション
たとえば、データを並べ替えるときに、返された項目の一部を省略したい場合があります。その場合、 $skip オプションを使用します。