REST API for Knowledge Advanced in B2C Service

Get rating results

get

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

This method returns a list of all the ratings results for a content record.

Example URIs

Following are the example URIs for this method:

http://<IM_REST_API_HOST>/km/api/latest/content/{id}/ratings
The request returns a paginated list of all the ratings results for a content record sorted by date added in ascending order.
http://<IM_REST_API_HOST>/km/api/latest /content/{id}/ratings?orderBy=dateAdded:desc
The request returns a paginated list of all the ratings results for a content record sorted by date added in descending order. The fields that you can sort are recordId, dateAdded, and dateModified.

Request

Path Parameters

id: string

The content identifier.

Response

Supported Media Types

application/json
application/xml

200 Response

OK.

Root Schema : ResultList DataFormResults

Type: object

Title: ResultList DataFormResults

Match All

Show Source

allOf Collection Paging Resource

Title: Collection Paging Resource

Oracle base collection resource schema definition.
object ResultList DataFormResults-allOf[1]

{
    "title":"ResultList DataFormResults",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/collectionPagedResource"
        },
        {
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/DataFormResults"
                    }
                }
            }
        }
    ]
}

Nested Schema : Collection Paging Resource

Title: Collection Paging Resource

Oracle base collection resource schema definition.

Match All

Show Source

allOf Base Collection Resource

Title: Base Collection Resource

Oracle base collection resource schema definition.
object Collection Paging Resource-allOf[1]

{
    "title":"Collection Paging Resource",
    "description":"Oracle base collection resource schema definition. ",
    "allOf":[
        {
            "$ref":"#/definitions/collectionBaseResource"
        },
        {
            "properties":{
                "hasMore":{
                    "type":"boolean",
                    "description":"Boolean value that is set to true if more resources are available on the server than the subset returned in current page."
                },
                "totalResults":{
                    "type":"integer",
                    "description":"Total count of the resource instances, including both the instances in the current range and the instances on the server that satisfy the request."
                },
                "limit":{
                    "type":"integer",
                    "description":"Actual paging size used by the server."
                },
                "count":{
                    "type":"integer",
                    "description":"Number of resource instances returned in the current range."
                },
                "offset":{
                    "type":"integer",
                    "description":"Offset value used in the current page. "
                }
            }
        }
    ]
}

Nested Schema : Base Collection Resource

Title: Base Collection Resource

Oracle base collection resource schema definition.

Match All

Show Source

object Singular Resource

Title: Singular Resource

Oracle base singular resource schema definition.
object Base Collection Resource-allOf[1]

{
    "title":"Base Collection Resource",
    "description":"Oracle base collection resource schema definition. ",
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "type":"object"
                    }
                }
            }
        }
    ]
}

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 : Base Collection Resource-allOf[1]

Type: object

Show Source

items(optional): array items

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    }
}

Nested Schema : Collection Paging Resource-allOf[1]

Type: object

Show Source

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.

{
    "properties":{
        "hasMore":{
            "type":"boolean",
            "description":"Boolean value that is set to true if more resources are available on the server than the subset returned in current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"Total count of the resource instances, including both the instances in the current range and the instances on the server that satisfy the request."
        },
        "limit":{
            "type":"integer",
            "description":"Actual paging size used by the server."
        },
        "count":{
            "type":"integer",
            "description":"Number of resource instances returned in the current range."
        },
        "offset":{
            "type":"integer",
            "description":"Offset value used in the current page. "
        }
    }
}

Nested Schema : ResultList DataFormResults-allOf[1]

Type: object

Show Source

items(optional): array items

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

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 : items

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Nested Schema : items

Type: array

Show Source

Array of: DataFormResults

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

Nested Schema : DataFormResults

Match All

Show Source

allOf DataFormResultsData
object DataFormResults-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/DataFormResultsData"
        },
        {
            "properties":{
                "locale":{
                    "$ref":"#/definitions/LocaleKey",
                    "description":"Relationship to Locale"
                },
                "questions":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/DetailQuestionResult"
                    },
                    "description":"To Many Relationship to DetailQuestionResult"
                },
                "user":{
                    "$ref":"#/definitions/UserKey",
                    "description":"Relationship to User"
                }
            }
        }
    ]
}

Nested Schema : DataFormResultsData

Match All

Show Source

allOf DataFormResultsKey
object DataFormResultsData-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/DataFormResultsKey"
        },
        {
            "properties":{
                "dateAdded":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The date when the DataFormResults object was created or added"
                },
                "dateModified":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The date when the DataFormResults object was last modified."
                }
            }
        }
    ]
}

Nested Schema : DataFormResultsKey

Match All

Show Source

object Singular Resource

Title: Singular Resource

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

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"The unique record ID of the DataFormResults object."
                }
            }
        }
    ]
}

Nested Schema : DataFormResultsKey-allOf[1]

Type: object

Show Source

recordId(optional): string

The unique record ID of the DataFormResults object.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"The unique record ID of the DataFormResults object."
        }
    }
}

Nested Schema : DataFormResultsData-allOf[1]

Type: object

Show Source

dateAdded(optional): string(date-time)

The date when the DataFormResults object was created or added
dateModified(optional): string(date-time)

The date when the DataFormResults object was last modified.

{
    "properties":{
        "dateAdded":{
            "type":"string",
            "format":"date-time",
            "description":"The date when the DataFormResults object was created or added"
        },
        "dateModified":{
            "type":"string",
            "format":"date-time",
            "description":"The date when the DataFormResults object was last modified."
        }
    }
}

Nested Schema : DataFormResults-allOf[1]

Type: object

Show Source

locale(optional): LocaleKey
questions(optional): array questions

To Many Relationship to DetailQuestionResult
user(optional): UserKey

{
    "properties":{
        "locale":{
            "$ref":"#/definitions/LocaleKey",
            "description":"Relationship to Locale"
        },
        "questions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DetailQuestionResult"
            },
            "description":"To Many Relationship to DetailQuestionResult"
        },
        "user":{
            "$ref":"#/definitions/UserKey",
            "description":"Relationship to User"
        }
    }
}

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 : questions

Type: array

To Many Relationship to DetailQuestionResult

Show Source

Array of: DetailQuestionResult

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DetailQuestionResult"
    },
    "description":"To Many Relationship to DetailQuestionResult"
}

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 : 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 : DetailQuestionResult

Match All

Show Source

object DetailQuestionResultKey

Title: DetailQuestionResultKey
object DetailQuestionResult-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/DetailQuestionResultKey"
        },
        {
            "properties":{
                "answers":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/DetailAnswerResult"
                    },
                    "description":"To Many Relationship to DetailAnswerResult"
                }
            }
        }
    ]
}

Nested Schema : DetailQuestionResultKey

Type: object

Title: DetailQuestionResultKey

Show Source

recordId(optional): string

The unique record ID of the DetailQuestionResult object.
referenceKey(optional): string

The reference key for the DetailQuestionResult object. DetailQuestionResult objects support multiple languages. This field can be used to identify the associated objects for all languages.

{
    "title":"DetailQuestionResultKey",
    "properties":{
        "recordId":{
            "type":"string",
            "description":"The unique record ID of the DetailQuestionResult object."
        },
        "referenceKey":{
            "type":"string",
            "description":"The reference key for the DetailQuestionResult object. DetailQuestionResult objects support multiple languages. This field can be used to identify the associated objects for all languages."
        }
    }
}

Nested Schema : DetailQuestionResult-allOf[1]

Type: object

Show Source

answers(optional): array answers

To Many Relationship to DetailAnswerResult

{
    "properties":{
        "answers":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DetailAnswerResult"
            },
            "description":"To Many Relationship to DetailAnswerResult"
        }
    }
}

Nested Schema : answers

Type: array

To Many Relationship to DetailAnswerResult

Show Source

Array of: DetailAnswerResult

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DetailAnswerResult"
    },
    "description":"To Many Relationship to DetailAnswerResult"
}

Nested Schema : DetailAnswerResult

Match All

Show Source

object DetailAnswerResultKey

Title: DetailAnswerResultKey
object DetailAnswerResult-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/DetailAnswerResultKey"
        },
        {
            "properties":{
                "text":{
                    "type":"string",
                    "description":"Text of the DetailAnswerResult object"
                },
                "value":{
                    "type":"integer",
                    "description":"Value of the DetailAnswerResult object"
                }
            }
        }
    ]
}

Nested Schema : DetailAnswerResultKey

Type: object

Title: DetailAnswerResultKey

Show Source

recordId(optional): string

The unique record ID of the DetailAnswerResult object.
referenceKey(optional): string

The reference key for the DetailAnswerResult object. DetailAnswerResult objects support multiple languages. This field can be used to identify the associated objects for all languages.

{
    "title":"DetailAnswerResultKey",
    "properties":{
        "recordId":{
            "type":"string",
            "description":"The unique record ID of the DetailAnswerResult object."
        },
        "referenceKey":{
            "type":"string",
            "description":"The reference key for the DetailAnswerResult object. DetailAnswerResult objects support multiple languages. This field can be used to identify the associated objects for all languages."
        }
    }
}

Nested Schema : DetailAnswerResult-allOf[1]

Type: object

Show Source

text(optional): string

Text of the DetailAnswerResult object
value(optional): integer

Value of the DetailAnswerResult object

{
    "properties":{
        "text":{
            "type":"string",
            "description":"Text of the DetailAnswerResult object"
        },
        "value":{
            "type":"integer",
            "description":"Value of the DetailAnswerResult object"
        }
    }
}

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."
        }
    }
}

Examples

The following example shows how to find all ratings results for a Content record by submitting a get request on the REST resource using cURL.

cURL Command

Command: curl -X "GET" "http://<IM_REST_API_HOST>/km/api/latest/content/{id}/ratings"

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" : [ {
    "locale" : {
      "links" : [ {
        "rel" : "canonical",
        "href" : "http://<IM_REST_API_HOST>/km/api/{version}/{resourceURI}",
        "mediaType" : "application/json, application/xml",
        "templated" : true,
        "method" : "GET",
        "profile" : "http://<IM_REST_API_HOST>/km/api/{version}/metadata-catalog/{resourceName}"
      } ]
    },
    "questions" : [ {
      "answers" : [ {
        "text" : "TEXT_VALUE",
        "value" : -1895849025,
        "referenceKey" : "REFERENCEKEY_VALUE"
      } ],
      "referenceKey" : "REFERENCEKEY_VALUE"
    } ],
    "user" : {
      "name" : "NAME_VALUE",
      "externalType" : "EXTERNALTYPE_VALUE",
      "links" : [ {
        "rel" : "canonical",
        "href" : "http://<IM_REST_API_HOST>/km/api/{version}/{resourceURI}",
        "mediaType" : "application/json, application/xml",
        "templated" : true,
        "method" : "GET",
        "profile" : "http://<IM_REST_API_HOST>/km/api/{version}/metadata-catalog/{resourceName}"
      } ]
    },
    "links" : [ {
      "rel" : "canonical",
      "href" : "http://<IM_REST_API_HOST>/km/api/{version}/{resourceURI}",
      "mediaType" : "application/json, application/xml",
      "templated" : true,
      "method" : "GET"
    } ],
    "dateAdded" : "2013-04-30T21:34:23EDT",
    "dateModified" : "2013-04-30T21:34:23EDT"
  } ],
  "hasMore" : false,
  "limit" : 20,
  "offset" : 0,
  "count" : 1
}