Update
/km/api/v1/users/{userId}/userKeyValues/{id}
This method updates 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}
This request updates a UserKeyValue object having the specified user key value ID.
/li>
Response Errors
The possible error responses for this method are as follows:
- OK-GEN0024
The error occurs when the record Id of the specified UserKeyValue in the service request does not match the userKeyValue.recordId parameter value.
- OK-GEN0005
The error occurs in either of the following cases:
- A user record for the specified ID does not exist.
- The parameter values of userKeyValue.key, userinformation, or userinformation.reocrdId are null.
- OK-GEN0012
The error occurs when the userKeyValue.key parameter value is not same as the previously stored value.
- OKDOM-USERKV0002
The error occurs when the specified user record Id does not match the userinformation.recordId parameter value.
Request
- application/json
- application/xml
-
id: string
The unique identifier of the object to be updated.
-
object
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
UserKeyValueKey-allOf[1]
object
Singular Resource
object
-
recordId(optional):
string
The unique identifier that represents a userKeyValue resource.
object
-
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.
array
-
Array of:
object instanceLink
Metadata describing link description objects that MAY appear in the JSON instance representation.
object
-
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.
-
object
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
UserKey-allOf[1]
object
-
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.
Response
- application/json
- application/xml
200 Response
-
object
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
UserKeyValueKey-allOf[1]
object
Singular Resource
object
-
recordId(optional):
string
The unique identifier that represents a userKeyValue resource.
object
-
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.
array
-
Array of:
object instanceLink
Metadata describing link description objects that MAY appear in the JSON instance representation.
object
-
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.
-
object
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
UserKey-allOf[1]
object
-
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.
Examples
The following example shows how to update the User Key Value object for the specified user ID by submitting a put request on the REST resource using cURL.
cURL Command
curl -X "PUT" "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",\"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.
{ "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" }
Example of Response Header
The following shows an example of the response header.
{ "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" }