Delete form definition

Deletes a simple form definition identified by id or by name.

Required Roles

Service Administrator

REST Resource

DELETE /HyperionPlanning/rest/v3/applications/{appname}/formdefinitions/{idorname}

Request

Parameters:

Table 3-522 Request Parameters

Name Description Type Required Default
appname The name of the application. path Yes None
idorname Form id wrapped as a UUID string or the form name. path Yes None

Example URL

https://<BASE-URL>/HyperionPlanning/rest/v3/applications/HP1/formdefinitions/RevenueForm

Form names in URLs

Percent-encode a form name when it appears as a URL path segment. Encode spaces as %20 and reserved characters that are part of the name, such as # as %23 and ? as %3F. Encoding preserves characters in a valid form name; it does not make an invalid name valid. Do not encode the path separators or encode an already encoded name a second time.

The following alternative URLs illustrate addressing a form named Revenue Input by encoded name or by its corresponding wrapped UUID. Substitute the actual form identifier.

DELETE https://<BASE-URL>/HyperionPlanning/rest/v3/applications/HP1/formdefinitions/Revenue%20Input
DELETE https://<BASE-URL>/HyperionPlanning/rest/v3/applications/HP1/formdefinitions/4f6d4cb0-7b4f-1000-8c0a-fc0f00000053

Copy URLs and JSON directly from the code blocks. Display wrapping does not add whitespace to the underlying URL or JSON string value.

Response

204 No Content; no response body.

Error responses

For general HTTP status definitions and error-handling guidance, see Error Handling and Status Codes. The operation-specific cases below distinguish authentication, access, input, and missing-resource failures. Inspect the actual error response for diagnostic details.

Table 3-523 Error cases

HTTP outcome Condition Action
400 Bad Request Invalid request parameters. Correct the request parameters or payload before retrying.
401 Unauthorized Authentication credentials are missing or invalid. Authenticate using the supported authentication method.
404 Not Found The target form does not exist. Check the application and the form name or wrapped UUID.
500 Internal Server Error An unexpected server-side failure prevents completion. Inspect the returned diagnostic details before deciding whether to retry.