Get Dimension Details

Retrieves metadata for one dimension in a plan type, with response-field selection, alias lookup, and optional child-member content.

Required Roles

Service Administrator

REST Resource

GET /HyperionPlanning/rest/v3/applications/{application}/plantypes/{plantype}/dimensions/{dimname}

Request

Table 3-633 Request Parameters

Name Description Location JSON Type Required
application Planning application name. Path string Yes
plantype Plan-type name, such as Plan1. Path string Yes
dimname Dimension name, alias, or UUID. URL-encode a path value containing spaces or other reserved characters. Path string Yes
fields Comma-separated response properties, for example id,name,path. Requesting children selects that property where the lookup returns child content; it does not make name/alias and UUID lookup equivalent. Query string No
aliasTableName Alias table used when resolving or returning aliases. Query string No
filterDTSMembers When true, filters dynamic time-series period members from the returned child-member list. Query boolean No

This GET request does not require a request body. Use a dimension name, alias, or UUID in dimname. The selected alias table applies to aliases; a name or UUID is not an alias-table name.

For immediate-child retrieval and differences between name/alias and UUID lookup, see Lookup and child content.

Example URL: retrieve only the identity and path of Entity in Vision/Plan1.

https://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/plantypes/Plan1/dimensions/Entity?fields=id,name,path

Response

Supported Media Types: application/json.

The response is one dimension object. The fields query parameter selects properties. This endpoint does not return a dimension collection wrapped in items. For collections, see Get Dimensions for a Plan Type.

Table 3-634 Selected response properties

Name JSON Type Description
id string (UUID) Opaque identifier of the returned dimension.
name string Dimension name.
path string Hierarchy path of the dimension.
alias string Dimension alias, when available and included in the response.
children array of objects Child-member content when included. Name/alias lookup supports immediate-child retrieval; do not interpret the endpoint as an unrestricted recursive hierarchy export.

The following illustrative response corresponds to the example URL's id,name,path projection. It intentionally does not request child content.

{
  "id": "b657a117-26f4-4539-bb36-ce5a13e86631",
  "name": "Entity",
  "path": "/Entity"
}

Access requirements and error outcomes

Table 3-635 Operation access

Operation Required access
Get Dimension Details Service Administrator. Application access and visibility of the requested plan type, dimension, or member metadata.

Authentication, resource visibility, and permission to change metadata are separate checks. A successful read does not establish write permission. Error responses are separate from the successful metadata fields documented in this topic.

Table 3-636 Operation-specific outcomes

Case Outcome Action
Missing or invalid authentication Authentication failure Authenticate using the supported method and inspect the actual status/diagnostic response.
Missing or inaccessible application/resource Operation-specific failure Check the identifier, application, and visibility. Do not assume the same missing-resource status across all operations.
Invalid selection, filter, paging, or projection input Validation failure Correct the applicable input using the operation reference; inspect the returned status and diagnostic details.

For other failures, inspect the actual HTTP status and response body. See Error Handling and Status Codes. Do not require every error to contain the same metadata or item-detail structure.

Lookup and child content

dimname can identify a dimension by name, alias, or UUID. The addressing form can affect returned child content even when the selected dimension and fields projection are the same.

Table 3-637 Dimension addressing

Addressing form Use Child-content guidance
Dimension name The dimension's name in the selected plan type. Use this form when requesting immediate child members; include children in an explicit fields projection.
Dimension alias An alias resolving to the dimension, using the applicable alias table. Name/alias retrieval supports child content. Alias resolution is subject to the selected alias table and visibility.
Dimension UUID The dimension's opaque id. Do not assume UUID lookup includes the same children as name/alias lookup. Selecting children does not itself guarantee equivalent child content.

A syntactically valid UUID that does not identify a dimension can fail lookup. Do not rely on automatic fallback to an alias that happens to have UUID syntax.

This operation is not a guarantee of an unrestricted recursive hierarchy export. Child content remains subject to lookup behavior, projection, filtering, and access.