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 two categories, Content and Search. Use the following launch URI to access the REST APIs:

Content(IM): <server:port>/km/api/latest

Search: <server:port>/srt/api/latest

The cURL and JSON schema of the resources use the following syntax in the documentation:

• Content (IM): <IM_REST_API_HOST>/km/api/latest
• Search: <SEARCH_REST_API_HOST>/srt/api/latest

URI Syntax

Requests in the REST API belonging to the Content (IM) category use the following syntax:

https://<IM_REST_API_HOST>/km/api/<version>/resource
[/resource_id][/child_resource][/child_resource_id]
[?query_parameters]

Requests in the REST API belonging to the Search category use the following syntax:

https://<SEARCH_REST_API_HOST>/srt/api/<version>/resource
[/resource_id][/child_resource][/child_resource_id]
[?query_parameters]

The following table describes the URI syntax.

Parameter	Description
<IM_REST_API_HOST> or <SEARCH_REST_API_HOST>	Server and port number of your REST APIs.
version	API version.
resource	Name of the resource, for example, content.
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, for example, address or name.
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, dateAdded. For more information, see Querying in Manage Collections.

For example:

https://<IM_REST_API_HOST>/km/api/latest/content/{id}