Get User Variable Values Defined for the Application by the User Name

Administrators can use this REST API to retrieve user variable values for one or more users. Other users named in the request 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_name1","user_name2"]}

Request

Supported Media Types: application/json

Parameters

The following table summarizes the client request.

Table 8-117 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
userName	Name of the user whose user variable values are to be retrieved. If retrieving the values for multiple users, use a comma separated array to list users.	Query	Yes	None
offset	Indicates the actual index from which the records are returned. It is a 0 based non-negative integer.	Query	No	0
limit	Controls how many items to return. A limit of 0 or -1 will return all records starting from the index defined by the offset.	Query	No	25

Example URL to retrieve user variable values of one user:

https://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/uservariablevalues?q={"userName":"testuser1"}

Example URL to retrieve user variable values of multiple users:

https://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/uservariablevalues?q={"userName":["testuser1","testuser2"]}

Optionally specifying paging with an offset and limit:

https://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/uservariablevalues?q={"userName":"testuser1"}&offset=0&limit=5

Response

Supported Media Types: application/json

Parameters

The following table summarizes the parameters.

Table 8-118 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
        }
    ]
}