HierarchyService.getSpecificMembers Method

Gets an array of specific hierarchy members.
 

Parameters

id

Type: String
The ID of the hierarchy to retrieve the members from or its parent entity.
getOptions

Type: Array
ElementType: Object
The options for each member to get.
     hierarchyUniqueName     [type: String]          - The unique name of the hierarchy.

     levelUniqueName         [type: String]          - The unique name of the level.

     memberUniqueName        [type: String]          - The unique name of the member, optional if specified by memberDateTime instead.

     memberDateTime          [type: Date]            - (optional) The date of the member in UTC time - see dundas.Utility.getUTCOffsetDateTime.

     includeAncestry         [type: Boolean]         - (optional) If enabled, then the parentMembers will be populated (ancestry).
                                                       By default, this option is off as it can be expensive.

     bypassHierarchyCache    [type: Boolean]         - (optional) If enabled, then the hierarchy cache is bypassed for the retrieval call.
     bypassSecurityForAdmin  [type: Boolean]         - (optional) If enabled, then if the requesting account is an admin account, security hierarchy processing is bypassed.

     tenantId                [type: String]          - (optional) If set, any tenant related data connector overrides will be used. System Administrators Only. 
 

Return Value


Type: jQuery.Promise
Value: Array
Element Value: HierarchyMember
A promise object that is resolved when the call is complete. If successful, an array of dundas.data.HierarchyMember is returned.