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

Get history by version ID

get

/km/api/v1/content/versions/{versionId}/history

This method returns list of ContentHistory objects associated with the specified content version. A ContentHistory Object represents an action performed on a given content version.

This service accepts action filter list to filter history by action type. To filter by multiple values filter values should be separated by colon (:).

Possible values for this parameter are :

  • CREATED
  • EDITED
  • GSR_EDITED
  • APPROVED
  • REJECTED
  • PUBLISHED
  • PENDING_PUBLISHED
  • GSR_PUBLISHED
  • UNPUBLISHED
  • LOCALIZED
  • REVERTED
  • MOD_CATEGORY
  • MOD_SITE_VIS
  • MOD_USER_VIS
  • LOCALIZATION_REQUESTED
  • LOCALIZATION_CLEARED
  • METADATA_CHANGED
  • WORKFLOWCOMMENT_ADDED

NOTE:Values for this parameter are case sensitive. If this parameter is not passed then results will be returned without applying filter.

Example URIs

The example URIs for this method are as follows:

  • http://<IM_REST_API_HOST>/km/api/latest/content/versions/{versionId}/history

    The request returns list of ContentHistory objects associated with the specified content version.

  • http://<IM_REST_API_HOST>/km/api/latest/content/docId/{docId}/history?action=EDITED:CREATED

    The request returns list of ContentHistory objects associated with the specified content object.

Request

Supported Media Types
Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : ResultList ContentHistory
Type: object
Title: ResultList ContentHistory
Match All
Show Source
Nested Schema : Collection Paging Resource
Title: Collection Paging Resource
Oracle base collection resource schema definition.
Match All
Oracle base collection resource schema definition.
Oracle base collection resource schema definition.
Show Source
Nested Schema : Base Collection Resource
Title: Base Collection Resource
Oracle base collection resource schema definition.
Match All
Oracle base collection resource schema definition.
Oracle base collection resource schema definition.
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
  • Number of resource instances returned in the current range.
  • Boolean value that is set to true if more resources are available on the server than the subset returned in current page.
  • Actual paging size used by the server.
  • Offset value used in the current page.
  • Total count of the resource instances, including both the instances in the current range and the instances on the server that satisfy the request.
Nested Schema : ResultList ContentHistory-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 : ContentHistory
Match All
Show Source
Nested Schema : ContentHistoryKey
Match All
Show Source
Nested Schema : ContentHistoryKey-allOf[1]
Type: object
Show Source
Nested Schema : ContentHistory-allOf[1]
Type: object
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 a list of Content History objects associated with the specified content version by submitting a get request on the REST resource using cURL.

cURL Command

curl -X "POST" "http://<IM_REST_API_HOST>/km/api/latest/content/versions/{versionId}/history"

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.

{
     {
      "recordId" : "e3fad0e6303643bd8a930a6240db9ac7",
      "answerId" : 0
    },
    "action" : "ACTION_VALUE",
    "comments" : "COMMENTS_VALUE",
    "dateAdded" : "2013-04-23T21:06:28-0400",
    "dateModified" : "2013-04-23T21:06:28-0400",
    "previousWorkflowStepId" : "PREVIOUSWORKFLOWSTEPID_VALUE",
    "userInformationId" : "USERINFORMATIONID_VALUE",
    "userName" : "USERNAME_VALUE",
    "workflowName" : "WORKFLOWNAME_VALUE",
    "workflowStepId" : "WORKFLOWSTEPID_VALUE",
    "workflowStepName" : "WORKFLOWSTEPNAME_VALUE",
    "links" : [ {
      "rel" : "canonical",
      "href" : "http://<IM_REST_API_HOST>/km/api/{version}/{resourceURI}",
      "mediaType" : "application/json, application/xml",
      "templated" : true,
      "method" : "GET"
    } ]
  } ],
  "hasMore" : false,
  "limit" : 20,
  "offset" : 0,
  "count" : 1
}
Back to Top