よく使用される OData クエリー・パラメーター

AppScan 360° API でよく使用される OData パラメーターは以下のとおりです。

$top

システムから返されるレコードの数を制限するために使用します。整数を渡すだけで、$top の値が取得され、$orderby パラメーターで決まる値を上限としてレコード数が返されます。例えば、スキャンを最初の 5 つだけ返すには、次のように指定します。https://cloud.appscan.com/api/v2/Scans?$top=5

$filter

どのレコードを返すかを定義します。このパラメーターに式を指定すると、どのレコードもその式に対して評価されます。式の評価が true であるレコードがすべて返されます。このフィルター・パラメーターは、非常に強力で便利です。例えば、高リスク等級のアプリケーションをすべて返すには、次のように指定します。https://cloud.appscan.com/api/V2/Apps?$filter=RiskRating%20eq%20'High'

$select

どのフィールドを結果に含めるかを定義します。特定のフィールドだけに関心があり、それ以外は含めないようにするときに便利です。例えば、すべてのアプリケーションの名前および作成日は含め、それ以外の情報は含めないようにするには、次のように指定します。https://cloud.appscan.com/api/V2/Apps?$select=Name%2CDateCreated

$skip

スキップするレコードの数を定義します。例えば、最初の 2 つ以外のすべてのポリシーを表示するには、次のように指定します。https://cloud.appscan.com/api/V2/Policies?$skip=2

$orderby

結果セットの順序を定義します。このパラメーターにフィールドを指定すると、そのフィールド別に編成された結果セットが返されます。SQL クエリーと同じく、降順にも昇順にもできます。そのためには、パラメーターに desc または asc を追加します。文字列フィールドはアルファベット順になり、数値フィールドは数値順になります。このパラメーターに指定できる値は (例に示すように 2 つあっても) 1 つだけのように見えます。例えば、すべてのスキャンを作成日ごとの名前順のリストにして返すには、次のように指定します。https://cloud.appscan.com/api/v2/Scans?$orderby=CreatedAt%20desc