Set the User Variable Values for the Application

This REST API can be used by administrators to set the user variables values for any user in the application. It can also be used by other users to set user variable values for themselves.

Required Roles

Service Administrator, Power User, User, Viewer

REST Resource

POST       /HyperionPlanning/rest/{api_version}/applications/{application}/uservariablevalues

Request

Supported Media Types: application/json

Parameters

The following table summarizes the client request.

Table 8-107 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/uservariables

Example Payload

With the following payload, the user variable values will be set for the user viewuser and testuser1 as per the payload

{ 
       "items": [
        {
            "userName": "viewuser",
            "name": "uservar2",
            "dimension": "Period",
            "member": "May"
        },
         {
            "userName": "testuser1",
            "name": "uservar2",
            "dimension": "Period",
            "member": "Apr"
        }
    ]
}

Response

Supported Media Types: application/json

Example of a successful reponse

Http status code: 204 (No content)

Example of an error response

Http status: 400

To confirm the results, you can go to the application to see the updates. In case of any error, a detailed error message will be a part of the response body.

Table 8-108 Error Parameters

Parameters	Description
items	Collection of error messages with the details.
id	Name of the erroneous parameter.
details	In case of errors, details are published with the error string.