Delete a User Variable

Deletes a specific user variable, identified by its id, from the application.

Method and URI

Method: DELETE

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

Example: https://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/uservariables/935d4dc1-5b2b-457f-0000-002bc846b761

Request

Supported Media Types: application/json

Table 8-87 Parameters

Name	Description	Type	Required	Default
application	The name of the application.	Path	Yes	None
id	The unique id of the user variable to be deleted.	Path	Yes	None

Response

Example of a successful delete: 204 No Content

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

{ 
    "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." }, 
}

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