Get all user key values
/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.
The following table describes the query parameters for this resource.
Parameter | Queryable | Sortable | Type | Description |
---|---|---|---|---|
recordId | Y | Y | 'type' : 'string' | The unique identifier that represents a userKeyValue resource. |
dateAdded | Y | Y | 'type' : 'string', 'format' : 'date-time' | The date when the UserKeyValue object was created. |
dateModified | Y | Y | 'type' : 'string', 'format' : 'date-time' | The date when the UserKeyValue object was last modified. |
key | Y | Y | '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. |
value | Y | Y | '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. |
userInformation | Y | N | '$ref' : '#/definitions/UserKey' | The relationship between the user and object. |
Request
-
limit(optional): integer
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.
-
mode(optional): string
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" ]
-
offset(optional): integer
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.
-
orderBy(optional): string
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.
-
q(optional): string
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.
Response
- application/json
- application/xml
200 Response
object
ResultList UserKeyValueData
-
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.
-
items(optional):
array items
-
limit(optional):
integer
Actual paging size used by the server.
-
links(optional):
array links
-
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.
array
-
Array of:
object UserKeyValueData
Title:
UserKeyValueData
array
-
Array of:
object instanceLink
Metadata describing link description objects that MAY appear in the JSON instance representation.
object
UserKeyValueData
-
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.
-
links(optional):
array links
-
recordId(optional):
string
The unique identifier that represents a userKeyValue resource.
-
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.
Examples
The following example shows how to find a list of User Key Value objects for the specified user by submitting a get request on the REST resource using cURL.
curl -X GET "https://<IM_REST_API_HOST/km/api/latest/users/{userId}/userKeyValues" -u "<username:password>" -H "Accept: application/json" -H "Content-Type: application/json"
Example of Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "recordId": "0800EFC596C244529709C93CCCFBB219", "links": [ { "rel": "canonical", "href": "https://IM_REST_API_HOST/km/api/latest/users/300100098184652/userKeyValues/0800EFC596C244529709C93CCCFBB219", "mediaType": "application/json, application/xml", "method": "GET" }, { "rel": "collection", "href": "https://IM_REST_API_HOST/km/api/latest/users/300100098184652/userKeyValues", "mediaType": "application/json, application/xml", "method": "GET" } ], "dateAdded": "2019-01-16T12:46:21+0000", "dateModified": "2019-01-16T12:46:27+0000", "key": "favorite_document", "value": "1016003,1016004,1017004,1017005,1017006,1016006" }, { "recordId": "4C984E575AD84F559B3EC3524304791C", "links": [ { "rel": "canonical", "href": "https://IM_REST_API_HOST/km/api/latest/users/300100098184652/userKeyValues/4C984E575AD84F559B3EC3524304791C", "mediaType": "application/json, application/xml", "method": "GET" }, { "rel": "collection", "href": "https://IM_REST_API_HOST/km/api/latest/users/300100098184652/userKeyValues", "mediaType": "application/json, application/xml", "method": "GET" } ], "dateAdded": "2018-06-06T07:38:21+0000", "dateModified": "2020-04-10T16:18:31+0000", "key": "RECENT_SEARCH", "value": "FAQ57" } ], "hasMore": false, "links": [ { "rel": "canonical", "href": "IM_REST_API_HOST/km/api/latest/users/300100098184652/userKeyValues?limit=20&offset=0", "mediaType": "application/json, application/xml", "method": "GET" } ], "count": 2 }