Get User Variable Values Defined in the Application by Value
Administrators can use this REST API to retrieve user variable values for all users where the value is set to a specific member name. Other users can use this REST API to retrieve user variable values for themselves where the value is set to a specific member name.
Required Roles
Service Administrator, Power User, User, Viewer
REST Resource
GET /HyperionPlanning/rest/{api_version}/applications/{application}/uservariablesvalues?q={"member":"member_name"}
Request
Supported Media Types: application/json
Parameters
The following table summarizes the client request.
Table 8-101 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 |
q |
Values to set for the member name. The values are described in the following row. | Query | No | None |
member |
Name of the member for which the user variable values will be returned. | Query | No | None |
Example URL
https://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/uservariablevalues?q={"member":"Apr"}
Response
Supported Media Types: application/json
Parameters
The following table summarizes the parameters.
Table 8-102 Parameters
Name | Description |
---|---|
items |
Collection of information about the resource |
userName |
Name of the user for whom the user variable value 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 |
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.
{
"items": [
{
"userName": "testuser1",
"name": "Period",
"dimension": "Period",
"member": "Apr"
},
{
"userName": "testuser2",
"name": "uservar2",
"dimension": "Period",
"member": "Apr"
}
],
"links": [
{
"rel": "self",
"href": "https://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/uservariablevalues",
"action": "GET",
"data": null
}
]
}