Get Dimension Details
Use this REST API to retrieve the hierarchy of a specified dimension within a plan type, with support for selecting specific fields, choosing alias tables, and accessing both hidden and attribute dimensions.
Required Roles
Any Role
REST Resource
GET
/HyperionPlanning/rest/v3/applications/{application}/plantypes/{plantype}/dimensions/{dimname}
Request
Parameters:
Table 8-61 Parameters
| Name | Description | Type | Required | Default |
|---|---|---|---|---|
application |
The name of the application | Path | Yes | None |
plantype |
The name of the plan type | Path | Yes | None |
dimname |
The name of the dimension | Path | Yes | None |
fields |
Comma-separated list of fields to include in the response | Query | No | None |
aliasTableName |
The name of the alias table to use for retrieving alias names | Query | No | None |
Example URL
https://<BASE-URL> /HyperionPlanning/rest/v3/applications/Vision/plantypes/Plan1/dimensions/Entity?fields=id,name,alias,path,children&aliasTableName=DefaultResponse
Supported Media Types:
application/json
Table 8-62 Parameters
| Name | Description |
|---|---|
|
The unique identifier of the dimension |
|
The name of the dimension |
path |
The hierarchical path of the dimension |
alias |
The alias name of the dimension |
children |
An array of child members for the current parent, each containing
name, path,
id, and alias |
Sample Response - (using
aliasTableName=Default)
Example URL
http://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/plantypes/Plan1/dimensions?aliasTableName=Default{
"links": [
{
"href": "http://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/plantypes/Plan1/dimensions?aliasTableName=Default",
"action": "GET",
"rel": "self"
}
],
"items": [
{
"links": [
{
"href": "http://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/plantypes/Plan1/dimensions/Account",
"action": "GET",
"rel": "self"
}
],
"name": "Account",
"dimType": "Account",
"path": "/Account",
"id": "9fce272d-f3c1-4b84-a2d6-c35e483b9bcc"
},
{
"links": [
{
"href": "http://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/plantypes/Plan1/dimensions/Period",
"action": "GET",
"rel": "self"
}
],
"name": "Period",
"dimType": "Period",
"path": "/Period",
"id": "c367a200-e0ef-446d-8c86-72d3153b7e97"
},
{
"links": [
{
"href": "http://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/plantypes/Plan1/dimensions/HSP_View",
"action": "GET",
"rel": "self"
}
],
"name": "HSP_View",
"dimType": "Custom",
"path": "/HSP_View",
"id": "7db76698-3e8f-4d55-8cb5-369a783724f7"
},
{
"links": [
{
"href": "http://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/plantypes/Plan1/dimensions/Year",
"action": "GET",
"rel": "self"
}
],
"name": "Year",
"dimType": "Year",
"path": "/Year",
"id": "20df0c5d-a287-4057-8b9e-1f99add8dbb1"
},
{
"links": [
{
"href": "http://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/plantypes/Plan1/dimensions/Scenario",
"action": "GET",
"rel": "self"
}
],
"name": "Scenario",
"dimType": "Scenario",
"path": "/Scenario",
"id": "63c49e04-37fb-403b-aa4c-534ac5eea098"
},
{
"links": [
{
"href": "http://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/plantypes/Plan1/dimensions/Version",
"action": "GET",
"rel": "self"
}
],
"name": "Version",
"dimType": "Version",
"path": "/Version",
"id": "c5103409-3601-4e75-86b9-370c0a7a7a40"
},
{
"links": [
{
"href": "http://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/plantypes/Plan1/dimensions/Entity",
"action": "GET",
"rel": "self"
}
],
"name": "Entity",
"dimType": "Entity",
"path": "/Entity",
"id": "b657a117-26f4-4539-bb36-ce5a13e86631"
},
{
"links": [
{
"href": "http://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/plantypes/Plan1/dimensions/Product",
"action": "GET",
"rel": "self"
}
],
"name": "Product",
"dimType": "Custom",
"path": "/Product",
"id": "7a0125fd-a1cf-49a2-bf4e-15cebcfbee73"
},
{
"links": [
{
"href": "http://<BASE-URL>/HyperionPlanning/v3/applications/Vision/plantypes/Plan1/dimensions/Market%20Size",
"action": "GET",
"rel": "self"
}
],
"name": "Market Size",
"dimType": "Attribute Dimension",
"path": "/Market Size",
"id": "c0704a7f-cbd1-4d82-aed6-67fe5cd6f22c"
}
],
"totalResults": 9,
"hasMore": false
}Sample Response - (using selected fields (id, name,
alias, path))
Example URL
http://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/plantypes/Plan1/dimensions?fields=id,name,path{
"items": [
{
"path": "/Account",
"name": "Account",
"id": "9fce272d-f3c1-4b84-a2d6-c35e483b9bcc"
},
{
"path": "/Period",
"name": "Period",
"id": "c367a200-e0ef-446d-8c86-72d3153b7e97"
},
{
"path": "/HSP_View",
"name": "HSP_View",
"id": "7db76698-3e8f-4d55-8cb5-369a783724f7"
},
{
"path": "/Year",
"name": "Year",
"id": "20df0c5d-a287-4057-8b9e-1f99add8dbb1"
},
{
"path": "/Scenario",
"name": "Scenario",
"id": "63c49e04-37fb-403b-aa4c-534ac5eea098"
},
{
"path": "/Version",
"name": "Version",
"id": "c5103409-3601-4e75-86b9-370c0a7a7a40"
},
{
"path": "/Entity",
"name": "Entity",
"id": "b657a117-26f4-4539-bb36-ce5a13e86631"
},
{
"path": "/Product",
"name": "Product",
"id": "7a0125fd-a1cf-49a2-bf4e-15cebcfbee73"
},
{
"path": "/Market Size",
"name": "Market Size",
"id": "c0704a7f-cbd1-4d82-aed6-67fe5cd6f22c"
}
],
"totalResults": 9,
"hasMore": false
}Sample Response - (full payload)
Example URL
https://<BASE-URL>
/HyperionPlanning/rest/v3/applications/Vision/plantypes/Plan1/dimensions/entity{
"links": [
{
"href": "http://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/plantypes/Plan1/dimensions/entity",
"action": "GET",
"rel": "self"
}
],
"children": [
{
"name": "Total Entity",
"path": "/Entity/Total Entity",
"displayPath": "/Entity/Total Entity",
"parentId": "b657a117-26f4-4539-bb36-ce5a13e86631",
"id": "56777d3c-4b25-4f97-ace8-7d64f5789963",
"children": [
{
"name": "TD",
"path": "/Entity/Total Entity/TD",
"displayPath": "/Entity/Total Entity/TD",
"parentId": "56777d3c-4b25-4f97-ace8-7d64f5789963",
"id": "e1f09ef3-2905-4e09-b538-dc7d0301b0fb",
"dimName": "Entity",
"parentName": "Total Entity",
"level": 2,
"usedIn": [
"Plan1",
"Plan2",
"Plan3",
"VisASO",
"Vis1ASO"
],
"aliasPath": "/Entity/Total Entity/Total Department",
"alias": "Total Department",
"valid": true,
"invalidDueToValidIntersection": false,
"objectTypeId": 33,
"twoPass": false,
"dataType": "Unspecified",
"dataStorage": "Never Share",
"oldName": "TD",
"generation": 3,
"objectType": "Entity"
},
{
"name": "Enterprise Global",
"path": "/Entity/Total Entity/Enterprise Global",
"displayPath": "/Entity/Total Entity/Enterprise Global",
"parentId": "56777d3c-4b25-4f97-ace8-7d64f5789963",
"id": "4cc9dcee-9d49-44ab-a638-d8b09a25233f",
"dimName": "Entity",
"parentName": "Total Entity",
"level": 0,
"usedIn": [
"Plan1",
"Plan2",
"Plan3",
"VisASO",
"Vis1ASO"
],
"aliasPath": "/Entity/Total Entity/Enterprise Global",
"valid": true,
"invalidDueToValidIntersection": false,
"objectTypeId": 33,
"twoPass": false,
"dataType": "Unspecified",
"dataStorage": "Store Data",
"oldName": "Enterprise Global",
"generation": 3,
"objectType": "Entity"
}
],
"dimName": "Entity",
"parentName": "Entity",
"level": 3,
"usedIn": [
"Plan1",
"Plan2",
"Plan3",
"VisASO",
"Vis1ASO"
],
"aliasPath": "/Entity/Total Entity",
"valid": true,
"invalidDueToValidIntersection": false,
"objectTypeId": 33,
"twoPass": false,
"dataType": "Unspecified",
"dataStorage": "Never Share",
"oldName": "Total Entity",
"generation": 2,
"objectType": "Entity"
},
{
"name": "Management Rollup",
"path": "/Entity/Management Rollup",
"displayPath": "/Entity/Management Rollup",
"parentId": "b657a117-26f4-4539-bb36-ce5a13e86631",
"id": "612f695d-458e-4d97-8da1-7d22297a0751",
"children": [
{
"name": "Resources VP",
"path": "/Entity/Management Rollup/Resources VP",
"displayPath": "/Entity/Management Rollup/Resources VP",
"parentId": "612f695d-458e-4d97-8da1-7d22297a0751",
"id": "d1293874-f51b-4e06-8676-009f1d45eae5",
"dimName": "Entity",
"parentName": "Management Rollup",
"level": 1,
"usedIn": [
"Plan1",
"Plan2",
"Plan3",
"Vis1ASO"
],
"aliasPath": "/Entity/Management Rollup/Resources VP",
"valid": true,
"invalidDueToValidIntersection": false,
"objectTypeId": 33,
"twoPass": false,
"dataType": "Unspecified",
"dataStorage": "Dynamic Calc",
"oldName": "Resources VP",
"generation": 3,
"objectType": "Entity"
},
{
"name": "Sales VP",
"path": "/Entity/Management Rollup/Sales VP",
"displayPath": "/Entity/Management Rollup/Sales VP",
"parentId": "612f695d-458e-4d97-8da1-7d22297a0751",
"id": "05ae0324-fa0e-4d8d-974d-5c3314f16a25",
"dimName": "Entity",
"parentName": "Management Rollup",
"level": 2,
"usedIn": [
"Plan1",
"Plan2",
"Plan3",
"Vis1ASO"
],
"aliasPath": "/Entity/Management Rollup/Sales VP",
"valid": true,
"invalidDueToValidIntersection": false,
"objectTypeId": 33,
"twoPass": false,
"dataType": "Unspecified",
"dataStorage": "Dynamic Calc",
"oldName": "Sales VP",
"generation": 3,
"objectType": "Entity"
}
],
"dimName": "Entity",
"parentName": "Entity",
"level": 3,
"usedIn": [
"Plan1",
"Plan2",
"Plan3",
"Vis1ASO"
],
"aliasPath": "/Entity/Management Rollup",
"valid": true,
"invalidDueToValidIntersection": false,
"objectTypeId": 33,
"twoPass": false,
"dataType": "Unspecified",
"dataStorage": "Dynamic Calc",
"oldName": "Management Rollup",
"generation": 2,
"objectType": "Entity"
},
{
"name": "OAD",
"path": "/Entity/OAD",
"displayPath": "/Entity/OAD",
"parentId": "b657a117-26f4-4539-bb36-ce5a13e86631",
"id": "1ad12c5a-b1f8-495d-a212-afbf4b431258",
"dimName": "Entity",
"parentName": "Entity",
"level": 0,
"usedIn": [
"Plan1",
"Plan2",
"Plan3",
"VisASO",
"Vis1ASO"
],
"aliasPath": "/Entity/Business Operations",
"alias": "Business Operations",
"valid": true,
"invalidDueToValidIntersection": false,
"objectTypeId": 33,
"twoPass": false,
"dataType": "Unspecified",
"dataStorage": "Never Share",
"oldName": "OAD",
"generation": 2,
"objectType": "Entity"
},
{
"name": "MW",
"path": "/Entity/MW",
"displayPath": "/Entity/MW",
"parentId": "b657a117-26f4-4539-bb36-ce5a13e86631",
"id": "dc1a4815-aa31-4375-9eae-8541b968f8a5",
"dimName": "Entity",
"parentName": "Entity",
"level": 0,
"usedIn": [
"Plan1",
"Plan2",
"Plan3",
"VisASO",
"Vis1ASO"
],
"aliasPath": "/Entity/Sales Midwest Region",
"alias": "Sales Midwest Region",
"valid": true,
"invalidDueToValidIntersection": false,
"objectTypeId": 33,
"twoPass": false,
"dataType": "Unspecified",
"dataStorage": "Never Share",
"oldName": "MW",
"generation": 2,
"objectType": "Entity"
}
],
"level": 4,
"usedIn": [
"Plan1",
"Plan2",
"Plan3",
"VisASO",
"Vis1ASO"
],
"valid": true,
"invalidDueToValidIntersection": false,
"path": "/Entity",
"displayPath": "/Entity",
"aliasPath": "/Entity",
"dimName": "Entity",
"dimType": "Entity",
"density": "Sparse",
"enforceSecurity": true,
"evaluationOrder": 0,
"objectTypeId": 2,
"generation": 1,
"objectType": "Dimension",
"name": "Entity",
"id": "b657a117-26f4-4539-bb36-ce5a13e86631"
}