List Templates
Returns a paged collection of template summaries.
A template from this collection can be addressed at
/applications/{application}/templates/{template}; the sub-resource
locator checks that the template exists and returns 404 when it does
not.
Required Roles
Service Administrator
REST Resource
GET
/HyperionPlanning/rest/sm/v1/applications/{application}/templates
Request
Table 3-758 Parameters
| Name | Description | Type | Required | Default |
|---|---|---|---|---|
application |
The name of the application | 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/templates
Response
Supported Media Types: application/json
Table 3-759 Parameters
| Name | Description |
|---|---|
count |
Count reported for the returned collection. |
links |
The links related to the resource or result. |
offset |
The zero-based index from which the records are returned. |
limit |
The page size for the returned records. |
hasMore |
True or False, if there are more pages of records |
Sample Response
{
"items": [
{
"name": "Higher Ed",
"links": [
{
"href": "https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/templates/Higher%20Ed",
"action": "GET",
"rel": "canonical",
"data": null
}
]
}
],
"count": 1,
"offset": 1,
"limit": 1,
"hasMore": true,
"links": [
{
"href": "https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/templates/",
"action": "GET",
"rel": "canonical",
"data": null
},
{
"href": "https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/templates/?offset=1&limit=1",
"action": "GET",
"rel": "self",
"data": null
},
{
"href": "https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/templates/?offset=0&limit=1",
"action": "GET",
"rel": "prev",
"data": null
},
{
"href": "https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/templates/?offset=2&limit=1",
"action": "GET",
"rel": "next",
"data": null
}
]
}
Table 3-760 Status Codes
| Code | Description |
|---|---|
400 |
Invalid paging parameter or request. |
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/templates'