Get Compact Report Data
Returns compact report metadata and account values grouped by scenario and period. All numeric account values are raw and unscaled; account, model, and report display scales are not applied.
Required Roles
Service Administrator
REST Resource
GET
/HyperionPlanning/rest/sm/v1/applications/{application}/models/{model}/reports/{report}
Request
Parameters:
Table 3-717 Parameters
| Name | Description | Type | Required | Default |
|---|---|---|---|---|
application |
Strategic Modeling application name. | Path | Yes | None |
model |
Strategic Modeling model name. | Path | Yes | None |
report |
Report name. Report identifiers are not accepted. |
Example URL:
https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/models/M1/reports/Income%20Statement
Response
Supported Media Types: application/json
Table 3-718 Parameters
| Name | Description |
|---|---|
id |
Identifier of the returned resource. |
name |
Name of the returned resource. |
shortName |
Field shown in the Swagger response example; confirm its definition. |
accounts |
Account results included in this response. |
accounts[].id |
Identifier of the returned resource. |
accounts[].name |
Name of the returned resource. |
accounts[].scenarios |
Scenario results included in this response. |
accounts[].scenarios[].scenario |
Scenario name associated with this result. |
accounts[].scenarios[].periods |
Values or metadata organized by time period. |
links |
Links related to the resource or result. |
links[].href |
Link to the API call. |
links[].action |
HTTP call type. |
links[].rel |
Relationship type for the link. |
links[].data |
Additional link data, if supplied. |
Sample Response
{
"id": "IS",
"name": "Income Statement",
"shortName": "IS",
"accounts": [
{
"id": "v1030",
"name": "Sales (Net)",
"scenarios": [
{
"scenario": "B1",
"periods": {
"2020": "NaN",
"2021": 2021.5,
"2022": 2238.80664
}
}
]
},
{
"id": "v1040",
"name": "Cost of Goods Sold",
"scenarios": [
{
"scenario": "B1",
"periods": {
"2020": "NaN",
"2021": 1529.8999999999999,
"2022": 1664.8312799999999
}
}
]
}
],
"links": [
{
"href": "https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/models/M1/reports/IS",
"action": "GET",
"rel": "canonical",
"data": null
}
]
}
Table 3-719 Status Codes
| Code | Description |
|---|---|
401 |
Authentication is required. |
403 |
The authenticated caller is not authorized. |
404 |
Application or requested sub-resource was not found. |
500 |
Unexpected server error. |
Sample cURL Command
curl -X GET -u '<USERNAME>:<PASSWORD>' 'https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/models/M1/reports/Income%20Statement'