Get User Preferences

Returns the requesting user’s display preferences.

Before using the REST resources, you must understand how to access the REST resources and other important concepts. See About the REST APIs. Using these REST APIs requires prerequisites. See Prerequisites.

REST Resource

GET /HyperionPlanning/rest/{api_version}/applications/{application}/userpreferences

Request

Parameters:

The following table summarizes the client request.

Table 5-57 Parameters

Name Description Type Required Default
api_version Version of the API you are developing with Path Yes None
application The name of the application Path Yes None
userpreferences The requesting user’s display preferences path Yes None

Example URL

https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/v3/applications/PS4app1/userpreferences

Response

Supported Media Types: application/json

Table 5-58 Parameters

Name Description
decimal separator Preference for decimal separator
scale Preference for scale
thousandsSeparator Preference for the thousands separator
thousandsSeparator Preference for the style of negative numbers
negativeStyle Preference for the minimum precision
minPrecision Preference for the minimum precision
maxPrecision Preference for the maximum precision
showPUAlias Preference for showing the planning unit alias
currSymbol Preference for the currency symbol
type The type of application, such as HP

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "decimalSeparator": "",
    "scale": 0,
    "thousandsSeparator": "",
    "negativeStyle": 255,
    "minPrecision": 0,
    "maxPrecision": 0,
    "showPUAlias": false,
    "currSymbol": "",
    "links": [{
        "rel": "self",
        "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/v3/applications/PS4app1/userpreferences",
        "action": "GET"
    }]
}