URLパス
URL (Uniform Resource Locator)パスは、呼び出すRESTリソースを識別します。 完全なURLパスは、サーバー名とリソース・パスで構成されます:
B2B ServiceのKnowledgeのREST APIは、コンテンツと検索の2つのカテゴリにグループ化されています。 次の起動URIを使用して、REST APIにアクセスします:
Content(IM): <server:port>/km/api/latest
Search: <server:port>/srt/api/latest
リソースのcURLおよびJSONスキーマは、ドキュメントで次の構文を使用します:
- コンテンツ(IM):
<IM_REST_API_HOST>/km/api/latest
- 検索:
<SEARCH_REST_API_HOST>/srt/api/latest
URI構文
Content (IM)カテゴリに属するREST APIのリクエストでは、次の構文を使用します:
https://<IM_REST_API_HOST>/km/api/<version>/resource
[/resource_id][/child_resource][/child_resource_id]
[?query_parameters]
Searchカテゴリに属するREST APIのリクエストでは、次の構文を使用します:
https://<SEARCH_REST_API_HOST>/srt/api/<version>/resource
[/resource_id][/child_resource][/child_resource_id]
[?query_parameters]
次の表に、URI構文を示します。
パラメータ | 説明 |
---|---|
|
REST APIのサーバーおよびポート番号。 |
翻訳 |
APIバージョン。 |
リソース |
リソースの名前(コンテンツなど)。 |
resource_id |
リソースのインスタンスの主キー識別子。 これは整数または文字列です。たとえば、リソースIDは5などの整数、または019101342b459400014af3aeaa1f007f3cのような文字列です。 |
child_resource |
子リソースの名前(住所や名前など)。 |
child_resource_id |
子リソースのインスタンスの主キー識別子。 整数である必要があります(例: 7)。 |
query_parameters |
リソース・コレクションのフィルタに使用する問合せパラメータ(dateAddedなど)。 詳細は、「回収の管理」の問合せを参照してください。 |
たとえば:
https://<IM_REST_API_HOST>/km/api/latest/content/{id}