URLパス
URL (Uniform Resource Locator)パスは、呼び出すRESTリソースを識別します。 完全なURLパスは、サーバー名とリソース・パスで構成されます:
B2B ServiceのナレッジのREST APIは、記事、検索およびタスクの3つのカテゴリにグループ化されます。 次の起動URIを使用して、REST APIにアクセスします:
<server:port>/api/knowledge-management/v2/
URI構文
すべてのカテゴリに対するREST APIのリクエストでは、次の構文が使用されます:
https://<REST_API_HOST>/api/knowledge-management/v2/resource
[/resource_id][/child_resource][/child_resource_id]
[?query_parameters]
次の表に、URI構文を示します。
| パラメータ | 説明 |
|---|---|
|
|
REST APIのサーバーおよびポート番号。 |
| リソース |
リソースの名前。たとえば、記事です。 |
| resource_id |
リソースのインスタンスの主キー識別子。 これは整数または文字列です。たとえば、リソースIDは5などの整数、または019101342b459400014af3aeaa1f007f3cのような文字列です。 |
| child_resource |
子リソースの名前。 |
| child_resource_id |
子リソースのインスタンスの主キー識別子。 整数である必要があります(例: 7)。 |
| query_parameters |
リソース・コレクションのフィルタに使用する問合せパラメータ(フィールドなど)。 |
たとえば:
https://<REST_API_HOST>/api/knowledge-management/v2/articles/{id}