Get a named user's preferences
Returns the full preference details. Reading another user's preferences requires administrator access.
Required Roles
Service Administrator
REST Resource
GET /HyperionPlanning/rest/v3/applications/{application}/users/{username}/preferences
Request
Parameters:
Table 3-43 Request Parameters
| Name | Description | Type | Required | Default |
|---|---|---|---|---|
application
|
The name of the application. | path | Yes | None |
username
|
User login name. | path | Yes | None |
No request body is defined for this operation.
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-44 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"
}
}