Get history by document ID
/km/api/v1/content/docId/{docId}/history
This method returns list of ContentHistory objects associated with all the versions of the LATEST version of the document specified by document Id. User can override the default user locale by passing the 'langpref' URL parameter. As a note, the URL parameter, 'contentState', will be ignored. A ContentHistory Object represents an action performed on a given document.
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/docId/{docId}/history
The request returns list of ContentHistory objects associated with the specified document.
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
- application/json
- application/xml
-
docId: string
The document identifier
-
action(optional): string
To filter history by action type.
Response
- application/json
- application/xml
200 Response
object
ResultList ContentHistory
-
allOf
Collection Paging Resource
Title:
Collection Paging Resource
Oracle base collection resource schema definition. -
object
ResultList ContentHistory-allOf[1]
Collection Paging Resource
-
allOf
Base Collection Resource
Title:
Base Collection Resource
Oracle base collection resource schema definition. -
object
Collection Paging Resource-allOf[1]
Base Collection Resource
-
object
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
Base Collection Resource-allOf[1]
object
Singular Resource
object
-
count(optional):
integer
Number of resource instances returned in the current range.
-
hasMore(optional):
boolean
Boolean value that is set to true if more resources are available on the server than the subset returned in current page.
-
limit(optional):
integer
Actual paging size used by the server.
-
offset(optional):
integer
Offset value used in the current page.
-
totalResults(optional):
integer
Total count of the resource instances, including both the instances in the current range and the instances on the server that satisfy the request.
array
-
Array of:
object instanceLink
Metadata describing link description objects that MAY appear in the JSON instance representation.
object
-
href:
string
URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the "templated" property must be set to true.
-
mediaType(optional):
string
Media type, as defined by RFC 2046, describing the link target.
-
method(optional):
string
HTTP method for requesting the target of the link.
-
profile(optional):
string
Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..
-
rel:
string
Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.
-
templated(optional):
boolean
Boolean flag that specifies that "href" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.
object
-
object
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
ContentHistoryKey-allOf[1]
object
-
recordId(optional):
string
The unique record ID of the ContentHistory object.
object
-
action(optional):
string
It tells what action has been performed on each history
-
comments(optional):
string
Comments of the ContentHistory object
-
content(optional):
ContentKey
-
dateAdded(optional):
string(date-time)
The date when the ContentHistory object was created or added
-
dateModified(optional):
string(date-time)
The date when the ContentHistory object was last modified.
-
previousWorkflowStepId(optional):
string
PreviousWorkflowStepId of the ContentHistory object
-
userInformationId(optional):
string
UserInformationId of the ContentHistory object
-
userName(optional):
string
UserName of the ContentHistory object
-
workflowName(optional):
string
WorkflowName of the ContentHistory object
-
workflowStepId(optional):
string
WorkflowStepId of the ContentHistory object
-
workflowStepName(optional):
string
WorkflowStepName of the ContentHistory object
-
object
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
ContentKey-allOf[1]
object
-
allTranslations(optional):
array allTranslations
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.
-
answerId(optional):
integer
The unique identifier that enables mapping between an answer and the content.
-
dateModified(optional):
string(date-time)
The date when the content was last modified in the Oracle Knowledge Repository.
-
documentId(optional):
string
The unique identifier of a document that indicates the content type in which the content is saved.
-
locale(optional):
LocaleKey
-
recordId(optional):
string
The unique identifier of the document. This ID is same in all versions in all locales of the document.
-
title(optional):
string
The tittle of the document.
-
version(optional):
string
Version of the Content object
-
versionId(optional):
string
The unique identifier of the specific version of a document in a specific locale. You cannot use this field in queries made using q query parameter.
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.
-
object
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
LocaleKey-allOf[1]
object
-
recordId(optional):
string
The unique identifier of the Locale object.
Examples
The following example shows how to find a list of Content History objects associated with the specified document 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/docId/{docId}/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.
{ "items" : [ { "content" : { "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 }