Get a Template Account
Returns one line-item account selected by account ID.
id and name are always returned. Add fields to project
optional account attributes. The response includes a canonical account URL and, when
query parameters are present, a self URL that preserves the exact query string.
Required Roles
Service Administrator
REST Resource
GET
/HyperionPlanning/rest/sm/v1/applications/{application}/templates/{template}
Request
Parameters:
Table 3-767 Parameters
| Name | Description | Type | Required | Default |
|---|---|---|---|---|
application |
Strategic Modeling application name. | Path | Yes | None |
template |
Name of an existing template in the application. URL-encode spaces and other reserved characters (for example, 'Health%20Care'). | Path | Yes | None |
account |
Identifier of an existing line-item account in the template. | Path | Yes | Path |
fields |
Comma-separated list of account field names to include in the response. Supported values are: 'accountType', 'dataType', 'valueStorageType', 'aggregationType', 'scale', and 'userDefinedAccount'. 'id' and 'name' are always included. Names are case-insensitive; whitespace around each name is ignored. Unrecognized field names are ignored. | Path | No | None |
Example URL:
https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/templates/Health%20Care/accounts/v1000
Response
Supported Media Types: application/json
Table 3-768 Parameters
| Name | Description |
|---|---|
id |
Identifier of the returned resource. |
name |
Name of the returned resource. |
accountType |
Classification of the template account, such as
Income.
|
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. |
Sample Response
{
"id": "v1000",
"name": "Gross Patient Revenue",
"accountType": "Income",
"links": [
{
"href": "https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/templates/Health%20Care/accounts/v1000",
"action": "GET",
"rel": "canonical"
},
{
"href": "https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/templates/Health%20Care/accounts/v1000?fields=accounttype",
"action": "GET",
"rel": "self"
}
]
}
Table 3-769 Status Codes
| Code | Description |
|---|---|
400 |
Invalid query parameter, malformed q JSON, invalid query value type, or invalid paging value. Missing or empty selected-account arrays and blank selected account IDs are reported as HTTP 422 instead. |
401 |
Authentication is required. |
403 |
The caller lacks access to the application or template. |
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/Health%20Care/accounts/v1000'