Update a Business Concept (v3)
Updates mutable Business Concept fields. This operation applies supplied fields and preserves omitted fields.
REST Resource
PUT
/HyperionPlanning/rest/v3/applications/{application}/businessconcepts/{conceptIdOrCode}
Required Roles
Service Administrator
Requests
Supported Media Types: application/json
Request schema: BusinessConcept
The following table summarizes the client request parameters:
Table 3-78 Update a Business Concept — Request Parameters
| Name | Description | Type | Required |
|---|---|---|---|
application |
Application name. Specified in the resource path. | string | Yes |
conceptIdOrCode |
Business Concept UUID or fully qualified code. Specified in the resource path. | string | Yes |
id |
Stable external Business Concept UUID. | string (UUID) | No |
code |
Stable fully qualified Business Concept code. | string | No |
displayName |
Display name for the Business Concept. Accepts null. | string | No |
description |
Business-facing description of the concept. Accepts null. | string | No |
synonyms |
Comma-separated synonyms used by search and resolve. Accepts null. | string | No |
examplePhrases |
Example user phrases used by AI resolution. Accepts null. | string | No |
textLocale |
Locale hint for textual metadata. Accepts null. | string | No |
searchKeywords |
Additional curated keywords used by search and resolve. Accepts null. | string | No |
searchPriority |
Relative priority used to boost or break ties among matches. | integer | No |
source |
Source of the Business Concept. Allowed values:
CUSTOMER, ORACLE,
PARTNER, AI_PROPOSED.
|
string | No |
status |
Lifecycle status of the Business Concept. Allowed values:
DRAFT, APPROVED,
PUBLISHED, DEPRECATED.
|
string | No |
parentId |
Parent Business Concept UUID, if any. Accepts null. | string (UUID) | No |
parentCode |
Parent Business Concept code, if any. Accepts null. | string | No |
Sample Request Payload:
{
"displayName": "Revenue Growth",
"searchKeywords": "expansion upsell renewal",
"searchPriority": 25,
"status": "PUBLISHED"
}
Response
Success schema: BusinessConcept
The following table lists the response parameters:
Table 3-79 Update a Business Concept — Response Parameters
| Name | Description | Type |
|---|---|---|
id |
Stable external Business Concept UUID. | string (UUID) |
code |
Stable fully qualified Business Concept code. | string |
displayName |
Display name for the Business Concept. Accepts null. | string |
description |
Business-facing description of the concept. Accepts null. | string |
synonyms |
Comma-separated synonyms used by search and resolve. Accepts null. | string |
examplePhrases |
Example user phrases used by AI resolution. Accepts null. | string |
textLocale |
Locale hint for textual metadata. Accepts null. | string |
searchKeywords |
Additional curated keywords used by search and resolve. Accepts null. | string |
searchPriority |
Relative priority used to boost or break ties among matches. | integer |
source |
Source of the Business Concept. Allowed values:
CUSTOMER, ORACLE,
PARTNER, AI_PROPOSED.
|
string |
status |
Lifecycle status of the Business Concept. Allowed values:
DRAFT, APPROVED,
PUBLISHED, DEPRECATED.
|
string |
parentId |
Parent Business Concept UUID, if any. Accepts null. | string (UUID) |
parentCode |
Parent Business Concept code, if any. Accepts null. | string |
Sample Response:
{
"id": "33333333-3333-4333-8333-333333333333",
"code": "CUSTOM.RECURRING_REVENUE",
"displayName": "Revenue Growth",
"source": "CUSTOMER",
"status": "PUBLISHED",
"searchKeywords": "expansion upsell renewal",
"searchPriority": 25
}