Get Template Properties

Returns metadata for one existing template.

When fields is omitted, all supported template properties are returned, with null properties omitted. When fields is empty or contains only commas or whitespace, only links are returned. Otherwise, only supported requested properties and links are returned; name and description are not automatically included. Field names are case-insensitive, trimmed, and de-duplicated; unrecognized names are ignored. Links include the canonical template URL and an accounts link. When query parameters are present, a self link preserves the exact query string.

Required Roles

Service Administrator

REST Resource

GET /HyperionPlanning/rest/sm/v1/applications/{application}/templates/{template}

Request

Parameters:

Table 3-761 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
fields Comma-separated list of template field names to include in the response. Supported values are: name, description, type (Model, Custom Template, Seeded Template, or Folder), version, currency, scale, inputDecimalPlaces, outputDecimalPlaces, createdOn, createdBy, modifiedOn, modifiedBy, and owner. Omit fields to return all supported properties, with null properties omitted. An empty or comma/whitespace-only value returns only links. Otherwise, only supported requested properties and links are returned; name and description are not automatically included. Names are case-insensitive, trimmed, and de-duplicated. Unrecognized names are ignored. Path No None

Example URL:

https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/templates/Health%20Care

Response

Supported Media Types: application/json

Table 3-762 Parameters

Name Description
type Type of template, such as Seeded Template.
createdBy User name of the template’s creator.
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

{
  "type": "Seeded Template",
  "createdBy": "epm_default_cloud_admin",
  "links": [
    {
      "href": "https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/templates/Health%20Care",
      "action": "GET",
      "rel": "canonical"
    },
    {
      "href": "https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/templates/Health%20Care?fields=type,createdBy",
      "action": "GET",
      "rel": "self"
    },
    {
      "href": "https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/templates/Health%20Care/accounts",
      "action": "GET",
      "rel": "accounts"
    }
  ]
}

Table 3-763 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.
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'