Get Semantic Foundation Context

Returns live fiscal calendar, plan type, substitution-variable, and scenario time-range context.

Required Roles

Application Administrator

REST Resource

GET /HyperionPlanning/rest/v3/applications/{application}/semanticfoundation/context

Request

Table 3-667 Parameters

Name Description Type Required Default
application Name of the application. Path Yes None

Example URL

https://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/semanticfoundation/context

Response

Supported Media Types: application/json

Each context value includes its source and semantic governance state. Scenario time ranges indicate validity and do not recommend a scenario. Credential-like substitution variables are omitted; this response is not a complete variable backup.

Table 3-668 Response Parameters

Name Description
application Name of the application.
fiscalCalendar Live fiscal calendar configuration and its source metadata.
fiscalCalendar.source Authoritative source category for the value.
fiscalCalendar.semanticStatus Governance state of the semantic value.
fiscalCalendar.value Current fiscal calendar configuration.
fiscalCalendar.value.currentYear Current fiscal year member name.
fiscalCalendar.value.currentTimePeriod Current time period member name.
planTypes Plan types and their source metadata.
planTypes.source Authoritative source category for the value.
planTypes.semanticStatus Governance state of the semantic value.
planTypes.value Plan types defined in the application.
planTypes.value[].planTypeName Plan type name.
planTypes.value[].cubeName Backing cube name.
substitutionVariables Safe application and plan-type substitution variables and their source metadata.
substitutionVariables.source Authoritative source category for the value.
substitutionVariables.semanticStatus Governance state of the semantic value.
substitutionVariables.value Application and plan-type substitution variables safe for semantic processing.
substitutionVariables.value[].name Unique name of the Semantic Context Intersection within the application.
substitutionVariables.value[].value Current substitution variable value.
substitutionVariables.value[].planType Plan type scope, or ALL for an application-level variable.
scenarioTimeRanges Visible scenario year and period ranges and their source metadata.
scenarioTimeRanges.source Authoritative source category for the value.
scenarioTimeRanges.semanticStatus Governance state of the semantic value.
scenarioTimeRanges.value Scenario Time Range metadata visible to the caller.
scenarioTimeRanges.value[].scenario Scenario member name.
scenarioTimeRanges.value[].startYear First valid Year member name.
scenarioTimeRanges.value[].startPeriod First valid Period member name.
scenarioTimeRanges.value[].endYear Last valid Year member name.
scenarioTimeRanges.value[].endPeriod Last valid Period member name.

Sample Response

{
  "application": "Vision",
  "fiscalCalendar": {
    "source": "FISCAL_CALENDAR",
    "semanticStatus": "SYSTEM",
    "value": {
      "currentYear": "FY26",
      "currentTimePeriod": "Jan"
    }
  },
  "planTypes": {
    "source": "APPLICATION_METADATA",
    "semanticStatus": "SYSTEM",
    "value": [
      {
        "planTypeName": "Plan1",
        "cubeName": "Plan1"
      }
    ]
  },
  "substitutionVariables": {
    "source": "SUBSTITUTION_VARIABLE",
    "semanticStatus": "SYSTEM",
    "value": [
      {
        "name": "OEP_PlanStartYr",
        "value": "FY26",
        "planType": "ALL"
      }
    ]
  },
  "scenarioTimeRanges": {
    "source": "APPLICATION_METADATA",
    "semanticStatus": "SYSTEM",
    "value": [
      {
        "scenario": "OEP_Plan",
        "startYear": "FY25",
        "startPeriod": "Jan",
        "endYear": "FY27",
        "endPeriod": "Dec"
      }
    ]
  }
}