Update named user sticky preferences

Merges the supplied stickyPrefs map into the existing map and returns the resulting selections. Access to another user requires administrator privileges.

Required Roles

Access to another user requires administrator privileges.

REST Resource

POST /HyperionPlanning/rest/v3/applications/{application}/users/{username}/stickypreferences

Request

Parameters:

Table 3-53 Request Parameters

Name Description Type Required Default
application The name of the application. path Yes None
username User login name. Access to another user requires administrator privileges. path Yes None
stickyPrefs Sticky preference keys and values. POST merges supplied entries with existing preferences. payload Yes None
stickyPrefs.lastDimension The dimension most recently selected by the user. payload When supplying the containing object None

Send a required request body with Content-Type: application/json.

String-valued UI selections remembered for a user.

The payload rows describe the fields in the following request examples. Other supported options and conditional requirements are described above.

Example request body:

{
  "stickyPrefs": {
    "lastDimension": "Entity"
  }
}

Example URL

https://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/users/planner1/stickypreferences

Response

Supported Media Types: application/json

Wrapped preference fields contain defaultValue, value, and useDefault. Extended fields also contain sourceValue, the server-side source value used when saving a preference.

Table 3-54 Response Parameters

Name Description
stickyPrefs Sticky preference keys and values. POST merges supplied entries with existing preferences.
stickyPrefs.lastDimension The dimension most recently selected by the user.
links Links to this resource and related operations.
links[].rel The relationship of the linked resource to this resource.
links[].href The URL of the linked resource.
links[].action The HTTP method used to access the linked resource.

Sample Response

The following shows an example response.

{
  "stickyPrefs": {
    "lastDimension": "Entity"
  },
  "links": [
    {
      "rel": "self",
      "href": "https://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision",
      "action": "GET"
    }
  ]
}