システム クエリ オプション
OData API は、システム クエリ オプションを使用して、リソースに対して返されるデータの制限および順序を制御します。システム クエリ オプションは、URL によって識別されるリソースのクエリ文字列パラメータで指定できます。すべてのシステム クエリ オプションの名前には、必要に応じてドル記号($)を付与します。
nfa1000
DX NetOps Network Flow Analysis
OData API は、システム クエリ オプションを使用して、リソースに対して返されるデータの制限および順序を制御します。システム クエリ オプションは、URL によって識別されるリソースのクエリ文字列パラメータで指定できます。すべてのシステム クエリ オプションの名前には、必要に応じてドル記号($
)を付与します。GET、PATCH、および PUT リクエストには、以下のルールが適用されます。
- 単一のエンティティ、複合型インスタンス、エンティティのコレクション、または複合型インスタンスのコレクションを示すリソース パスでは、$expandと$selectが許可されます。
- コレクションを示すリソース パスでは、$filter、$count、$orderby、$skip、および$topが許可されます。
- /$countで終わるリソース パスでは$filterが許可されます。
- /$countで終わらないリソース パスでは、$formatが許可されます。
POST リクエストを含む URL については、リターン タイプによって、サービスがサポートできる適切なシステム クエリ オプションが決定されます。ルールは GET リクエストと同じです。
エンティティ セットへの POST リクエストは、単一のエンティティを返す GET リクエストと同じルールに従います。
システム クエリ オプションは DELETE リクエストに適用されません。
NFA OData API は、サポートされていないシステム クエリ オプションが含まれるリクエストを拒否します。
OData サービスは、定義されているシステム クエリ オプションの一部またはすべてをサポートしている場合があります。データ サービスがシステム クエリ オプションをサポートしていない場合、サポートされていないオプションが含まれているすべてのリクエストを拒否する必要があります。
$ というプレフィクスが付与されていても、同じシステム クエリ オプションをリソースに対して 2 回以上指定することはできません