HierarchyEntityController.GetHierarchy Method |
Gets a hierarchy.
Namespace:
Dundas.BI.WebApi.Controllers
Assembly:
Dundas.BI.WebApi (in Dundas.BI.WebApi.dll) Version: 2.0.0.0 (25.2.0.1000)
Syntax[HttpGetAttribute("{id}")]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(410)]
[ProducesResponseTypeAttribute(440)]
public ActionResult<HierarchyEntityData> GetHierarchy(
Guid id,
Guid? sessionId = null,
LevelPopulationPolicy levelPopulationPolicy = LevelPopulationPolicy.Auto
)
<HttpGetAttribute("{id}")>
<ProducesResponseTypeAttribute(403)>
<ProducesResponseTypeAttribute(410)>
<ProducesResponseTypeAttribute(440)>
Public Function GetHierarchy (
id As Guid,
Optional sessionId As Guid? = Nothing,
Optional levelPopulationPolicy As LevelPopulationPolicy = LevelPopulationPolicy.Auto
) As ActionResult(Of HierarchyEntityData)
public:
[HttpGetAttribute(L"{id}")]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(410)]
[ProducesResponseTypeAttribute(440)]
ActionResult<HierarchyEntityData^>^ GetHierarchy(
Guid id,
Nullable<Guid> sessionId = nullptr,
LevelPopulationPolicy levelPopulationPolicy = LevelPopulationPolicy::Auto
)
[<HttpGetAttribute("{id}")>]
[<ProducesResponseTypeAttribute(403)>]
[<ProducesResponseTypeAttribute(410)>]
[<ProducesResponseTypeAttribute(440)>]
member GetHierarchy :
id : Guid *
?sessionId : Nullable<Guid> *
?levelPopulationPolicy : LevelPopulationPolicy
(* Defaults:
let _sessionId = defaultArg sessionId null
let _levelPopulationPolicy = defaultArg levelPopulationPolicy LevelPopulationPolicy.Auto
*)
-> ActionResult<HierarchyEntityData>
Parameters
- id
- Type: System.Guid
The ID of the hierarchy to get. - sessionId (Optional)
- Type: System.Nullable<Guid>
Current session ID. - levelPopulationPolicy (Optional)
- Type: Dundas.BI.WebApi.Models.LevelPopulationPolicy
The level population policy to be used. This is only applicable to Ragged Hierarchies. The default value is Auto.
Return Value
Type:
ActionResult<HierarchyEntityData>The operation completed successfully. The payload contains a
HierarchyEntityData or
RaggedHierarchyEntityData object containing the hierarchy.
See Also