Jump to

• Request
• Response
• Examples

Rate content

post

/km/api/v1/content/{id}/rate

This method rates the latest valid version of the Content object with the specified id.

The latest valid version of the Content object is either the published live or the latest version of the Content object. The request payload and the URI for the new resource must be specified along with the POST method.

NOTE: The content owner cannot rate the content.

Response Errors

• OKDOM-GEN0001

  The error occurs when an invalid id has been given.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• id: string
  The content identifier.

Body ()

The rating which requires SurveyAnswerId. The SurveyId, LocalId and answerComment parameters are optional.

Root Schema : SingleAnswerRating

Type: object

Title: SingleAnswerRating

Show Source

• 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

{
    "title":"SingleAnswerRating",
    "properties":{
        "survey":{
            "$ref":"#/definitions/DataFormKey",
            "description":"Relationship to SurveyAnswer"
        },
        "locale":{
            "$ref":"#/definitions/LocaleKey",
            "description":"Relationship to Locale"
        },
        "answer":{
            "$ref":"#/definitions/DataFormAnswerKey",
            "description":"Relationship to SurveyAnswer"
        },
        "answerComment":{
            "type":"string",
            "description":"Comment for the rating"
        },
        "user":{
            "$ref":"#/definitions/UserKey",
            "description":"Relationship to User"
        },
        "dateAdded":{
            "type":"string",
            "format":"date-time",
            "description":"The dateAdded for the replacement token for this locale"
        },
        "recordId":{
            "type":"string",
            "description":"The unique record ID of the SingleAnswerRating object."
        }
    }
}

Nested Schema : DataFormAnswerKey

Match All

Show Source

• object Singular Resource
  Title: Singular Resource

  Oracle base singular resource schema definition.
• object DataFormAnswerKey-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"The unique record ID of the DataFormAnswer object."
                },
                "referenceKey":{
                    "type":"string",
                    "description":"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 : LocaleKey

Match All

Show Source

• object Singular Resource
  Title: Singular Resource

  Oracle base singular resource schema definition.
• object LocaleKey-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"<p>The unique identifier of the Locale object.</p>"
                }
            }
        }
    ]
}

Nested Schema : DataFormKey

Match All

Show Source

• object Singular Resource
  Title: Singular Resource

  Oracle base singular resource schema definition.
• object DataFormKey-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"The unique record ID of the DataForm object."
                },
                "referenceKey":{
                    "type":"string",
                    "description":"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

Match All

Show Source

• object Singular Resource
  Title: Singular Resource

  Oracle base singular resource schema definition.
• object UserKey-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"The unique record ID of the User object."
                },
                "name":{
                    "type":"string",
                    "description":"User's full name"
                },
                "email":{
                    "type":"string",
                    "description":"Email of the User object"
                },
                "externalId":{
                    "type":"integer",
                    "description":"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":{
                    "type":"string",
                    "description":"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."
                }
            }
        }
    ]
}

Nested Schema : Singular Resource

Type: object

Title: Singular Resource

Oracle base singular resource schema definition.

Show Source

• links(optional): array links

{
    "title":"Singular Resource",
    "description":"Oracle base singular resource schema definition.",
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/instanceLink"
            }
        }
    }
}

Nested Schema : DataFormAnswerKey-allOf[1]

Type: object

Show Source

• 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.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"The unique record ID of the DataFormAnswer object."
        },
        "referenceKey":{
            "type":"string",
            "description":"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: array

Show Source

• Array of: object instanceLink
  Metadata describing link description objects that MAY appear in the JSON instance representation.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/instanceLink"
    }
}

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.

{
    "type":"object",
    "description":"Metadata describing link description objects that MAY appear in the JSON instance representation.",
    "properties":{
        "href":{
            "description":"URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \"templated\" property must be set to true.",
            "type":"string"
        },
        "rel":{
            "description":"Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.",
            "type":"string"
        },
        "templated":{
            "description":"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.",
            "type":"boolean"
        },
        "mediaType":{
            "description":"Media type, as defined by RFC 2046, describing the link target.",
            "type":"string"
        },
        "method":{
            "description":"HTTP method for requesting the target of the link.",
            "type":"string"
        },
        "profile":{
            "description":"Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..",
            "type":"string"
        }
    },
    "required":[
        "href",
        "rel"
    ]
}

Nested Schema : LocaleKey-allOf[1]

Type: object

Show Source

• recordId(optional): string

  The unique identifier of the Locale object.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"<p>The unique identifier of the Locale object.</p>"
        }
    }
}

Nested Schema : DataFormKey-allOf[1]

Type: object

Show Source

• 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.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"The unique record ID of the DataForm object."
        },
        "referenceKey":{
            "type":"string",
            "description":"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: object

Show Source

• 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.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"The unique record ID of the User object."
        },
        "name":{
            "type":"string",
            "description":"User's full name"
        },
        "email":{
            "type":"string",
            "description":"Email of the User object"
        },
        "externalId":{
            "type":"integer",
            "description":"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":{
            "type":"string",
            "description":"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."
        }
    }
}

Back to Top

Response

204 Response

No Content.

Back to Top

Examples

The following example shows how to rate the latest valid version of 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/{id}/rate"

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://<IM_REST_API_HOST>/km/api/{version}/{resourceURI}",
      "mediaType" : "application/json, application/xml",
      "templated" : true,
      "method" : "GET"
    } ]
  },
  "locale" : {
  },
  "answer" : {
  },
  "answerComment" : "ANSWER_COMMENT"
}

Back to Top