REST API for Knowledge Management in Oracle Fusion Service

Get all user key values assigned

get

/km/api/v1/users/{id}/customKeyValues

This method returns a list of UserKeyValue objects associated with the User object having the specified ID parameter.

This resource supports the orderBy request parameter. You can use this parameter along with the HTTP service request to sort the returned list.

The following values can be used with the orderBy parameter:

dateAdded
dateModified
key
recordId
value

Example URIs:

The example URIs for this method are as follows:

http://<IM_REST_API_HOST>/km/api/latest/users/{id}/customKeyValues
The method returns a list of UserKeyValue objects associated with the User object having the specified ID parameter sorted by date added in ascending order.
http://<IM_REST_API_HOST>/km/api/latest/users/{id}/customKeyValues?orderBy=dateAdded:desc
The method returns a list of UserKeyValue objects associated with the User object having the specified ID parameter sorted by date added in descending order.

Request

Path Parameters

id: string

The unique identifier of the User object

Response

Supported Media Types

application/json
application/xml

200 Response

OK.

Root Schema : ResultList UserKeyValueKey

Type: object

Title: ResultList UserKeyValueKey

Show Source

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.

{
    "title":"ResultList UserKeyValueKey",
    "properties":{
        "hasMore":{
            "description":"Boolean value that is set to true if more resources are available on the server than the subset returned in current page.",
            "type":"boolean"
        },
        "limit":{
            "description":"Actual paging size used by the server.",
            "type":"integer"
        },
        "count":{
            "description":"Number of resource instances returned in the current range.",
            "type":"integer"
        },
        "totalResults":{
            "description":"Total count of the resource instances, including both the instances in the current range and the instances on the server that satisfy the request.",
            "type":"integer"
        },
        "items":{
            "items":{
                "$ref":"#/definitions/UserKeyValueKey"
            },
            "type":"array"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "offset":{
            "description":"Offset value used in the current page. ",
            "type":"integer"
        }
    },
    "type":"object"
}

Nested Schema : items

Type: array

Show Source

Array of: object UserKeyValueKey

Title: UserKeyValueKey

{
    "items":{
        "$ref":"#/definitions/UserKeyValueKey"
    },
    "type":"array"
}

Nested Schema : links

Type: array

Show Source

Array of: object instanceLink

Metadata describing link description objects that MAY appear in the JSON instance representation.

{
    "items":{
        "$ref":"#/definitions/instanceLink"
    },
    "type":"array"
}

Nested Schema : UserKeyValueKey

Type: object

Title: UserKeyValueKey

Show Source

links(optional): array links
recordId(optional): string

The unique identifier that represents a userKeyValue resource.

{
    "title":"UserKeyValueKey",
    "properties":{
        "recordId":{
            "description":"The unique identifier that represents a userKeyValue resource.",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object instanceLink

Metadata describing link description objects that MAY appear in the JSON instance representation.

{
    "items":{
        "$ref":"#/definitions/instanceLink"
    },
    "type":"array"
}

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.

{
    "description":"Metadata describing link description objects that MAY appear in the JSON instance representation.",
    "properties":{
        "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"
        },
        "method":{
            "description":"HTTP method for requesting the target of the link.",
            "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"
        },
        "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"
        },
        "mediaType":{
            "description":"Media type, as defined by RFC 2046, describing the link target.",
            "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"
    ],
    "type":"object"
}

Examples

The following example shows how to find all User Key Value objects associated with the User object having the specified ID parameter by submitting a get request on the REST resource using cURL.

cURL Command Example

curl -X GET "https://<IM_REST_API_HOST>/km/api/latest/users/{id}/customKeyValues" -u "<username:password>" -H "Accept: application/json" -H "Content-Type: application/json"

Example of Response Body

The following shows an example of the response body in JSON format.

{
  "items": [
    {
      "recordId": "5E9251D2AE454BE88BB7534A5256B067",
      "links": [
        {
          "rel": "canonical",
          "href": "http://IM_REST_API_HOST/km/api/latest/users/62AE91CBB23A49668BC7B9A220B696C7/userKeyValues/5E9251D2AE454BE88BB7534A5256B067",
          "mediaType": "application/json, application/xml",
          "method": "GET"
        },
        {
          "rel": "collection",
          "href": "http://IM_REST_API_HOST/km/api/latest/users/62AE91CBB23A49668BC7B9A220B696C7/userKeyValues",
          "mediaType": "application/json, application/xml",
          "method": "GET"
        }
      ]
    },
    {
      "recordId": "75F56044C4D94DC181CDA898D0F0B3E2",
      "links": [
        {
          "rel": "canonical",
          "href": "http://IM_REST_API_HOST/km/api/latest/users/62AE91CBB23A49668BC7B9A220B696C7/userKeyValues/75F56044C4D94DC181CDA898D0F0B3E2",
          "mediaType": "application/json, application/xml",
          "method": "GET"
        },
        {
          "rel": "collection",
          "href": "http://IM_REST_API_HOST/km/api/latest/users/62AE91CBB23A49668BC7B9A220B696C7/userKeyValues",
          "mediaType": "application/json, application/xml",
          "method": "GET"
        }
      ]
    }
  ],
  "hasMore": false,
  "limit": 20,
  "offset": 0,
  "links": [
    {
      "rel": "canonical",
      "href": "http://IM_REST_API_HOST/km/api/latest/users/62AE91CBB23A49668BC7B9A220B696C7/customKeyValues/?limit=20&offset=0",
      "mediaType": "application/json, application/xml",
      "method": "GET"
    }
  ],
  "count": 2
}