Grant or Revoke Preferences for the Logged in User
post
/ic/api/process/v1/preferences
Grant or revoke user preferences and application preferences for the logged in user. You must be an administrator to grant or revoke application preferences
Request
Supported Media Types
- application/json
Query Parameters
-
operation: string
Operation - grant OR revoke. Default operation is grantDefault Value:
grant
PreferenceRequest Object
Root Schema : preferencesResponse
Type:
Show Source
object
-
appPrefKeys:
array appPrefKeys
-
appPrefReq:
object appPrefReq
Additional Properties Allowed: additionalProperties
-
deleteAllAppPreferences:
boolean
-
deleteAllUserPreferences:
boolean
-
userPrefKeys:
array userPrefKeys
-
userPrefReq:
object userPrefReq
Additional Properties Allowed: additionalProperties
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
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 set user and application preferences for the logged in user by submitting a POST request on the REST resource.
Example: Set user and application preferences for the logged in user
Send Request:
POST https://example.com/ic/api/process/v1/preferences
Request Body:
Start and end date must be in ISO-8601 format.
{
"userPrefReq" : {
"NOTIFICATION_TZ": "PST",
"TASKLIST_FETCH_SIZE" : "50",
"TASKLIST_DEFAULT_GROUPING" : "PROCESS_NAME",
"VACATION_RULE": {
"targetUser" : "jcooper",
"detail" : { "action":"DELEGATE", "startDate" : "2019-10-07", "endDate" : "2019-12-09"}
}
},
"appPrefReq" : {
"TASKLIST_FETCH_SIZE" : "50",
"TASKLIST_DEFAULT_GROUPING" : "PROCESS_NAME"
}
}