Unpublish all version in this locale
/km/api/v1/content/{id}/unpublishAllVersionInThisLocale/{localeCode}
This method unpublishes all versions of the specified Content translation as specified by the locale. When a Content version is unpublished, it becomes unavailable to end-users.
Response Errors
The possible error responses for this method are as follows:
- OKDOM-GEN0001
The error occurs when you pass an invalid id or an invalid localeId parameter value with the HTTP request.
Request
-
id: string
The content identifier
-
localeCode: string
The locale code identifier
Response
- application/json
- application/xml
200 Response
object
ResultList ActionResult ContentKey
-
allOf
Collection Paging Resource
Title:
Collection Paging Resource
Oracle base collection resource schema definition. -
object
ResultList ActionResult ContentKey-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
array
-
Array of:
object ActionResult ContentKey
Title:
ActionResult ContentKey
object
ActionResult ContentKey
-
object
ActionResult
Title:
ActionResult
-
object
ActionResult ContentKey-allOf[1]
object
ActionResult
-
errors(optional):
array KMError Collection
Title:
KMError Collection
Collection of KMErrors -
message(optional):
string
This will hold a success and failure message.
-
operation(optional):
string
The operation performed like PUBLISH_ACTION, UNPUBLISH_ACTION, etc.
-
status(optional):
Allowed Values:
[ "COMPLETED", "FAILED", "COMPLETED_WITH_WARNINGS" ]
Whether the Action completed successfully or not! -
warningMessage(optional):
string
Only meant for Waring Kind of messages. Like operation was successful but with warnings.
array
KMError Collection
-
Array of:
object KMError
Title:
KMError
object
KMError
-
errorCode(optional):
string
The Oracle Knowledge defined code for this error.
-
errorPath(optional):
string
The XPath of the field to which this error applies.
-
title(optional):
string
The error message title
-
type(optional):
Allowed Values:
[ "VALIDATION", "AUTHENTICATION", "AUTHORIZATION", "APPLICATION" ]
The error type.
-
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 unpublish all versions of the specified Content translation in the specified locale by submitting a post request on the REST resource using cURL.
cURL Command
Command: curl -X "POST" "http://<IM_REST_API_HOST>/km/api/latest/content/{id}/unpublishAllVersionInThisLocale/{localeCode}"
Example of Request Header
The following shows an example of the request header.
-H "kmauthtoken: {\"siteName\":\"ORACLE_KNOWLEDGE\",\"integrationUserToken\":\"\"+eCJYkxKwj5HUaIiJYun0/TpatwT1LmtcsF05W33xnEojifV/AsLDj9RpN0lKuorTMNKeSE1tgC7svVL+BzntqDON4KiM1HFlpxvXEUCB0P2w0Xrs75McygqxdVaDSE9",\"userToken\":\"UoyWTKRG4RpyJCH4Wqjzht2iYUrsDdk5ir+3IpwEkxcwajJkGR9OGSQBTANQVGW0iVT9MFeDzqL+RYdgfzGSK+h5QzDFIDM+rDLgdKeEE19ljWFm3zMCF+kgYp/dJ/Yq5V7Re+aDXqHg6YkHfvprFA==\"}" \ -H "Accept: application/json"
Example of Response Body
The following shows an example of the response body in JSON format.
{ "items" : null, "hasMore" : false, "limit" : 20, "offset" : 0, "count" : 0 }