List Reports
Returns a report list.
Required Roles
Service Administrator
REST Resource
GET
/HyperionPlanning/rest/sm/v1/applications/{application}/models/{model}/reports
Request
Parameters:
Table 3-714 Parameters
| Name | Description | Type | Required | Default |
|---|---|---|---|---|
application |
Strategic Modeling application name. | Path | Yes | None |
model |
Strategic Modeling model name. | Path | Yes | None |
offset |
The zero-based index from which records are returned. If the response omits offset, the paging helper uses 0. Default: 0; Minimum: 0 | Query | No | 0 |
limit |
The number of items to return. Must be a positive integer. Values above 200 are accepted; the effective page size is capped at 200. Default: 100; Minimum: 1 | Query | No | 100 |
Example URL:
https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/models/M1/reports
Response
Supported Media Types: application/json
Table 3-715 Parameters
| Name | Description |
|---|---|
items |
Collection of information about the returned resources. |
items[].id |
Identifier of the returned resource. |
|
Name of the returned resource. |
items[].links |
Links related to the resource or result. |
items[].links[].href |
Link to the API call. |
items[].links[].action |
HTTP call type. |
items[].links[].rel |
Relationship type for the link. |
items[].links[].data |
Additional link data, if supplied. |
count |
Count reported for the returned collection; confirm whether this is a page count or total count. |
offset |
The zero-based index from which the records are returned. |
limit |
The page size for the returned records. |
hasMore |
True or false, indicating whether more pages of records are available. |
Sample Response
{
"items": [
{
"id": "BS",
"name": "Balance Sheet",
"links": [
{
"href": "https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/models/M1/reports/BS",
"action": "GET",
"rel": "canonical",
"data": null
}
]
},
{
"id": "SVA",
"name": "Cash Flows and Shareholder Value",
"links": [
{
"href": "https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/models/M1/reports/SVA",
"action": "GET",
"rel": "canonical",
"data": null
}
]
}
],
"count": 2,
"offset": 0,
"limit": 2,
"hasMore": true
}
Table 3-716 Status Codes
| Code | Description |
|---|---|
400 |
Invalid request, malformed query JSON, invalid parameter, or service validation failure. |
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'