Export a Semantic Foundation Workbook
Exports governed semantic metadata to an Excel workbook in the Planning Outbox.
Required Roles
Application administrator.
REST Resource
POST /HyperionPlanning/rest/v3/applications/{application}/semanticfoundation/workbooks/action/export
Request
Use HTTP Basic authentication. Supported Media Types: application/json.
Table 3-661 Request Parameters
| Name | Description | Type | Required | Default |
|---|---|---|---|---|
application
|
Name of the application. | Path | Yes | None |
fileName
|
Basename no longer than 255 UTF-8 bytes, ending in .xlsx, and containing only letters, digits, underscores, hyphens, periods, or spaces; directory paths are not accepted. | Payload | No | Not specified |
The request body is optional. fileName must be an .xlsx basename of at most 255 UTF-8 bytes using letters, digits, underscores, hyphens, periods, or spaces; directory paths are not accepted.
Example request body:
{
"fileName": "vision-semantic-foundation.xlsx"
}
Example URL
https://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/semanticfoundation/workbooks/action/export
Response
Supported Media Types: application/json
Table 3-662 Response Parameters
| Name | Description |
|---|---|
fileName
|
Planning Inbox or Outbox workbook basename. |
businessConceptCount
|
Number of Business Concept rows processed. |
associationCount
|
Number of logical association rows exported or valid Proposed association rows processed. |
semanticContextIntersectionCount
|
Number of Semantic Context Intersection rows processed. |
warnings
|
Non-blocking workbook compatibility warnings. |
diagnostics
|
Row-level workbook issues reported during validation or import. |
Sample Response
{
"fileName": "vision-semantic-foundation.xlsx",
"businessConceptCount": 24,
"associationCount": 58,
"semanticContextIntersectionCount": 6,
"warnings": [],
"diagnostics": []
}