Get User and Application Preferences for the Logged in User
get
/ic/api/process/v1/preferences
Get user and application preferences for the logged in user. Also allows admin to list preferences of other users
Request
Query Parameters
-
key: string
Preference key.
Valid values for keys with preference type USER:
- NOTIFICATION_TZ
- TASKLIST_FETCH_SIZE
- TASKLIST_DEFAULT_GROUPING
- VACATION_RULE
Valid values for keys with preference type APPLICATION:
- TASKLIST_FETCH_SIZE
- TASKLIST_DEFAULT_GROUPING
-
type: string
Preference type. Valid values: USER, APPLICATION, ALL.Default Value:
ALL
Allowed Values:[ "USER", "APPLICATION", "ALL" ]
-
user: string
User Id
Response
Supported Media Types
- application/json
200 Response
Success
Root Schema : preferencesResponse
Type:
Show Source
object
-
appPrefResponse:
object appPrefResponse
Additional Properties Allowed: additionalProperties
-
invalidUsers:
array invalidUsers
-
levels:
integer(int32)
-
links:
array links
-
message:
string
-
title:
string
-
userPrefResponse:
object userPrefResponse
Additional Properties Allowed: additionalProperties
400 Response
Bad request
401 Response
Unauthorized
500 Response
Internal Server Error
Examples
The following examples show how to retrieve user and application preferences for the logged in user by submitting a GET request on the REST resource.
Example: Get all user and application preferences for the logged in user
Send Request:
GET https://example.com/ic/api/process/v1/preferences
Example: Get only vacation preferences for the logged in user
Send Request:
GET https://example.com/ic/api/process/v1/preferences?key=VACATION_RULE&type=USER
Example: Get only user preferences for the logged in user
Send Request:
GET https://example.com/ic/api/process/v1/preferences?type=USER
Example: Get only application preferences for the logged in user
Send Request:
GET https://example.com/ic/api/process/v1/preferences?type=APPLICATION