Update User Variables

Modifies the Definition and/or Use Context values of user variables currently used 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-85 Payload Parameters

Name	Description
items	Collection of information about the resource.
id	The unique id of the user variable to be updated.
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).
useContext	The new Use Context value. 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.

Example Payload

{
    "items": [
        {
            "id": "935d4dc1-5b2b-457f-0000-0010cfc98fb2",
            "definition": "No Account,CF",
            "useContext": false
        },
        {
            "id": "0f8828d0-30f1-4d04-0000-001160e3335f",
            "definition": "QTD,YTD",
            "useContext": false
        }
    ]
}

Response

Example of a successful update: Http status code: 201 Created

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

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