Get Member

Gets the specified member’s properties.

Required Roles

Service Administrator

REST Resource

GET /HyperionPlanning/rest/{api_version}/applications/{application}/dimensions/{dimname}/members/{member}

Request

Supported Media Types: application/json

Parameters:

The following table summarizes the client request.

Table 8-47 Parameters

Name	Description	Type	Required	Default
api_version	Version of the API you are developing with	Path	Yes	None
application	The name of the application for which to get member properties	Path	Yes	None
dimname	Name of the dimension for which to get member properties	Path	Yes	None
member	Name of the member for which to get member properties	Path	Yes	None

Request Payload:

The following table summarizes the payload parameters.

Table 8-48 Parameters

Name	Description
name	Name of the member, such as North America
children	Whether the member has children
description	Description of the member
parentName	Name of the parent, such as Enterprise Global
dataType	Data type, if available
objectType	Type of object
dataStorage	Storage attribute for the member, such as STOREDATA
dimName	Dimension name
twoPass	Boolean value to indicate whether the member has the Two-Pass Calculation associated attribute

Example URL and Payload

https://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/dimensions/Entity/North America

{"memberName":"North America","parentName":"Enterprise Global"}

Example of Response Body

Sample response body where the member is added successfully

{
    "name": "North America",
    "children": null,
    "description": null,
    "parentName": "Enterprise Global",
    "dataType": "UNSPECIFIED",
    "objectType": 33,
    "dataStorage": "STOREDATA",
    "dimName": "Entity",
    "twoPass": false,
    "links": [{
        "rel": "self",
        "href": "https://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/dimensions/Entity/members/North%20America",
        "action": "GET"
    }]
}