Get an IPM Calendar
Use this REST API to retrieve an accessible IPM calendar by its server-assigned UUID.
These standalone calendar APIs use native persistence. Creating a calendar does not associate forms or generate Insights.
Discover calendars using GET /HyperionPlanning/rest/v3/applications/{application}/objects with q={"objectType":"IPM Calendar"}. There is no separate calendar-list endpoint. Calendar GET requires a UUID; Insights generation looks up calendars by name.
Required Roles
Native calendar read access is required. Service Administrator and IPM - Manage users follow native calendar read access, which can include calendars created by other users.
REST Resource
GET /HyperionPlanning/rest/v3/applications/{application}/ipm/calendars/{calendarUuid}
Authentication
Use HTTP Basic authentication. The specification declares basicAuth with the HTTP basic scheme.
Request
Supported Media Types: application/json
No request body or query parameters are defined for this operation.
Table 3-540 Path Parameters
| Name | Description | Type | Required | Default |
|---|---|---|---|---|
application
|
Name of the application. | Path | Yes | None |
calendarUuid
|
Server-assigned calendar UUID returned by POST or object discovery. A calendar name is not accepted by this GET. The value must have UUID format. | Path | Yes | None |
Example URL
The following example retrieves a calendar in the Vision application by UUID.
https://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/ipm/calendars/00000000-0000-0000-0000-000000000001
Response
Supported Media Types: application/json
A successful request returns HTTP status 200 OK and the effective Calendar representation.
Table 3-541 Response Headers
| Name | Value | Description |
|---|---|---|
Cache-Control
|
no-store | Responses must not be stored. |
Calendar responses use Cache-Control: no-store and do not support conditional GET.
Table 3-542 HTTP Response Codes
| HTTP Status | Description |
|---|---|
| 200 | Effective calendar definition. |
| 400 | Invalid request. |
| 401 | Authentication required, or the application is unavailable to this caller under the shared Planning status mapping. |
| 403 | Insufficient access. |
| 404 | Calendar unavailable to this caller. |
| 500 | Server processing failure. |
Table 3-543 Calendar Response Parameters
| Name | Description | Type | Required |
|---|---|---|---|
id
|
Server-assigned calendar UUID. Read-only. | String (UUID) | Yes |
revision
|
Modification timestamp; treat it as an opaque revision. Read-only. | String | No |
name
|
Native calendar name; 1 to 80 characters. | String | Yes |
description
|
Calendar description, up to 2000 characters. | String | No |
planType
|
Cube names covered by the calendar. This response property is singular planType, unlike planTypes in the create request. | Array of strings | No |
calendarMbrSel
|
Effective calendar member-selection expression. | String | No |
startMbrSel
|
Historical start coordinate. | String | No |
currentMbrSel
|
Prediction start coordinate. | String | No |
endMbrSel
|
Inclusive prediction end coordinate. | String | No |
historicalPeriods
|
Effective historical period count; minimum 1. | Integer | No |
futurePeriods
|
Effective prediction period count; minimum 1. | Integer | No |
links
|
At least one link. Both POST and GET responses include a canonical GET link to the calendar UUID item URI. | Array of Link | Yes |
The effective representation can contain both boundary selections and period counts. Do not echo the complete response as a create request: read representations retain native property names, while create requests use descriptive member-selection names.
Table 3-544 Link Parameters
| Name | Description | Type | Required |
|---|---|---|---|
href
|
Absolute resource or page URI. | String (URI) | Yes |
action
|
HTTP method for the link target. | String | Yes |
rel
|
Link relation: self, canonical, next, or prev. Calendar responses include canonical. | String | Yes |
Table 3-545 Error Response Parameters
| Name | Description | Type | Required |
|---|---|---|---|
status
|
HTTP failure status. | Integer | Yes |
detail
|
Safe localized explanation of the failure. | String | Yes |
message
|
Planning compatibility error message, when supplied. | String | No |
localizedMessage
|
Localized Planning compatibility message, when supplied. | String | No |
type
|
Problem type URI, when supplied. | String | No |
title
|
Problem title, when supplied. | String | No |
instance
|
Problem instance URI, when supplied. | String | No |
o:errorCode
|
Oracle error code, when supplied. | String | No |
o:errorPath
|
Invalid field path, when supplied. | String | No |
o:errorDetails
|
Optional Oracle error-detail objects. The Calendar endpoint represents this property as an array. | Array of ErrorDetail | No |
Error responses follow the shared Planning exception representation. Only status and detail are required by this schema. Problem-detail type/title and Oracle extension fields are optional because the shared mapper does not guarantee them. Nested o:errorDetails is an array for this Calendar endpoint.
Table 3-546 ErrorDetail Parameters
| Name | Description | Type |
|---|---|---|
type
|
Problem type URI, when supplied. | String |
title
|
Short problem title, when supplied. | String |
detail
|
Human-readable explanation of the invalid request, when supplied. | String |
o:errorCode
|
Oracle error identifier, when supplied. | String |
o:errorPath
|
Request field associated with the error, when supplied. | String |
All ErrorDetail properties are optional and appear only when supplied by the shared mapper.
Example of a Successful Response
The following example uses illustrative values that follow the Calendar schema. The canonical link identifies the UUID item URI.
HTTP/1.1 200 OK
Cache-Control: no-store
Content-Type: application/json
{
"id": "00000000-0000-0000-0000-000000000001",
"revision": "2026-10-06 10:00:00.0",
"name": "Insights_FY26",
"description": "Prediction reconciliation pilot",
"planType": [
"Plan1"
],
"calendarMbrSel": "ILvl0Descendants(Year)->ILvl0Descendants(YearTotal)",
"startMbrSel": "FY23->Jan",
"currentMbrSel": "FY26->Jan",
"endMbrSel": "FY26->Jun",
"historicalPeriods": 36,
"futurePeriods": 6,
"links": [
{
"href": "https://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/ipm/calendars/00000000-0000-0000-0000-000000000001",
"action": "GET",
"rel": "canonical"
}
]
}
Example of an Error Response
The following illustrative HTTP 400 body uses the required ErrorResponse fields and the schema example for detail.
HTTP/1.1 400 Bad Request
{
"status": 400,
"detail": "The calendar request is invalid. Check the required fields, supported field names, data types and value limits. Do not supply duplicate fields or null values."
}