Get a User Variable Using Its ID

Returns the user variable identified by a unique id.

Method and URI

Method: GET

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

Example: https://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/uservariables/29e76e76-e79e-4af6-0000-002ac4e2a55

Table 8-81 Parameters

Name	Description	Type	Required	Default
application	The name of the application.	Path	Yes	None
id	The unique id of the user variable that you want to retrieve.	Path	Yes	None

Response

Supported Media Types: application/json

Table 8-82 Parameters

Name	Description
id	The unique ID of the user variable.
dimension	The name of the dimension to which the user variable belongs.
name	The name of the user variable definition.
definition	Current value of the user variable limit defined by a member selection.
useContext	Current Use Context value.

{
    "links": [
        {
            "rel": "self",
            "href": "http://<BASE-URL>/HyperionPlanning/rest/v3/applications/
             Vision/uservariables/935d4dc1-5b2b-457f-0000-0010cfc98fb2",
             "action": "GET"
        }
    ],
    "id": "935d4dc1-5b2b-457f-0000-0010cfc98fb2",
    "dimension": "Account",
    "name": "Account View",
    "definition": "No Account,CF,Cash Flow Hierarchies",
    "useContext": true
}