API の詳細
CA NFA OData API URL は、サービス ルート URL、リソース パス、クエリ オプションの 3 つの部分から構成されます。
nfa1000
CA NFA OData API URL は、サービス ルート URL、リソース パス、クエリ オプションの 3 つの部分から構成されます。
構文:
<Service Root URL>/<Resource Path>?<Query Options>
説明
- サービス ルート URLCA NFA OData サービスのルートを指定します。この URL への GET リクエストにより、その形式固有のサービス ドキュメントが返されます。サービス ルート URL は、スラッシュで終了する必要があります。CA NFA OData API は、ポート番号 8981 を使用します。デフォルト ポートを変更するには、ReporterAnalyzer.ini ファイル内のReporterAnalyzer.ODataServicePortの値を更新し、CA NFA OData サービスを再起動します。NFA が CAPC と統合されている場合、新しいポート値は CAPC の次回のポーリング サイクルで同期されますが、NFA データ ソースとの手動再同期を実行することもできます。
- リソース パスCA NFA OData サービスによって公開されるリソースは、対応するリソース パス URL によってアドレス指定されます。これにより、クライアントはリソースの側面を操作できます。
- クエリ オプションOData URL のうちクエリ オプションの部分では、システム クエリ オプション、カスタム クエリ オプション、パラメータ エイリアスの 3 つのタイプの情報を指定します。システム クエリ オプションは、URL で識別されるリソースに対して返されるデータの量と順序を制御するクエリ文字列パラメータです。すべてのシステム クエリ オプションの名前には、必要に応じてドル記号($)を付与します。カスタム クエリ オプションは、サービス固有の情報を URL クエリ文字列に配置するための拡張可能なメカニズムです。
例
:http://127.0.0.1:8981/path/SampleService.svc/Categories(1)/Products?$top=2&$orderby=Name