Update form definition
Applies a partial update to a simple form definition identified by id or name. The request must supply at least one recognized field with a nonnull value. When gridDefinition is supplied, it may use the same legacy or enriched form-axis syntax as create and replace.
Required Roles
Service Administrator
REST Resource
PATCH /HyperionPlanning/rest/v3/applications/{appname}/formdefinitions/{idorname}
PATCH update behavior
Omitted or null top-level properties preserve their saved values. For metadata-only
changes, omit gridDefinition. If gridDefinition is
supplied, provide the complete intended grid layout: the operation rebuilds the layout
rather than recursively merging individual axis or segment properties.
For businessRules, smartPushes, and
customMenus, omit the property or use null to preserve the saved list.
Supply an empty array to clear that list, or supply the complete intended list to replace
it. A supplied list does not append to the existing associations.
An empty request object, or one whose recognized properties are all null, is rejected.
To clear the description, send {"description":""}.
A request containing only {"description":null} is rejected because
it supplies no change.
Request
For supported top-level properties, JSON types, conditional requirements, and operation-specific behavior, see Form-definition request properties in this topic.
Parameters:
Table 3-494 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 |
description
|
A description of the form. | payload (string) | Optional | None |
Send a required request body with Content-Type: application/json.
This example updates only the description of the existing RevenueCompactForm. The
form name is preserved because the request does not supply name.
Example request body:
{
"description": "Updated quarterly revenue form"
}
Form-definition request properties
The following reference covers the 12 writable top-level properties supported by Create (POST), Replace (PUT), and Update (PATCH) form definition.
For PATCH, supply at least one recognized property with a nonnull value. An empty object
or a request containing only null recognized properties is rejected. For example,
{"description":""} clears the description, while
{"description":null} alone is not a valid update.
The response property id is not a writable request property. For PUT and
PATCH, identify the target form using idorname in the path; a body
id does not replace that path parameter.
Table 3-495 Writable form-definition properties
| Name | JSON Type | Description and conditions | Create (POST) | Replace (PUT) | Update (PATCH) |
|---|---|---|---|---|---|
| name | string | The form name. | Required; no default. | Required; supplies the replacement name. | Optional; omission/null preserves the saved name. |
| cubeName | string | The cube associated with the form grid. | Required; no default. | Required; supplies the cube for the replacement layout. | Optional; omission/null preserves the saved value. |
| parentId | string | The wrapped UUID of an existing accessible parent form folder. A nonempty value takes precedence over parentPath. | Supply a nonempty parentId or parentPath; no default folder. | Supply a nonempty parentId or parentPath; no default folder. | Optional; omission/null preserves the saved parent unless parentPath is supplied. |
| parentPath | string | The path of an existing accessible parent form folder, such as /Library. Used when parentId is omitted or empty. | Supply a nonempty parentId or parentPath; no default folder. | Supply a nonempty parentId or parentPath; no default folder. | Optional; supplies a parent-folder lookup alternative. Omit both parent references to preserve the saved parent. |
| description | string | A description of the form. | Optional; no description if omitted. | Optional; omission clears the saved description. | Optional; omission/null preserves the saved description. An empty string clears it. |
| instructions | string | Instructions associated with the form. | Optional; no instructions if omitted. | Optional; omission clears the saved instructions. | Optional; omission/null preserves the saved instructions. |
| hidden | boolean | Whether the form is hidden. | Optional; defaults to false. | Optional; omission sets hidden to false. | Optional; omission/null preserves the saved value. Supply true or false to change it. |
| gridDefinition | object | The complete intended grid layout, including its axes and supported grid settings. | Required; no default layout. | Required; rebuilds the grid from the supplied layout. | Optional; omission/null preserves the layout. A supplied object rebuilds the grid; it is not a recursive merge. |
| businessRules | array | Business-rule and ruleset associations. RULE associations require planTypeName; RULESET associations omit it. Referenced artifacts must already exist. | Optional; no authored rule associations if omitted. | Optional; replaces the authored rule associations. Omission removes them; native form calculations are retained separately. | Optional; omission/null preserves the list. An empty array clears it; a supplied list replaces it. |
| smartPushOptions | object | Form-level Smart Push options, including runAfterSaveAsynchronously and suppressMissingRowsNative. | Optional; supplies form-level options when provided. | Optional; include the intended options when replacing Smart Push associations. | Optional; omission/null preserves saved options. Supply an object to set form-level options. |
| smartPushes | array | Smart Push associations with existing artifacts and their save/context settings. | Optional; no Smart Push associations if omitted. | Optional; replaces the Smart Push association list. Omission removes the associations. | Optional; omission/null preserves the list. An empty array clears it; a supplied list replaces it. |
| customMenus | array | Custom-menu associations using existing menu names. List order determines menu order. | Optional; no custom-menu associations if omitted. | Optional; replaces the custom-menu association list. Omission removes the associations. | Optional; omission/null preserves the list. An empty array clears it; a supplied list replaces it. |
Example URL
https://<BASE-URL>/HyperionPlanning/rest/v3/applications/HP1/formdefinitions/4f6d4cb0-7b4f-1000-8c0a-fc0f00000051
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.
PATCH https://<BASE-URL>/HyperionPlanning/rest/v3/applications/HP1/formdefinitions/Revenue%20Input
PATCH 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
Success: 200 OK. Returns an id/name/self-link reference for the updated form. Use GET to inspect the saved definition.
Supported Media Types: application/json
Table 3-496 Response Parameters
| Name | Description |
|---|---|
id
|
The form identifier wrapped as a UUID string. |
name
|
The name of the form. |
links
|
Links to this resource and related operations. |
links[].rel
|
The relationship of the linked resource to this resource. |
links[].href
|
The URL of the linked resource. |
links[].action
|
The HTTP method used to access the linked resource. |
Sample Response
This illustrative response contains an id, name, and
self-link reference for RevenueCompactForm. The UUID is illustrative. Use GET to inspect
the saved settings; the write response is not the full form definition.
{
"id": "4f6d4cb0-7b4f-1000-8c0a-fc0f00000051",
"name": "RevenueCompactForm",
"links": [
{
"rel": "self",
"href": "https://<BASE-URL>/HyperionPlanning/rest/v3/applications/HP1/formdefinitions/4f6d4cb0-7b4f-1000-8c0a-fc0f00000051",
"action": "GET"
}
]
}
Enriched axis properties
Use dimension objects in an axis dimensions array to specify display
settings. Use segment objects in a row or column segments array to specify
member selections and segment settings. Do not mix string and object dimension entries
within one axis, or matrix and object segment entries within one axis.
Dimension objects apply to POV, page, row, and column axes. Segment objects apply to row
and column axes. Segment dimensionProperties are supported only on rows.
The properties object belongs inside its segment, and the apply-to-all
objects belong directly inside their axis.
Table 3-497 Enriched dimension object: dimensions[]
| Property | JSON Type | Description |
|---|---|---|
name |
string | Required. The dimension name. |
hidden |
boolean | Hide the dimension label on the form. |
displayName |
boolean | Display member names for the dimension. |
displayAlias |
boolean | Display member aliases for the dimension. |
displayMemberFormula |
boolean | Display member formulas. |
displayMemberFormulaDescription |
boolean | Display member formula descriptions. |
drillOnSharedMembers |
boolean | Drill on shared members using base members. |
startExpanded |
boolean | Start the dimension expanded. |
dimensionWidth |
integer | Dimension display width. |
showCurrency |
boolean | Display currency for the dimension. |
showQualifiedName |
string | Qualified-name display option: never, asNeeded, or always. |
allowFlexibleDefinition |
boolean | Allow flexible definition for the dimension. |
displayConsolidationOperators |
boolean | Display consolidation operators. |
Table 3-498 Enriched segment object: segments[]
| Property | JSON Type | Description |
|---|---|---|
members |
array of arrays of strings | Required. Member selections aligned with the axis dimension order. |
exclude |
array of arrays of strings | Optional member selections to exclude, aligned with the axis dimensions. |
excludeAll |
array of arrays of strings | Optional all-member exclusion selections, aligned with the axis dimensions. |
properties |
object | Optional segment display, read-only, suppression, and sizing settings listed below. |
dimensionProperties |
array of objects | Optional per-dimension settings for row segments only. Each entry requires dimension and can specify enableDropdown. |
Table 3-499 Segment settings: segments[].properties
| Property | JSON Type | Description |
|---|---|---|
hidden |
boolean | Hide the segment. Default: false. |
readOnly |
boolean | Mark the segment read only. Default: false. |
suppressMissing |
boolean | Suppress missing values. Default: false. |
suppressInvalidScenarioTps |
boolean | Suppress invalid scenario/time-period combinations. Default: false. |
addSeparator |
boolean | Add a visual separator before the segment. Default: false. |
suppressHierarchy |
boolean | Suppress hierarchy display. Default: false. |
showFormula |
boolean | Show member formulas. Default: false. |
size |
integer | Segment size. |
Table 3-500 Row-only settings: segments[].dimensionProperties[]
| Property | JSON Type | Description |
|---|---|---|
dimension |
string | Required. The name of a dimension on the row axis. |
enableDropdown |
boolean | Enable dropdown member selection for this dimension in the row segment. Default: false. |
Table 3-501 Apply-to-all settings
| Property | JSON Type | Description |
|---|---|---|
applyDimensionProperties |
object | Axis-level settings for copying dimension display properties within the same axis. |
applyDimensionProperties.toAllDimensions |
boolean | Apply properties from the source dimension to all dimensions on this axis. Default: false; when false or omitted, properties apply where specified. |
applyDimensionProperties.sourceDimension |
integer | Zero-based index in the same axis dimensions array. Used when toAllDimensions is true. Default: 0. |
applySegmentProperties |
object | Row- or column-axis settings for copying segment properties within that axis. |
applySegmentProperties.toAllSegments |
boolean | Apply properties from the source segment to all segments on this axis. Default: false; when false or omitted, properties apply where specified. |
applySegmentProperties.sourceSegment |
integer | Zero-based index in the same axis segments array. Used when toAllSegments is true. Default: 0. |
A source index of 0 selects the first dimension or segment in that axis;
1 selects the second. Use an index that identifies an existing entry.
Apply-to-all settings do not copy properties across axes.
Member and exclusion matrices follow the axis dimension order. Page axes also support
dimension-aligned exclude and excludeAll matrices;
POV exclusions are rejected.
For GET, use includeDimensionProperties=true for dimension settings and
apply-dimension metadata, includeSegmentProperties=true for segment
settings and apply-segment metadata, or includeAllProperties=true for
both groups. Unset, unavailable, or default-valued properties may be omitted.
Enriched layout example
The sample assumes that the /Library folder, Plan1 cube, and referenced members exist and are accessible. The cube must have the dimensions shown in the layout. RevenueEnrichedForm must already exist.
These are illustrative request and response examples. The response is an excerpt showing the saved layout; other metadata and default-valued settings may be omitted.
Submit the complete intended layout for the existing form, then retrieve it with all property groups.
PATCH https://<BASE-URL>/HyperionPlanning/rest/v3/applications/HP1/formdefinitions/RevenueEnrichedForm
Content-Type: application/json
{
"gridDefinition": {
"povAxisDefinition": {
"dimensions": [
{
"name": "Version",
"displayAlias": true
},
{
"name": "Product",
"displayAlias": true
},
{
"name": "Currency",
"displayAlias": true
}
],
"members": [
"Working",
"P_TP",
"USD"
]
},
"rowAxisDefinition": {
"dimensions": [
{
"name": "Account",
"displayAlias": true,
"dimensionWidth": 20,
"showQualifiedName": "always"
},
{
"name": "Entity",
"displayAlias": true
}
],
"segments": [
{
"members": [
[
"Statistics"
],
[
"No Entity"
]
],
"properties": {
"suppressMissing": true,
"size": 6
},
"dimensionProperties": [
{
"dimension": "Account",
"enableDropdown": true
}
]
},
{
"members": [
[
"Price"
],
[
"North America"
]
],
"properties": {
"suppressMissing": true,
"size": 6
}
}
],
"applyDimensionProperties": {
"toAllDimensions": true,
"sourceDimension": 0
},
"applySegmentProperties": {
"toAllSegments": true,
"sourceSegment": 0
}
},
"columnAxisDefinition": {
"dimensions": [
{
"name": "Years",
"displayAlias": true
},
{
"name": "Period",
"displayAlias": true
}
],
"segments": [
{
"members": [
[
"FY15"
],
[
"Jan"
]
],
"properties": {
"readOnly": true,
"size": 4
}
},
{
"members": [
[
"FY16"
],
[
"Feb"
]
],
"properties": {
"readOnly": true,
"size": 4
}
}
]
},
"pageAxisDefinition": {
"dimensions": [
{
"name": "Scenario",
"displayAlias": true
}
],
"members": [
[
"Actual"
]
]
}
}
}
Retrieve the same form with enriched properties:
GET https://<BASE-URL>/HyperionPlanning/rest/v3/applications/HP1/formdefinitions/RevenueEnrichedForm?includeAllProperties=true
Illustrative matching GET response excerpt (HTTP 200):
{
"name": "RevenueEnrichedForm",
"cubeName": "Plan1",
"gridDefinition": {
"povAxisDefinition": {
"dimensions": [
{
"name": "Version",
"displayAlias": true
},
{
"name": "Product",
"displayAlias": true
},
{
"name": "Currency",
"displayAlias": true
}
],
"members": [
"Working",
"P_TP",
"USD"
]
},
"rowAxisDefinition": {
"dimensions": [
{
"name": "Account",
"displayAlias": true,
"dimensionWidth": 20,
"showQualifiedName": "always"
},
{
"name": "Entity",
"displayAlias": true,
"dimensionWidth": 20,
"showQualifiedName": "always"
}
],
"segments": [
{
"members": [
[
"Statistics"
],
[
"No Entity"
]
],
"properties": {
"suppressMissing": true,
"size": 6
},
"dimensionProperties": [
{
"dimension": "Account",
"enableDropdown": true
}
]
},
{
"members": [
[
"Price"
],
[
"North America"
]
],
"properties": {
"suppressMissing": true,
"size": 6
}
}
],
"applyDimensionProperties": {
"toAllDimensions": true,
"sourceDimension": 0
},
"applySegmentProperties": {
"toAllSegments": true,
"sourceSegment": 0
}
},
"columnAxisDefinition": {
"dimensions": [
{
"name": "Years",
"displayAlias": true
},
{
"name": "Period",
"displayAlias": true
}
],
"segments": [
{
"members": [
[
"FY15"
],
[
"Jan"
]
],
"properties": {
"readOnly": true,
"size": 4
}
},
{
"members": [
[
"FY16"
],
[
"Feb"
]
],
"properties": {
"readOnly": true,
"size": 4
}
}
]
},
"pageAxisDefinition": {
"dimensions": [
{
"name": "Scenario",
"displayAlias": true
}
],
"members": [
[
"Actual"
]
]
}
}
}
Additional PATCH examples
These illustrative examples target the existing RevenueCompactForm from Create form definition. Use the actual saved layout and accessible artifacts in your application.
PATCH https://<BASE-URL>/HyperionPlanning/rest/v3/applications/HP1/formdefinitions/RevenueCompactForm
Content-Type: application/json
Replace the grid layout and enable missing-row suppression. All four axes are supplied; the saved metadata and association lists are preserved because they are omitted.
{
"gridDefinition": {
"povAxisDefinition": {
"dimensions": [
"Version",
"Product",
"Currency"
],
"members": [
"Working",
"P_TP",
"USD"
]
},
"rowAxisDefinition": {
"dimensions": [
"Account",
"Entity"
],
"segments": [
[
[
"Statistics"
],
[
"No Entity"
]
],
[
[
"Price"
],
[
"North America"
]
]
]
},
"columnAxisDefinition": {
"dimensions": [
"Years",
"Period"
],
"segments": [
[
[
"FY15"
],
[
"Jan"
]
],
[
[
"FY16"
],
[
"Feb"
]
]
]
},
"pageAxisDefinition": {
"dimensions": [
"Scenario"
],
"members": [
[
"Actual"
]
]
},
"suppressMissingRows": true
}
}
Replace the business-rule association list with one existing Calculate Revenue rule deployed to Plan1. The rule must already exist; this request associates it with the form. It does not retain other authored rule associations omitted from the supplied list. The layout, Smart Push associations, and custom menus are preserved.
{
"businessRules": [
{
"name": "Calculate Revenue",
"type": "RULE",
"planTypeName": "Plan1",
"launchEvents": [
"afterSave"
]
}
]
}
Clear the authored business-rule association list without changing the other lists:
{"businessRules":[]}
Clear only the description:
{"description":""}
Successful PATCH operations return HTTP 200. Use GET to inspect the saved definition;
use includeAllProperties=true when inspecting enriched layout settings.
Business-rule, Smart Push, and custom-menu associations
These properties associate existing artifacts with a form. The referenced rules, rulesets, data maps or Smart Pushes, and custom menus must already exist and be accessible. These operations do not create those artifacts.
Use arrays of objects for businessRules, smartPushes,
and customMenus; use an object for smartPushOptions.
Table 3-502 Business-rule association: businessRules[]
| Property | JSON Type | Description |
|---|---|---|
name |
string | Required. Name of an existing business rule or ruleset. |
type |
string | RULE or RULESET. Specify the type explicitly in examples. |
planTypeName |
string | Required for RULE: identifies the plan type where the rule is deployed. Omit for RULESET. |
launchEvents |
array of strings | Supported values: beforeLoad, afterLoad, beforeSave, afterSave. Omit or use [] to associate without automatic launch. |
hidePrompts |
boolean | Hide runtime prompts when this artifact launches from the form. Default: false. |
useMembersOnForm |
boolean | Use form members as runtime-prompt context. Default: false. |
Table 3-503 Form-level Smart Push options: smartPushOptions
| Property | JSON Type | Description |
|---|---|---|
runAfterSaveAsynchronously |
boolean | Run form Smart Pushes asynchronously after save. Default: false. |
suppressMissingRowsNative |
boolean | Use native missing-row suppression for Smart Push execution. Default: false. |
Table 3-504 Smart Push association: smartPushes[]
| Property | JSON Type | Description |
|---|---|---|
name |
string | Required. Existing data map or Smart Push name. |
runAfterSave |
boolean | Run this Smart Push after form save. Default: false. |
dimensionOptions |
array of objects | Optional per-dimension context or selection overrides. Omit to use the Smart Push default configuration. |
Table 3-505 Smart Push dimension options: smartPushes[].dimensionOptions[]
| Property | JSON Type | Description |
|---|---|---|
dimension |
string | Required. Source dimension name. |
useFormContext |
boolean | Use the current form context for this dimension. If omitted, defaults to true when neither selection nor excludeSelection is supplied, and false when either selection property is supplied. |
selection |
string | Member-selection expression used when useFormContext is false. |
excludeSelection |
string | Member-selection expression to exclude when useFormContext is false. |
Table 3-506 Custom-menu association: customMenus[]
| Property | JSON Type | Description |
|---|---|---|
name |
string | Required. Existing custom-menu name. The order of entries in customMenus determines the menu order. |
For PATCH, omitted or null association lists preserve the saved lists; an empty array clears the selected list. A supplied list replaces the complete saved list rather than appending entries. PUT replaces authored associations and removes omitted association lists. Native form calculations are retained separately.
GET returns saved associations when applicable. Both smartPushes and
smartPushOptions are omitted if there are no Smart Push associations.
Default-valued or unset nested properties may be omitted from the response.
Create, retrieve, and update associations
This separate illustrative sequence uses RevenueAssociationsForm in Plan1. The /Library folder, cube dimensions and members, Calculate Revenue rule deployed to Plan1, Revenue Ruleset, Revenue to Reporting data map or Smart Push, and Revenue Actions menu must exist and be accessible. Statistics and Units must be valid Account members for the illustrated Smart Push selections.
Create the form with the existing artifact associations (HTTP 201 on success):
POST https://<BASE-URL>/HyperionPlanning/rest/v3/applications/HP1/formdefinitions
Content-Type: application/json
{
"name": "RevenueAssociationsForm",
"parentPath": "/Library",
"cubeName": "Plan1",
"description": "Form with existing artifact associations",
"gridDefinition": {
"povAxisDefinition": {
"dimensions": [
"Version",
"Product",
"Currency"
],
"members": [
"Working",
"P_TP",
"USD"
]
},
"rowAxisDefinition": {
"dimensions": [
"Account",
"Entity"
],
"segments": [
[
[
"Statistics"
],
[
"No Entity"
]
],
[
[
"Price"
],
[
"North America"
]
]
]
},
"columnAxisDefinition": {
"dimensions": [
"Years",
"Period"
],
"segments": [
[
[
"FY15"
],
[
"Jan"
]
],
[
[
"FY16"
],
[
"Feb"
]
]
]
},
"pageAxisDefinition": {
"dimensions": [
"Scenario"
],
"members": [
[
"Actual"
]
]
}
},
"businessRules": [
{
"name": "Calculate Revenue",
"type": "RULE",
"planTypeName": "Plan1",
"launchEvents": [
"afterSave"
],
"hidePrompts": true,
"useMembersOnForm": true
},
{
"name": "Revenue Ruleset",
"type": "RULESET",
"launchEvents": []
}
],
"smartPushOptions": {
"runAfterSaveAsynchronously": true,
"suppressMissingRowsNative": true
},
"smartPushes": [
{
"name": "Revenue to Reporting",
"runAfterSave": true,
"dimensionOptions": [
{
"dimension": "Account",
"useFormContext": false,
"selection": "ILvl0Descendants(Statistics)",
"excludeSelection": "Units"
}
]
}
],
"customMenus": [
{
"name": "Revenue Actions"
}
]
}
Retrieve that same form with its saved associations:
GET https://<BASE-URL>/HyperionPlanning/rest/v3/applications/HP1/formdefinitions/RevenueAssociationsForm
Illustrative matching GET response (HTTP 200). UUIDs are illustrative; default-valued or unset properties may be omitted.
{
"id": "4f6d4cb0-7b4f-1000-8c0a-fc0f00000052",
"parentId": "4f6d4cb0-7b4f-1000-8c0a-fc0f00000000",
"name": "RevenueAssociationsForm",
"cubeName": "Plan1",
"description": "Form with existing artifact associations",
"gridDefinition": {
"povAxisDefinition": {
"dimensions": [
"Version",
"Product",
"Currency"
],
"members": [
"Working",
"P_TP",
"USD"
]
},
"rowAxisDefinition": {
"dimensions": [
"Account",
"Entity"
],
"segments": [
[
[
"Statistics"
],
[
"No Entity"
]
],
[
[
"Price"
],
[
"North America"
]
]
]
},
"columnAxisDefinition": {
"dimensions": [
"Years",
"Period"
],
"segments": [
[
[
"FY15"
],
[
"Jan"
]
],
[
[
"FY16"
],
[
"Feb"
]
]
]
},
"pageAxisDefinition": {
"dimensions": [
"Scenario"
],
"members": [
[
"Actual"
]
]
}
},
"businessRules": [
{
"name": "Calculate Revenue",
"type": "RULE",
"planTypeName": "Plan1",
"launchEvents": [
"afterSave"
],
"hidePrompts": true,
"useMembersOnForm": true
},
{
"name": "Revenue Ruleset",
"type": "RULESET",
"launchEvents": []
}
],
"smartPushOptions": {
"runAfterSaveAsynchronously": true,
"suppressMissingRowsNative": true
},
"smartPushes": [
{
"name": "Revenue to Reporting",
"runAfterSave": true,
"dimensionOptions": [
{
"dimension": "Account",
"useFormContext": false,
"selection": "ILvl0Descendants(Statistics)",
"excludeSelection": "Units"
}
]
}
],
"customMenus": [
{
"name": "Revenue Actions"
}
]
}
Update only the associations on that same form. The Calculate Revenue launch event changes to beforeSave, and Revenue to Reporting no longer runs automatically after save. Include the existing Revenue Ruleset and Revenue Actions entries to retain them in the replaced lists. The omitted layout, metadata, and form-level Smart Push options are preserved.
PATCH https://<BASE-URL>/HyperionPlanning/rest/v3/applications/HP1/formdefinitions/RevenueAssociationsForm
Content-Type: application/json
{
"businessRules": [
{
"name": "Calculate Revenue",
"type": "RULE",
"planTypeName": "Plan1",
"launchEvents": [
"beforeSave"
],
"hidePrompts": true,
"useMembersOnForm": true
},
{
"name": "Revenue Ruleset",
"type": "RULESET",
"launchEvents": []
}
],
"smartPushes": [
{
"name": "Revenue to Reporting",
"runAfterSave": false,
"dimensionOptions": [
{
"dimension": "Account",
"useFormContext": false,
"selection": "ILvl0Descendants(Statistics)",
"excludeSelection": "Units"
}
]
}
],
"customMenus": [
{
"name": "Revenue Actions"
}
]
}
Successful PATCH returns HTTP 200. Retrieve the same form again to inspect its saved association settings. These association operations configure lifecycle behavior; they are not requests to execute the rule or Smart Push immediately.
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-507 Error cases
| HTTP outcome | Condition | Action |
|---|---|---|
| 400 Bad Request | An empty request object, a request whose recognized fields are all null, or invalid dimensions/members in a supplied replacement layout. | 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. |