Rate content
post
/km/api/v1/dataForms/{contentId}/rateContent
Rates a latest valid content record if exists, for given contentId. Latest valid content is either published live or latest live content. Content Owner cannot rate the content.
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
-
contentId: string
The content identifier
The user response value
Root Schema : SingleAnswerRating
Type:
object
Title:
Show Source
SingleAnswerRating
-
answer(optional):
DataFormAnswerKey
-
answerComment(optional):
string
Comment for the rating
-
dateAdded(optional):
string(date-time)
The dateAdded for the replacement token for this locale
-
locale(optional):
LocaleKey
-
recordId(optional):
string
The unique record ID of the SingleAnswerRating object.
-
survey(optional):
DataFormKey
-
user(optional):
UserKey
Nested Schema : DataFormAnswerKey
Match All
Show Source
-
object
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
DataFormAnswerKey-allOf[1]
Nested Schema : LocaleKey
Match All
Show Source
-
object
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
LocaleKey-allOf[1]
Nested Schema : DataFormKey
Match All
Show Source
-
object
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
DataFormKey-allOf[1]
Nested Schema : UserKey
Match All
Show Source
-
object
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
UserKey-allOf[1]
Nested Schema : Singular Resource
Type:
object
Title:
Singular Resource
Oracle base singular resource schema definition.
Show Source
Nested Schema : DataFormAnswerKey-allOf[1]
Type:
Show Source
object
-
recordId(optional):
string
The unique record ID of the DataFormAnswer object.
-
referenceKey(optional):
string
The reference key for the DataFormAnswer object. DataFormAnswer objects support multiple languages. This field can be used to identify the associated objects for all languages.
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.
Nested Schema : LocaleKey-allOf[1]
Type:
Show Source
object
-
recordId(optional):
string
The unique identifier of the Locale object.
Nested Schema : DataFormKey-allOf[1]
Type:
Show Source
object
-
recordId(optional):
string
The unique record ID of the DataForm object.
-
referenceKey(optional):
string
The reference key for the DataForm object. DataForm objects support multiple languages. This field can be used to identify the associated objects for all languages.
Nested Schema : UserKey-allOf[1]
Type:
Show Source
object
-
email(optional):
string
Email of the User object
-
externalId(optional):
integer
The ExternalId is the Id of the corresponding User from an external system. It, along with ExternalType, can be used to bridge the gap between a User from this system and a User from an external system.
-
externalType(optional):
string
The ExternalType is the type of the corresponding User from an external system. It, along with ExternalId, can be used to bridge the gap between a User from this system and a User from an external system.
-
name(optional):
string
User's full name
-
recordId(optional):
string
The unique record ID of the User object.
Response
204 Response
No Content.
Examples
The following example shows how to rates the latest valid content record for the specified content id by submitting a post request on the REST resource using cURL.
cURL Command
curl -X "POST" "http://<IM_REST_API_HOST>/km/api/latest/dataForms/{contentId}/rateContent"
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.
{ "survey" : { "recordId" : "0480165035cb2f4a014581a0f299007b3a", "referenceKey" : "REFERENCEKEY_VALUE", "links" : [ { "rel" : "canonical", "href" : "http://localhost:7002/km/api/{version}/{resourceURI}", "mediaType" : "application/json, application/xml", "templated" : true, "method" : "GET" } ] }, "locale" : { }, "answer" : { }, "answerComment" : "ANSWER_COMMENT" }
Example of Response Body
The following shows an example of the response body in JSON format.
This request does not return any response body.