Update a named user's preferences

Saves supplied preference fields and returns the resulting preferences. Unspecified settings remain unchanged. Updating another user requires administrator access.

Required Roles

Updating another user requires administrator access.

REST Resource

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

Request

Parameters:

Table 3-45 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
highContrast High-contrast display and screen-reader preferences. payload No None
highContrast.value The current value of the preference. payload When supplying the containing object None
highContrast.useDefault Indicates whether to use the default preference value. payload When supplying the containing object None

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

Supply only the preferences to change. Fields not provided remain unchanged. Wrapped preference values contain defaultValue, value, and useDefault; extended values also contain sourceValue.

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

Example request body:

{
  "highContrast": {
    "value": false,
    "useDefault": false
  }
}

Example URL

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

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-46 Response Parameters

Name Description
printOptions Print layout, sizing, and content options.
printOptions.paperSize The paper size used when printing forms.
printOptions.orientation The page orientation used when printing forms.
printOptions.fitTo The page-fitting option used when printing forms.
printOptions.flow The order in which form content flows across printed pages.
adhocOptions Ad hoc navigation, display, suppression, precision, and submission options.
adhocOptions.memberDisplay The option controlling how member names and aliases are displayed.
adhocOptions.zoomInLevel The member level used when expanding members in an ad hoc grid.
adhocOptions.aliasTable The alias table used to display member aliases.
adhocOptions.ancestorPosition The position of ancestor members relative to their descendants.
adhocOptions.indentation The indentation option used to display members.
adhocOptions.qualifiedName The option controlling when qualified member names are displayed.

Sample Response

The following shows an example response.

{
  "printOptions": {
    "paperSize": "A4",
    "orientation": "PORTRAIT",
    "fitTo": "PAGE",
    "flow": "DOWN_THEN_ACROSS"
  },
  "adhocOptions": {
    "memberDisplay": "MEMBER_NAME",
    "zoomInLevel": "NEXT_LEVEL",
    "aliasTable": "Default",
    "ancestorPosition": "ANCESTOR_POSITION_BOTTOM",
    "indentation": "SUBITEM",
    "qualifiedName": "NEVER"
  }
}