Create a Business Concept (v3)
Creates a Business Concept with optional search and resolution metadata.
REST Resource
POST /HyperionPlanning/rest/v3/applications/{application}/businessconcepts
Required Roles
Service Administrator
Request
Supported Media Types: application/json
The following table summarizes the client request parameters:
Table 3-70 Creating a Business Concept - Request Parameters
| Name | Description | Type | Required |
|---|---|---|---|
application |
Application name | string | Yes |
id |
Stable external Business Concept UUID. | string | No |
code |
Stable fully qualified Business Concept code. | string | No |
displayName |
Display name for the Business Concept. | string | No |
description |
Business-facing description of the concept. | string | No |
synonyms |
Comma-separated synonyms used by search and resolve. | string | No |
examplePhrases |
Example user phrases used by AI resolution. | string | No |
textLocale |
Locale hint for textual metadata. Accepts null. | string | No |
searchKeywords |
Additional curated keywords used by search and resolve. | string | No |
searchPriority |
Relative priority used to boost or break ties among matches. | integer | No |
source |
Source of the Business Concept. | string | No |
status |
Lifecycle status of the Business Concept. | string | No |
parentId |
Parent Business Concept UUID, if any. | string | No |
parentCode |
Parent Business Concept code, if any. | string | No |
Sample Request Payload:
{
"code": "CUSTOM.RECURRING_REVENUE",
"displayName": "Recurring Revenue",
"description": "Revenue expected to repeat across periods.",
"synonyms": "subscription revenue, renewal revenue",
"examplePhrases": "How can I grow ARR?",
"textLocale": "en",
"searchKeywords": "renewal expansion motion",
"searchPriority": 30,
"source": "CUSTOMER",
"status": "APPROVED"
}
Response
Supported Media Types: application/json
Sample Response:
{
"id": "33333333-3333-4333-8333-333333333333",
"code": "CUSTOM.RECURRING_REVENUE",
"displayName": "Recurring Revenue",
"source": "CUSTOMER",
"status": "APPROVED",
"description": "Revenue expected to repeat across periods.",
"synonyms": "subscription revenue, renewal revenue",
"examplePhrases": "How can I grow ARR?",
"textLocale": "en",
"searchKeywords": "renewal expansion motion",
"searchPriority": 30
}