Jump to

• Request
• Response
• Examples

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

• id: string
  The unique identifier of the object to be retrieved.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK.

Body ()

Root Schema : UserKeyValue

Match All

Show Source

• allOf UserKeyValueData
• object UserKeyValue-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/UserKeyValueData"
        },
        {
            "properties":{
                "userInformation":{
                    "$ref":"#/definitions/UserKey",
                    "description":"The relationship between the user and object."
                }
            }
        }
    ]
}

Nested Schema : UserKeyValueData

Match All

Show Source

• allOf UserKeyValueKey
• object UserKeyValueData-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/UserKeyValueKey"
        },
        {
            "properties":{
                "dateAdded":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The date when the UserKeyValue object was created."
                },
                "dateModified":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The date when the UserKeyValue object was last modified."
                },
                "key":{
                    "type":"string",
                    "description":"The key associated with the UserKeyValue object. This field is related to the value field for a user. FAVORITES is an example key."
                },
                "value":{
                    "type":"string",
                    "description":"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 : UserKeyValueKey

Match All

Show Source

• object Singular Resource
  Title: Singular Resource

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

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"The unique identifier that represents a userKeyValue resource."
                }
            }
        }
    ]
}

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 : UserKeyValueKey-allOf[1]

Type: object

Show Source

• recordId(optional): string
  The unique identifier that represents a userKeyValue resource.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"The unique identifier that represents a userKeyValue resource."
        }
    }
}

Nested Schema : UserKeyValueData-allOf[1]

Type: object

Show Source

• dateAdded(optional): string(date-time)
  The date when the UserKeyValue object was created.
• dateModified(optional): string(date-time)
  The date when the UserKeyValue object was last modified.
• key(optional): string
  The key associated with the UserKeyValue object. This field is related to the value field for a user. FAVORITES is an example key.
• value(optional): 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.

{
    "properties":{
        "dateAdded":{
            "type":"string",
            "format":"date-time",
            "description":"The date when the UserKeyValue object was created."
        },
        "dateModified":{
            "type":"string",
            "format":"date-time",
            "description":"The date when the UserKeyValue object was last modified."
        },
        "key":{
            "type":"string",
            "description":"The key associated with the UserKeyValue object. This field is related to the value field for a user. FAVORITES is an example key."
        },
        "value":{
            "type":"string",
            "description":"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

• userInformation(optional): UserKey

{
    "properties":{
        "userInformation":{
            "$ref":"#/definitions/UserKey",
            "description":"The relationship between the user and object."
        }
    }
}

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

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