Jump to

• Request
• Response
• Examples

Get Member Ancestors

get

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

Returns all ancestors of the requested member.

Request

Path Parameters

• app: string

  Application name.

• cube: string

  Database name.

• memberUniqueName: string

  Unique member name (fully qualified name).

Query Parameters

• applicationNameForConnection(optional): string

  Application name for connection.

• connection(optional): string

  Essbase connection name.

• fields(optional): string

  Comma-separated list of member properties to fetch.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

List of ancestors returned successfully.

Body ()

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(optional): boolean

  true if this member is a member of an Accounts dimension.

• activeAliasName(optional): string

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

• aliases(optional): object aliases
  Additional Properties Allowed: additionalProperties
• attribute(optional): boolean

  true if this member is a member of an attribute dimension.

• descendantsCount(optional): integer(int64)

  Number of descendants this member has.

• dimension(optional): boolean

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

• dimensionName(optional): string

  Name of the dimension this member belongs to.

• generationNumber(optional): 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(optional): 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(optional): array links
• memberHasUniqueName(optional): 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(optional): 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(optional): 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(optional): string

  Member name.

• numberOfChildren(optional): integer(int32)

  Number of children this member has.

• previousSiblingsCount(optional): integer(int32)

  Number of siblings that precede this member in the outline.

• type(optional): 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(optional): string
• uniqueName(optional): 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(optional): string
• method(optional): string
• rel(optional): string
• type(optional): string

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

400 Response

Bad Request

Failed to get ancestors.

500 Response

Internal Server Error.

Back to Top

Examples

The following example shows how to get the ancestors of a specified Essbase member.

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

Script with cURL Command

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.

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

Example of Response Body

The following information is written to output.json:

[
	{
		"name": "Digital Cameras/Camcorders",
		"dimensionName": "Products",
		"numberOfChildren": 3,
		"levelNumber": 1,
		"generationNumber": 4,
		"aliases": {
			"Default": null
		},
		"uniqueName": "Digital Cameras/Camcorders",
		"memberId": "id__513",
		"descendantsCount": 3,
		"parentName": "Personal Electronics",
		"shareMembers": null,
		"hierarchy": "NOTHIERARCHY"
	},
	{
		"name": "Personal Electronics",
		"dimensionName": "Products",
		"numberOfChildren": 3,
		"levelNumber": 2,
		"generationNumber": 3,
		"aliases": {
			"Default": null
		},
		"uniqueName": "Personal Electronics",
		"memberId": "id__512",
		"descendantsCount": 11,
		"parentName": "All Merchandise",
		"shareMembers": null,
		"hierarchy": "NOTHIERARCHY"
	},
	{
		"name": "All Merchandise",
		"dimensionName": "Products",
		"numberOfChildren": 3,
		"levelNumber": 4,
		"generationNumber": 2,
		"aliases": {
			"Default": null
		},
		"uniqueName": "All Merchandise",
		"memberId": "id__511",
		"descendantsCount": 31,
		"parentName": "Products",
		"shareMembers": null
	},
	{
		"name": "Products",
		"numberOfChildren": 2,
		"levelNumber": 5,
		"aliases": {
			"Default": null
		},
		"uniqueName": "Products",
		"memberId": "id__510",
		"descendantsCount": 37,
		"previousSiblingsCount": 8,
		"dimension": true,
		"dataStorageType": "LABELONLY",
		"formatString": null,
		"hierarchy": "MULTIPLEHIERARCHYENABLED",
		"renegadeMember": ""
	}
]

Back to Top