Get Time Period Metadata

Returns metadata for one time period.

When fields is omitted, all supported period properties are returned. When fields is supplied but blank or contains only commas/whitespace, the response is empty. Nonblank field tokens are trimmed, case-insensitive, and de-duplicated; only supported requested properties are returned.

Required Roles

Service Administrator

REST Resource

GET /HyperionPlanning/rest/sm/v1/applications/{application}/models/{model}/periods/{period}

Request

Parameters:

Table 3-773 Parameters

Name Description Type Required Default
application Strategic Modeling application name. Path Yes None
model Strategic Modeling model name. Path Yes None
period Period label returned as id by the model's period collection. Path Yes None
fields Comma-separated list of period field names to include in the response. Supported values: id, name, periodType, year, durationDays, isHidden, isHistory, isInput, and isLeaf. For the period collection, omitting fields or supplying an empty or comma or whitespace-only value returns id and name; supported requested properties are added to those fields. For an individual period, omitting fields returns all supported properties; supplying an empty or comma or whitespace-only value returns no period properties. Tokens are trimmed, lowercased, and de-duplicated. Links are returned independently of field selection, and null properties are omitted. Query No None

Example URL:

https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/models/M1/periods/2026

Response

Supported Media Types: application/json

Table 3-774 Parameters

Name Description
id Identifier of the returned resource.
name Name of the returned resource.
periodType Type of period, such as Year.
year Calendar year associated with the period.
durationDays Number of days in the period.
isHidden Indicates whether the period is hidden.
isHistory Indicates whether the period is a historical period.
isInput Indicates whether the period accepts input values.
isLeaf Indicates whether the period has no child periods.
links Links to resources related to the period.
links[].href URL of the linked resource.
links[].action HTTP method used for the link.
links[].rel Relationship of the link to the period, such as canonical.
links[].data Additional link data, if provided; null in this example.

Sample Response

{
  "id": "2024",
  "name": "2024",
  "periodType": "Year",
  "year": 2024,
  "durationDays": 366,
  "isHidden": false,
  "isHistory": false,
  "isInput": true,
  "isLeaf": true,
  "links": [
    {
      "href": "https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/models/M1/periods/2024",
      "action": "GET",
      "rel": "canonical",
      "data": null
    }
  ]
}

Table 3-775 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/periods/2026'