Resolve a Semantic Point of View
Proposes a semantic point of view from request text, explicit member selections, and live Planning context.
Required Roles
Application Administrator
REST Resource
POST /HyperionPlanning/rest/v3/applications/{application}/semanticfoundation/pov
Request
Use HTTP Basic authentication. Supported Media Types: application/json.
Table 3-675 Request Parameters
| Name | Description | Type | Required | Default |
|---|---|---|---|---|
application
|
Name of the application. | Path | Yes | None |
text
|
Natural-language exploration request. | Payload | Yes | Not specified |
locale
|
Locale used to interpret the request text. | Payload | No | Not specified |
planType
|
Requested plan type or cube context. | Payload | No | Not specified |
timeIntent
|
Direction for interpreting fiscal-year intent. | Payload | No | Not specified |
timeIntent.mode
|
Whether the service should derive time from text or use supplied fiscal years. | Payload | No | Not specified |
timeIntent.years
|
Ordered fiscal years that take precedence over relative time phrases. | Payload | For EXPLICIT mode | Not specified |
pov
|
Explicit dimension and member selections that override semantic defaults. | Payload | No | Not specified |
pov.Currency
|
Explicit Currency member selection. | Payload | No | Not specified |
Explicit POV selections override semantic defaults. EXPLICIT time intent requires unique valid fiscal years; AUTO must omit years. If mode is omitted, supplied years imply EXPLICIT; otherwise time is derived from the text.
An optional formName supplies readable form context for validating correlated time tuples. This operation proposes selections and does not retrieve Planning data.
Example request body:
{
"text": "Show FY24 total expense",
"locale": "en",
"planType": "Plan1",
"timeIntent": {
"mode": "EXPLICIT",
"years": [
"FY24"
]
},
"pov": {
"Currency": "USD"
}
}
Example URL
https://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/semanticfoundation/pov
Response
Supported Media Types: application/json
Resolve unresolvedDimensions before querying data. When returned, timeTuples contain correlated selections that must remain together; do not expand them into a Cartesian product. Context intersection candidates are evidence and are not applied automatically.
Table 3-676 Response Parameters
| Name | Description |
|---|---|
status
|
Whether the proposal is complete enough to bind to a Planning grid. |
formContextStatus
|
Reports how optional form context affected resolution. |
selections
|
Proposed member selections keyed by Planning dimension name. |
selections.Years
|
Proposed Year selection and its source evidence. |
selections.Years.member
|
Semantic member value proposed for the dimension. |
selections.Years.source
|
Authority that supplied the selection. |
selections.Years.evidence
|
Safe explanation for the selection. |
selections.Currency
|
Proposed Currency selection and its source evidence. |
selections.Currency.member
|
Semantic member value proposed for the dimension. |
selections.Currency.source
|
Authority that supplied the selection. |
selections.Currency.evidence
|
Safe explanation for the selection. |
reasons
|
Explainable policy and precedence decisions. |
unresolvedDimensions
|
Dimensions or intent that need caller clarification. |
caveats
|
Validation requirements before querying Planning data. |
Sample Response
{
"status": "NEEDS_CLARIFICATION",
"formContextStatus": "NOT_REQUESTED",
"selections": {
"Years": {
"member": "FY24",
"source": "USER_EXPLICIT",
"evidence": "Show FY24 total expense"
},
"Currency": {
"member": "USD",
"source": "USER_EXPLICIT",
"evidence": "Explicit POV selection."
}
},
"reasons": [
"Explicit selections take precedence over semantic defaults."
],
"unresolvedDimensions": [
"Scenario",
"Version"
],
"caveats": [
"Semantic values must be bound to valid members for the selected form or cube."
]
}