HierarchyController.GetMembers Method |
Gets the hierarchy level 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("Members/{id}")]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(410)]
[ProducesResponseTypeAttribute(440)]
public Task<ActionResult<IList<HierarchyMemberData>>> GetMembers(
Guid id,
[FromBodyAttribute] GetHierarchyMembersOptions options,
Guid? sessionId = null
)
<HttpPostAttribute("Members/{id}")>
<ProducesResponseTypeAttribute(403)>
<ProducesResponseTypeAttribute(410)>
<ProducesResponseTypeAttribute(440)>
Public Function GetMembers (
id As Guid,
<FromBodyAttribute> options As GetHierarchyMembersOptions,
Optional sessionId As Guid? = Nothing
) As Task(Of ActionResult(Of IList(Of HierarchyMemberData)))
public:
[HttpPostAttribute(L"Members/{id}")]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(410)]
[ProducesResponseTypeAttribute(440)]
Task<ActionResult<IList<HierarchyMemberData^>^>^>^ GetMembers(
Guid id,
[FromBodyAttribute] GetHierarchyMembersOptions^ options,
Nullable<Guid> sessionId = nullptr
)
[<HttpPostAttribute("Members/{id}")>]
[<ProducesResponseTypeAttribute(403)>]
[<ProducesResponseTypeAttribute(410)>]
[<ProducesResponseTypeAttribute(440)>]
member GetMembers :
id : Guid *
[<FromBodyAttribute>] options : GetHierarchyMembersOptions *
?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.GetHierarchyMembersOptions
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