1. REST API for Knowledge Advanced in B2C Service
  2. Tasks
  3. Content (IM)
  4. User Key Values

Find all

get

/km/api/v1/users/{userId}/userKeyValues

This method returns a list of available UserKeyValue objects for a specified user.

This resource supports the orderBy request parameter which allows you to sort the returned paginated list of UserKeyValues objects.

You can find different values to use with the orderBy parameter in the schema and catalog information of the resource. To get the schema and catalog information, use GET method with the mediaType values as ???application/schema+json??? in the HTTP request.


Example URI

The example URI for this method is as follows:

  • http://<IM_REST_API_HOST>/km/api/latest/users/{userId}/userKeyValues

    This method returns a paginated list of UserKeyValue Business objects for the specified user.


Find by query

Supported Media Types: 'application/json', 'application/xml'


This method returns a list of UserKeyValue objects that match the specified criteria for the specified user ID.

Example URIs

The example URIs for this method are as follows:

  • http://<IM_REST_API_HOST>/km/api/latest/users/{userId}/userKeyValues?q=key eq 'FAVORITES

    The request returns a paginated list of UserKeyValue Business objects that have FAVORITES key.

  • http://<IM_REST_API_HOST>/km/api/latest/users/{userId}/userKeyValues?q=dateAdded gt '2015-02-01'

    The request returns a list of UserKeyValue objects that are created after February 1, 2015.

  • http://<IM_REST_API_HOST>/km/api/latest/users/{userId}/userKeyValues?q=recordId eq '{recordId}' and dateModified gt '2016-01-02'

    The request returns a list of UserKeyValues objects that have the specified record Id and that are last modified after January 2, 2016.

Response Errors

The possible error responses for this method are as follows:

  • OKDOM-CRIT0025

    The error occurs when an invalid criteria field is specified in the request.

Query Parameters

The following table describes the query parameters for this resource.

ParameterQueryableSortableTypeDescription
recordIdYY'type' : 'string'The unique identifier that represents a userKeyValue resource.
dateAddedYY'type' : 'string', 'format' : 'date-time'The date when the UserKeyValue object was created.
dateModifiedYY'type' : 'string', 'format' : 'date-time'The date when the UserKeyValue object was last modified.
keyYY'type' : 'string'The key associated with the UserKeyValue object. This field is related to the value field for a user. FAVORITES is an example key.
valueYY'type' : 'string'The value associated with the UserKeyValue object. This field is related to the key field for a user. FAQ1, FAQ23, FAQ44 are example values.
userInformationYN'$ref' : '#/definitions/UserKey'The relationship between the user and object.

Request

Query Parameters
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter defines amount of information to be included in the returned resources - KEY is the one that has least information (and hence performs better) and FULL is the one that has most information.
    Allowed Values: [ "KEY", "DATA", "EXTENDED", "FULL" ]
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and 'asc' or 'desc'. Specify 'asc' for ascending and 'desc' for descending. The default value is 'asc'. For example, ?orderBy=field1:asc,field2:desc.
  • Value for this parameter should be Oracle Knowledge Q query - see the 'Getting Started' documentation ('Querying' page) of this operation and documentation for Q query.
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : ResultList UserKeyValueData
Type: object
Title: ResultList UserKeyValueData
Match All
Show Source
Nested Schema : Collection Paging Resource
Title: Collection Paging Resource
Oracle base collection resource schema definition.
Match All
Show Source
Nested Schema : Base Collection Resource
Title: Base Collection Resource
Oracle base collection resource schema definition.
Match All
Show Source
Nested Schema : Singular Resource
Type: object
Title: Singular Resource
Oracle base singular resource schema definition.
Show Source
Nested Schema : Base Collection Resource-allOf[1]
Type: object
Show Source
Nested Schema : Collection Paging Resource-allOf[1]
Type: object
Show Source
Nested Schema : ResultList UserKeyValueData-allOf[1]
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Type: object
Nested Schema : items
Type: array
Show Source
Nested Schema : UserKeyValueData
Match All
Show Source
Nested Schema : UserKeyValueKey
Match All
Show Source
Nested Schema : UserKeyValueKey-allOf[1]
Type: object
Show Source
Nested Schema : UserKeyValueData-allOf[1]
Type: object
Show Source
Back to Top

Examples

The following example shows how to find all User Key Value objects for the specified user by submitting a get request on the REST resource using cURL.

cURL Command

curl -X "GET" "http://<IM_REST_API_HOST>/km/api/latest/users/{userId}/userKeyValues"

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" : [ {
    "dateAdded" : "2013-04-23T23:29:26EDT",
    "dateModified" : "2013-04-23T23:29:26EDT",
    "key" : "FAVORITES",
    "value" : "FAQ1,FAQ23,FAQ44",
    "recordId" : "252801652352503b3523550144e01818e1247bs93",
    "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}"
    } ]
  } ],
  "hasMore" : false,
  "limit" : 20,
  "offset" : 0,
  "links" : [ {
    "rel" : "canonical",
    "href" : "http://<IM_REST_API_HOST>/km/api/{version}/userKeyValues?limit=20&offset=0",
    "mediaType" : "application/json, application/xml",
    "method" : "GET"
  } ],
  "count" : 1
}
Back to Top