Get subscriptions
/km/api/v1/users/{id}/subscriptions
This method returns a list of Subscription 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:
- active
- dateAdded
- dateModified
- lastCrawl
- name
- recordId
- subscriptionType
Response Error:
- OK-SEC0001 - If a user does not have the USER_VIEW or WEB_USER_VIEW privilege and attempts to retrieve the list of subscriptions associated with another user.
Example URIs:
- http://<IM_REST_API_HOST>/km/api/latest/users{id}/subscriptions
The method returns a list of Subscription 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}/subscriptions?answerId={answerId}
The method returns a list of Subscription objects associated with the User object having the specified answerId parameter.
- http://<IM_REST_API_HOST>/km/api/latest/users{id}/subscriptions?orderBy=dateAdded:desc
The method returns a list of Subscription objects associated with the User object having the specified ID parameter sorted by date added in descending order.
Request
-
id: string
The unique identifier of the User object
Response
- application/json
- application/xml
200 Response
object
ResultList SubscriptionKey
-
allOf
Collection Paging Resource
Title:
Collection Paging Resource
Oracle base collection resource schema definition. -
object
ResultList SubscriptionKey-allOf[1]
Collection Paging Resource
-
allOf
Base Collection Resource
Title:
Base Collection Resource
Oracle base collection resource schema definition. -
object
Collection Paging Resource-allOf[1]
Base Collection Resource
-
object
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
Base Collection Resource-allOf[1]
object
Singular Resource
object
-
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.
-
limit(optional):
integer
Actual paging size used by the server.
-
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 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
-
object
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
SubscriptionKey-allOf[1]
object
-
recordId(optional):
string
The unique record ID of the Subscription object.
Examples
The following example shows how to find all subscription objects associated with the User object having the specified ID parameter 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/{id}/subscriptions"
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.
This request does not return any response body.