URL Paths

A URL (Uniform Resource Locator) path identifies the REST resource that you want to call. A complete URL path consists of the server name and the resource path:

REST APIs for Knowledge in B2B Service are grouped into three categories, Articles, Search, and Tasks. Use the following launch URI to access the REST APIs:

<server:port>/api/knowledge-management/v2/

URI Syntax

Requests in the REST API for all the categories use the following syntax:

https://<REST_API_HOST>/api/knowledge-management/v2/resource
[/resource_id][/child_resource][/child_resource_id]
[?query_parameters]

The following table describes the URI syntax.

Parameter	Description
<REST_API_HOST>	Server and port number of your REST APIs.
resource	Name of the resource, for example, articles.
resource_id	Primary key identifier of the instance of the resource. This can be an integer or a string, for example, resource IDs can be an integer like 5 or a string like 019101342b459400014af3aeaa1f007f3c.
child_resource	Name of the child resource.
child_resource_id	Primary key identifier of the instance of the child resource. Must be an integer, for example, 7.
query_parameters	Query parameters that you use to filter resource collections, for example, fields.

For example:

https://<REST_API_HOST>/api/knowledge-management/v2/articles/{id}