HierarchyController.MemberQuery Method |
Queries the specified hierarchy for the members.
Namespace:
Dundas.BI.WebApi.Controllers
Assembly:
Dundas.BI.WebApi (in Dundas.BI.WebApi.dll) Version: 2.0.0.0 (25.2.0.1000)
Syntax[HttpPostAttribute("MemberQuery/{id}")]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(410)]
[ProducesResponseTypeAttribute(440)]
public Task<ActionResult<IList<HierarchyMemberData>>> MemberQuery(
Guid id,
[FromBodyAttribute] QueryHierarchyMembersOptions options,
Guid? sessionId = null
)<HttpPostAttribute("MemberQuery/{id}")>
<ProducesResponseTypeAttribute(403)>
<ProducesResponseTypeAttribute(410)>
<ProducesResponseTypeAttribute(440)>
Public Function MemberQuery (
id As Guid,
<FromBodyAttribute> options As QueryHierarchyMembersOptions,
Optional sessionId As Guid? = Nothing
) As Task(Of ActionResult(Of IList(Of HierarchyMemberData)))public:
[HttpPostAttribute(L"MemberQuery/{id}")]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(410)]
[ProducesResponseTypeAttribute(440)]
Task<ActionResult<IList<HierarchyMemberData^>^>^>^ MemberQuery(
Guid id,
[FromBodyAttribute] QueryHierarchyMembersOptions^ options,
Nullable<Guid> sessionId = nullptr
)[<HttpPostAttribute("MemberQuery/{id}")>]
[<ProducesResponseTypeAttribute(403)>]
[<ProducesResponseTypeAttribute(410)>]
[<ProducesResponseTypeAttribute(440)>]
member MemberQuery :
id : Guid *
[<FromBodyAttribute>] options : QueryHierarchyMembersOptions *
?sessionId : Nullable<Guid>
(* Defaults:
let _sessionId = defaultArg sessionId null
*)
-> Task<ActionResult<IList<HierarchyMemberData>>>
Parameters
- id
- Type: System.Guid
The ID of the hierarchy or its parent entity. - options
- Type: Dundas.BI.WebApi.Models.QueryHierarchyMembersOptions
The options to get the members. - sessionId (Optional)
- Type: System.Nullable<Guid>
Current session ID.
Return Value
Type:
Task<ActionResult<IList<HierarchyMemberData>>>The operation completed successfully. The payload contains an array of
HierarchyMemberData objects containing the members.
See Also