Get All User Variables

Returns a list of all the user variables defined for the specified application.

Method and URI

Method: GET

Path: /HyperionPlanning/rest/v3/applications/{application}/uservariables?offset=0&limit=2

Example 1 (without optional parameters): https://<BASE_URL>/HyperionPlanning/rest/v3/applications/Vision/uservariables

Example 2 (optionally specifying an offset and limit): https://<BASE_URL>/HyperionPlanning/rest/v3/applications/Vision/uservariables?offset=0&limit=2

Table 8-79 Parameters

Name	Description	Type	Required	Default
application	The name of the application.	Path	Yes	None
offset	The index from which the records are returned. It is a 0 based non-negative integer.	Query	No	0
limit	The number of items to return. A limit of 0 or -1 will return all records starting from the index defined by the offset.	Query	No	25

Response

Supported Media Types: application/json

Table 8-80 Parameters

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

Examples of Response Body

This is an example of a body from a request without optional parameters:

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

This is an example of a response body from a request with offset and limit:

{
"links": [
        {
            "rel": "self",
            "href":"http://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/uservariables?offset=0&limit=2",
            "action": "GET"
        },
        {
            "rel": "next",
            "href":"http://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/uservariables?offset=2&limit=2",
            "action": "GET"
        }
    ],
  "items": [
      {
            "id": "935d4dc1-5b2b-457f-0000-0010cfc98fb2",
            "dimension": "Account",
            "name": "Account View",
            "definition": "No Account,CF,Cash Flow Hierarchies",
            "useContext": true
        },
        {
            "id": "0f8828d0-30f1-4d04-0000-001160e3335f",
            "dimension": "Period",
            "name": "Applicable Periods",
            "definition": "QTD,Rolling,YTD",
            "useContext": false
        }
  ],
    "totalResults": 2,
    "hasMore": true
}