Create User Variables

Creates user variables to help filter the members displayed in a form in the application.

Method and URI

Method: POST

Path: /HyperionPlanning/rest/v3/applications/{application}/uservariables

In this path, application is a required parameter. Use a valid application name.

Example: https://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/uservariables

Request

Supported Media Types: application/json

Table 8-83 Parameters

Name	Description	Required
items	Collection of information about the resource.	Yes
dimension	The name of the dimension for which the user variable is to be created.	Yes
name	The name of the user variable definition.	Yes
definition	The user variable limit defined by a member selection. In addition to setting the limits by members, Service Administrators can select limits by function (for example, IChildren(Existing Employees).	No
useContext	Use context for the variable. Note: This setting determines whether users can choose this value from user preferences or is inherited from another form based on its Point of View context, in which case it changes dynamically based on the context of the form.	No

Example Payload

{
    "items": [
        {
            "dimension": "Account",
            "name": "Account View",
            "definition": "\"No Account\",CF, \"Cash Flow Hierarchies\"",
            "useContext": true
        },
        {
            "dimension": "Period",
            "name": "Applicable Periods",
            "definition": "QTD,Rolling,YTD",
            "useContext": false
        }
    ]
}

Response

Supported Media Types: application/json

Response for successful operation: Http status code: 201 Created

Response for failed Operation: Http status code: 400 Bad Request. A detailed error message will be a part of the response body.

Table 8-84 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.