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