Find by ID

get

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

This method returns a UserKeyValue object having the specified user key value ID.


Example URI

The example URI for this method is as follows:

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

    The request returns the UserKeyValue object having the specified ID parameter.

Response Error

The possible error response for this method is as follows:

  • OKDOM-GEN0001

    The error occurs when a UserKeyValue object does not exist for the specified ID.

Request

Path Parameters
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : UserKeyValue
Match All
Show Source
Nested Schema : UserKeyValueData
Match All
Show Source
Nested Schema : UserKeyValueKey
Match All
Show Source
Nested Schema : Singular Resource
Type: object
Title: Singular Resource
Oracle base singular resource schema definition.
Show Source
Nested Schema : UserKeyValueKey-allOf[1]
Type: object
Show Source
Nested Schema : UserKeyValueData-allOf[1]
Type: object
Show Source
  • The date when the UserKeyValue object was created.
  • The date when the UserKeyValue object was last modified.
  • The key associated with the UserKeyValue object. This field is related to the value field for a user. FAVORITES is an example key.
  • The value associated with the UserKeyValue object. This field is related to the key field for a user. FAQ1, FAQ23, FAQ44 are example values.
Nested Schema : UserKeyValue-allOf[1]
Type: object
Show Source
Nested Schema : UserKey
Match All
Show Source
Nested Schema : UserKey-allOf[1]
Type: object
Show Source
  • Email of the User object
  • 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.
  • 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.
  • User's full name
  • The unique record ID of the User object.
Back to Top

Examples

The following example shows how to find the User Key Value object that matches the specified user ID 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/{id}"

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.

{
  "userInformation" : {
    "recordId" : "048016503b35e6fc0144e01818e2007b87",
    "name" : "John Smith",
    "externalId" : 12345,
    "externalType" : "CONTACT",
    "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",
    "profile" : "http://<IM_REST_API_HOST>/km/api/{version}/metadata-catalog/{resourceName}"
  } ],
  "dateAdded" : "2013-04-23T21:06:43EDT",
  "dateModified" : "2013-04-23T21:06:43EDT",
  "key" : "FAVORITES",
  "value" : "FAQ1,FAQ23,FAQ44"
}
Back to Top