Get User Variable Values Defined for the Application
Administrators can use this REST API to retrieve user variable values set for all users and for all user variables defined for the application. Other users can use this REST API to retriev euser variable values set for themselves for all user variables.
Required Roles
Service Administrator, Power User, User, Viewer
REST Resource
GET /HyperionPlanning/rest/{api_version}/applications/{application}/uservariablevalues
Request
Supported Media Types: application/json
Parameters
The following table summarizes the client request.
Table 8-97 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 |
Example URL
https://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/uservariablevalues
Response
Supported Media Types: application/json
Parameters
The following table summarizes the parameters.
Table 8-98 Parameters
Name | Description |
---|---|
items |
Collection of information about the resource |
userName |
Name of the user for whom the user variable is set |
name |
Name of the user variable, such as Account View |
dimension |
Name of the dimension to which the member belongs, such as Account |
member |
Name of the member that is set for the user variable value, such as Units |
Example of Response Body
The following shows an example of the response body for an adminisntrator.
{
"items": [
{
"userName": "testuser1",
"name": "Period",
"dimension": "Period",
"member": "Apr"
},
{
"userName": "testuser1",
"name": "uservar2",
"dimension": "Period",
"member": "Jun"
},
{
"userName": "testuser2",
"name": "uservar3",
"dimension": "Period",
"member": "Jan"
}
],
"links": [
{
"rel": "self",
"href": "https://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/uservariablevalues",
"action": "GET",
"data": null
}
]
}