Delete User Variable Definitions

Deletes one or more user variables, identified by their ids, from the application.

Method and URI

Method: POST

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

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

Request

This request payload must include a list of comma separated user variable IDs to delete from the application.

Request payload example

{
"ids": ["935d4dc1-5b2b-457f-0000-002bc846b761", "0f8828d0-30f1-4d04-0000-002c676eba9d"]
}

Response

Example of a successful delete: 204 No Content

Example of a failed delete: Http status code: 400.

{
    "items": [
        {
            "id": "935d4dc1-5b2b-457f-0000-002bc846b761",
            "details": "Unable to find a user variable with the specified ID: 935d4dc1-5b2b-457f-0000-002bc846b761. Try again with a valid user variable ID."
        },
        {
            "id": "0f8828d0-30f1-4d04-0000-002c676eba9d",
            "details": "Unable to find a user variable with the specified ID: 0f8828d0-30f1-4d04-0000-002c676eba9d. Try again with a valid user variable ID."
        }
    ]
}

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