Check out content
post
/km/api/v1/content/{id}/checkOut
This method checks out the Content object with the specified content ID.
The request payload and the URI for the specific resource must be given along with the POST method.
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
-
id: string
The content identifier
The locale of the content text
Root Schema : LocaleKey
Match All
Show Source
-
object
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
LocaleKey-allOf[1]
Nested Schema : Singular Resource
Type:
object
Title:
Singular Resource
Oracle base singular resource schema definition.
Show Source
Nested Schema : LocaleKey-allOf[1]
Type:
Show Source
object
-
recordId(optional):
string
The unique identifier of the Locale object.
Nested Schema : links
Type:
Show Source
array
-
Array of:
object instanceLink
Metadata describing link description objects that MAY appear in the JSON instance representation.
Nested Schema : instanceLink
Type:
object
Metadata describing link description objects that MAY appear in the JSON instance representation.
Show Source
-
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.
Response
204 Response
No Content.
Examples
The following example shows how to check out the Content object with the specified content ID 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/{contentId}/checkOut"
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 Request Body
The following shows an example of the request body in JSON format.
{ "recordId":"en_US" }