REST API for Oracle Essbase

Get Member Info

get

/essbase/rest/v1/outline/{app}/{cube}/{memberUniqueName}

Returns either all member properties, or requested member properties.

Request

Path Parameters

app(required): string

Application name.
cube(required): string

Database name.
memberUniqueName(required): string

Unique member name (fully qualified name). Can be a member name, a member ID, or an alias. If the member name is non unique (in a duplicate member enabled outline), use a fully qualified member name or use the member ID.

Query Parameters

applicationNameForConnection: string

Application name for connection.
connection: string

Essbase connection name.
fields: string

Comma-separated list of member properties to fetch.

Response

Supported Media Types

application/json
application/xml

200 Response

Member information retrieved successfully.

Root Schema : MemberBean

Type: object

The member information output that Essbase displays is contextual. The following are examples of properties that may not be displayed when you request information for a member:

consolidation: not displayed if the member consolidation is the default of Add (+)
numberOfChildren: not displayed for leaf-level members (members with no children)
activeAliasName: not displayed unless a non-default alias table is being used in the session
attributeType: only displayed for members that are attribute dimension names
shareMembers: not displayed for dimension-name members nor attributes, as these cannot be the prototype member for a shared member.
memberHasUniqueName: not displayed unless the outline is duplicate member enabled

Show Source

account: boolean

true if this member is a member of an Accounts dimension.
activeAliasName: string

Currently active alias name of this member, if an alias table other than Default is being used in the current session.
aliases: object aliases

Additional Properties Allowed: additionalProperties
attribute: boolean

true if this member is a member of an attribute dimension.
descendantsCount: integer(int64)

Number of descendants this member has.
dimension: boolean

true if this member is a top-level dimension member (the member name = the dimension name).
dimensionName: string

Name of the dimension this member belongs to.
generationNumber: integer(int32)

The generation number of this member. Dimension names are generation 1 members, and the generation number increases by 1 with each step closer to the leaf members.
levelNumber: integer(int32)

The level number of this member. Leaf members are level 0, and the level number increases by 1 with each step closer to the dimension root member.
links: array links
memberHasUniqueName: boolean

false if this member name is a duplicate name within the outline, or true if its name is unique. Applicable only for duplicate member enabled outlines.
memberId: string

A permanent, unique identifier for a member, separate from its name. When Essbase auto generates member IDs, they follow an incremental naming pattern: id__0, id__1, id__2, etc.
memberSolveOrder: integer(int32)

A solve order, if assigned for this member. If not assigned, members inherit the solve order of their dimension. Solve order can be 0-127. Lower solve-order members are calculated before higher.
name: string

Member name.
numberOfChildren: integer(int32)

Number of children this member has.
previousSiblingsCount: integer(int32)

Number of siblings that precede this member in the outline.
type: string

Allowed Values: [ "NONE", "NUMERIC", "SMARTLIST", "DATE" ]

Applicable only if the member is a measure. Which type is designated for the measure; for example, DATE for a measure classified using a date format, SMARTLIST for a text-based measure, NUMERIC.
uniqueId: string
uniqueName: string

The unique name for this member in the outline. If the outline is duplicate-member enabled, and the member name is not unique, then this unique name will be a qualified name that differentiates it from other members with the same name. For example: [Market].[New York].[New York] is a unique name.

{
    "type":"object",
    "description":"<p>The member information output that Essbase displays is contextual. The following are examples of properties that may not be displayed when you request information for a member:<ul><li><i>consolidation</i>: not displayed if the member consolidation is the default of Add (+)</li><li><i>numberOfChildren</i>: not displayed for leaf-level members (members with no children)</li><li><i>activeAliasName</i>: not displayed unless a non-default alias table is being used in the session</li><li><i>attributeType</i>: only displayed for members that are attribute dimension names</li><li><i>shareMembers</i>: not displayed for dimension-name members nor attributes, as these cannot be the prototype member for a shared member.</li><li><i>memberHasUniqueName</i>: not displayed unless the outline is duplicate member enabled</li></ul></p>",
    "properties":{
        "name":{
            "type":"string",
            "description":"<p>Member name.</p>"
        },
        "dimensionName":{
            "type":"string",
            "description":"<p>Name of the dimension this member belongs to.</p>"
        },
        "numberOfChildren":{
            "type":"integer",
            "format":"int32",
            "description":"<p>Number of children this member has.</p>"
        },
        "levelNumber":{
            "type":"integer",
            "format":"int32",
            "description":"<p>The level number of this member. Leaf members are level 0, and the level number increases by 1 with each step closer to the dimension root member.</p>"
        },
        "generationNumber":{
            "type":"integer",
            "format":"int32",
            "description":"<p>The generation number of this member. Dimension names are generation 1 members, and the generation number increases by 1 with each step closer to the leaf members.</p>"
        },
        "aliases":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "activeAliasName":{
            "type":"string",
            "description":"<p>Currently active alias name of this member, if an alias table other than Default is being used in the current session.</p>"
        },
        "memberHasUniqueName":{
            "type":"boolean",
            "description":"<p><b>false</b> if this member name is a duplicate name within the outline, or <b>true</b> if its name is unique. Applicable only for duplicate member enabled outlines.</p>"
        },
        "uniqueName":{
            "type":"string",
            "description":"<p>The unique name for this member in the outline. If the outline is duplicate-member enabled, and the member name is not unique, then this unique name will be a qualified name that differentiates it from other members with the same name. For example: <code>[Market].[New York].[New York]</code> is a unique name.</p>"
        },
        "memberId":{
            "type":"string",
            "description":"<p>A permanent, unique identifier for a member, separate from its name. When Essbase auto generates member IDs, they follow an incremental naming pattern: id__0, id__1, id__2, etc.</p>"
        },
        "uniqueId":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "description":"<p>Applicable only if the member is a measure. Which type is designated for the measure; for example, DATE for a measure classified using a date format, SMARTLIST for a text-based measure, NUMERIC.</p>",
            "enum":[
                "NONE",
                "NUMERIC",
                "SMARTLIST",
                "DATE"
            ]
        },
        "memberSolveOrder":{
            "type":"integer",
            "format":"int32",
            "description":"<p>A solve order, if assigned for this member. If not assigned, members inherit the solve order of their dimension. Solve order can be 0-127. Lower solve-order members are calculated before higher.</p>"
        },
        "descendantsCount":{
            "type":"integer",
            "format":"int64",
            "description":"<p>Number of descendants this member has.</p>"
        },
        "previousSiblingsCount":{
            "type":"integer",
            "format":"int32",
            "description":"<p>Number of siblings that precede this member in the outline.</p>"
        },
        "dimension":{
            "type":"boolean",
            "description":"<p><b>true</b> if this member is a top-level dimension member (the member name = the dimension name).</p>"
        },
        "attribute":{
            "type":"boolean",
            "description":"<p><b>true</b> if this member is a member of an attribute dimension.</p>"
        },
        "account":{
            "type":"boolean",
            "description":"<p><b>true</b> if this member is a member of an Accounts dimension.</p>"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : aliases

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

href: string
method: string
rel: string
type: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

400 Response

Bad Request

Failed to get member information.

500 Response

Internal Server Error.

Examples

The following examples show how to get Essbase member properties for a specified member in the outline.

This example uses cURL to access the REST API from a Windows shell script. The calling user's ID and password are variables whose values are set in properties.bat.

You can specify the member in different ways.

Member Name
Alias
Shared Member
Member ID

Member information output that Essbase displays is contextual. Typically, default information is not included. The following are examples of properties that may not be displayed when you query information for a member:

consolidation: not displayed if the member consolidation operator is the default of Add (+)
numberOfChildren: not displayed for leaf-level members (members with no children)
activeAliasName: not displayed unless a non-default alias table is being used in the current session
attributeType: only displayed for members that are attribute dimension names
shareMembers: not displayed for dimension-name members nor attributes, as these cannot be the prototype member for a shared member.
memberHasUniqueName: not displayed unless the outline is duplicate member enabled

Member Name

Script with cURL Command

This example gets information about the member named Product in the Sample Basic outline.

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/outline/Sample/Basic/Product?links=none" -H Accept:application/json -H Content-Type:application/json -u %User%:%Password%

Example of Response Body

{
	"name": "Product",
	"numberOfChildren": 5,
	"levelNumber": 2,
	"aliases": {
		"Long Names": null,
		"ChineseNames": "not shown",
		"JapaneseNames": "not shown",
		"GermanNames": "Produkt",
		"RussianNames": "not shown",
		"Default": null
	},
	"uniqueName": "Product",
	"memberId": "id__68",
	"descendantsCount": 21,
	"previousSiblingsCount": 2,
	"dimension": true,
	"dimSolveOrder": 10,
	"associatedAttributes": [
		{
			"dimName": "Caffeinated",
			"attributeValueAsString": "",
			"attributeValue": false
		},
		{
			"dimName": "Ounces",
			"attributeValueAsString": "",
			"attributeValue": 0.0
		},
		{
			"dimName": "Pkg Type",
			"attributeValueAsString": "",
			"attributeValue": "Pkg Type"
		},
		{
			"dimName": "Intro Date",
			"attributeValueAsString": "",
			"attributeValue": 0
		}
	],
	"formatString": null,
	"dimStorageType": "SPARSE"
}

Alias

This example gets information about the member with an alias of Colas in the Sample Basic outline.

Script with cURL Command

call properties.bat
curl -X GET  "https://myserver.example.com:9001/essbase/rest/v1/outline/Sample/Basic/Colas?links=none" -H Accept:application/json -H Content-Type:application/json -u %User%:%Password%

Example of Response Body

{
	"name": "100",
	"dimensionName": "Product",
	"numberOfChildren": 3,
	"levelNumber": 1,
	"generationNumber": 2,
	"aliases": {
		"Long Names": null,
		"ChineseNames": "not shown",
		"JapaneseNames": "not shown",
		"GermanNames": "not shown",
		"RussianNames": "not shown",
		"Default": "Colas"
	},
	"activeAliasName": "Colas",
	"uniqueName": "100",
	"memberId": "id__69",
	"descendantsCount": 3,
	"parentName": "Product",
	"shareMembers": null
}

Shared Member

Script with cURL Command

The following example requests properties of a shared member. To distinguish it from the prototype member, we provide the fully qualified member name, [High End Merchandise].[HDTV].

Use URL encoding (percent-encoding) for the following characters so that they are interpreted correctly in the HTTP request.

Character URL encoding

[ %5B

] %5D

space %20

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/outline/ASOSamp/Basic/%5BHigh%20End%20Merchandise%5D.%5BHDTV%5D?links=none" -H Accept:application/json -H Content-Type:application/json -o output.json -u %User%:%Password%

Example of Response Body

{
	"name": "HDTV",
	"dimensionName": "Products",
	"generationNumber": 3,
	"aliases": {
		"Default": null
	},
	"uniqueName": "[High End Merchandise].[HDTV]",
	"memberId": "id__545",
	"previousSiblingsCount": 1,
	"dataStorageType": "SHAREDMEMBER",
	"parentName": "High End Merchandise",
	"shareMembers": null,
	"hierarchy": "NOTHIERARCHY"
}

Member ID

Script with cURL Command

This example gets information about the member with a member ID of id__68 in the Sample Basic outline.

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/outline/Sample/Basic/id__68?links=none" -H Accept:application/json -H Content-Type:application/json -o output.json -u %User%:%Password%

Example of Response Body

{
	"name": "Product",
	"numberOfChildren": 5,
	"levelNumber": 2,
	"aliases": {
		"Long Names": null,
		"ChineseNames": "not shown",
		"JapaneseNames": "not shown",
		"GermanNames": "Produkt",
		"RussianNames": "not shown",
		"Default": null
	},
	"uniqueName": "Product",
	"memberId": "id__68",
	"descendantsCount": 21,
	"previousSiblingsCount": 2,
	"dimension": true,
	"dimSolveOrder": 10,
	"associatedAttributes": [
		{
			"dimName": "Caffeinated",
			"attributeValueAsString": "",
			"attributeValue": false
		},
		{
			"dimName": "Ounces",
			"attributeValueAsString": "",
			"attributeValue": 0.0
		},
		{
			"dimName": "Pkg Type",
			"attributeValueAsString": "",
			"attributeValue": "Pkg Type"
		},
		{
			"dimName": "Intro Date",
			"attributeValueAsString": "",
			"attributeValue": 0
		}
	],
	"formatString": null,
	"dimStorageType": "SPARSE"
}