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

Get learned links by answer ID

get

/km/api/v1/content/answers/{answerId}/documentLinks/learned

This method returns all the learned links of the document related to the specified answer 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. 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 or more content consecutively.

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

Request Translated Content

You cannot request translated content using version ID or answer ID.

Answer ID represents a specific translation of the content. For example, a document FA54 has answer ID 101 for English and answer ID 102 for Spanish.

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 Answer ID.
    • The user is using Oracle B2C Service, and the kmauthtoken header contains an interface ID for which no interface is found.
  • 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/answers/{answerId}/documentLinks

    The request returns all the learned links associated with the document that have the specified answer ID. The documents are returned as a list of ContentKey objects. As the contentState parameter is not allowed, by default the service returns the published version of linked objects.

    The service ignores the langpref request parameter if you specify it with the request. The service searches for the document whose answer ID is specified in the request and retrieve the linked documents in the same locale if they exist. If a linked document does not exist in the same locale of the specified document, then the service returns the 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 answer 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/answers/{answerId}/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