1. REST API for Knowledge Advanced in B2C Service
  2. Tasks
  3. Content (IM)
  4. Content

Get learned links by doc ID

get

/km/api/v1/content/docId/{docId}/documentLinks/learned

This method returns all the learned links of the document related to the specified document ID. The document links are returned as a list of ContentKey object. When no learned links are available, the service returns an empty list.

A Content object can be linked to another Content object by a user using the IM Console. Document links are those linking objects that connect two contents. There are two types of links, manual and learned. Following are the descriptions for those links:

  • In manual links, the author determines the criteria for linking the contents. For example, author may link two contents that have same subject or similar problems.
  • In learned links the software that determines the relation for links. For example, the software may link two content when a set of users click two content consecutively.

NOTE: This method does not support the contentState parameter with the HTTP request.

Request Translated Content

To request a translated document in a specific language, you can do either of the following steps:

  • Specify langpref request parameter with the HTTP request, and set the parameter value to the required locale code.

    • OR

  • Specify the required locale code in the Accept-Language header with the request.

For example, when the request is submitted using the URI http://<IM_REST_API_HOST>/km/api/content/docId/{id}?langpref=es_ES, you get the specified Content object in Spanish locale. By default, the object appears in DATA mode. If you specify any other locale code like en_US as the Accept-Language header value, then the returned content appears in English language. See the Example URIs section for additional examples.

NOTE: If you provide both the Accept-Language header and langpref parameter with the request, then the Accept-Language header value overrides the langpref parameter value.

Response Errors

The possible error responses for this method are as follows:

  • OK-GEN0020

    The error occurs when contentState request parameter is specified with the HTTP request.

  • OKDOM-GEN0001

    The error occurs in any of the following cases:

    • No content is found by the specified document ID.
    • The user is using Oracle B2C Service, and the kmauthtoken header contains an interface ID for which no interface is found.
  • OKDOM-CONT0047

    The error occurs when the content is found with the specified document ID, but the following conditions exist:

    • No langpref parameter value or the Accept-Language header value is specified with the request.
    • No translation exists for the document in the user's default locale.
  • OKDOM-CONT0046

    The error occurs when the specified content is found but no translation is found for the locale specified as the langpref parameter value or the Accept-Language header value.

  • OK-RN_INTERFACE0001

    The error occurs when the user is using Oracle B2C Service, and the kmauthtoken header contains an interface ID for which no view is mapped.

Example URIs

The example URIs for this method are as follows:

  • http://<IM_REST_API_HOST>/km/api/content/docId/{docId}/documentLinks/learned

    The request returns the list of available documents that are learned linked to the document specified in the request. The linked documents are returned as a list of ContentKey objects. As the contentState request parameter is not allowed by the service, by default you get the published version of the documents that are linked to specified document. As no langpref parameter value or Accept-Language header value is specified with the request, service returns the document in user's current locale. If a linked document does not exist in the user's current locale, then the request returns the document in the master locale.

  • http://<IM_REST_API_HOST>/km/api/content/docId/{docId}/documentLinks/learned?langpref={localeId}

    The request returns the list of available documents that are learned linked to the document specified in the request. The linked documents are returned as a list of ContentKey objects. By default, the service returns published versions of the documents that are linked to the specified document. If the translation is available, then the service returns the specified linked document in the requested locale. If a linked document does not exist in the specified locale, then the service returns document in the master locale.

Request

Path Parameters
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : ResultList ContentKey
Type: object
Title: ResultList ContentKey
Match All
Show Source
Nested Schema : Collection Paging Resource
Title: Collection Paging Resource
Oracle base collection resource schema definition.
Match All
Show Source
Nested Schema : Base Collection Resource
Title: Base Collection Resource
Oracle base collection resource schema definition.
Match All
Show Source
Nested Schema : Singular Resource
Type: object
Title: Singular Resource
Oracle base singular resource schema definition.
Show Source
Nested Schema : Base Collection Resource-allOf[1]
Type: object
Show Source
Nested Schema : Collection Paging Resource-allOf[1]
Type: object
Show Source
Nested Schema : ResultList ContentKey-allOf[1]
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Type: object
Nested Schema : items
Type: array
Show Source
Nested Schema : ContentKey
Match All
Show Source
Nested Schema : ContentKey-allOf[1]
Type: object
Show Source
Nested Schema : allTranslations
Type: array

This field will return list of all translated content that the user can view

This field will only be populated if allTranslations query parameter is passed in with value true.

Show Source
Nested Schema : LocaleKey
Match All
Show Source
Nested Schema : LocaleKey-allOf[1]
Type: object
Show Source
Back to Top

Examples

The following example shows how to find all the learned links of the document related to the specified document ID by submitting a get request on the REST resource using cURL.

cURL Command

Command: curl -X "GET" "http://<IM_REST_API_HOST>/km/api/latest/content/docId/{docId}/documentLinks/learned"

Example of Request Header

The following shows an example of the request header.

-H "kmauthtoken: {\"siteName\":\"ORACLE_KNOWLEDGE\",\"integrationUserToken\":\"\"+eCJYkxKwj5HUaIiJYun0/TpatwT1LmtcsF05W33xnEojifV/AsLDj9RpN0lKuorTMNKeSE1tgC7svVL+BzntqDON4KiM1HFlpxvXEUCB0P2w0Xrs75McygqxdVaDSE9"}" \
-H "Accept: application/json"

Example of Response Body

The following shows an example of the response body in JSON format.

{
  "items" : [ {
    "versionId" : "VERSIONID_VALUE",
    "documentId" : "DOCUMENTID_VALUE",
    "title" : "TITLE_VALUE",
    "version" : "VERSION_VALUE",
    "answerId" : 0,
    "links" : [ {
      "rel" : "canonical",
      "href" : "http://<IM_REST_API_HOST>/km/api/{version}/{resourceURI}",
      "mediaType" : "application/json, application/xml",
      "templated" : true,
      "method" : "GET",
      "profile" : "http://<IM_REST_API_HOST>/km/api/{version}/metadata-catalog/{resourceName}"
    } ]
  } ],
  "hasMore" : false,
  "limit" : 20,
  "offset" : 0,
  "links" : [ {
    "rel" : "canonical",
    "href" : "http://<IM_REST_API_HOST>/km/api/{version}/content?limit=20&offset=0",
    "mediaType" : "application/json, application/xml",
    "method" : "GET"
  } ],
  "count" : 1
}
Back to Top