TimeDimensionController.GetTimeHierarchy Method |
Gets a time 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("Hierarchy/{id}")]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(410)]
[ProducesResponseTypeAttribute(440)]
public ActionResult<HierarchyData> GetTimeHierarchy(
Guid id,
string uniqueName,
Guid? sessionId = null
)
<HttpGetAttribute("Hierarchy/{id}")>
<ProducesResponseTypeAttribute(403)>
<ProducesResponseTypeAttribute(410)>
<ProducesResponseTypeAttribute(440)>
Public Function GetTimeHierarchy (
id As Guid,
uniqueName As String,
Optional sessionId As Guid? = Nothing
) As ActionResult(Of HierarchyData)
public:
[HttpGetAttribute(L"Hierarchy/{id}")]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(410)]
[ProducesResponseTypeAttribute(440)]
ActionResult<HierarchyData^>^ GetTimeHierarchy(
Guid id,
String^ uniqueName,
Nullable<Guid> sessionId = nullptr
)
[<HttpGetAttribute("Hierarchy/{id}")>]
[<ProducesResponseTypeAttribute(403)>]
[<ProducesResponseTypeAttribute(410)>]
[<ProducesResponseTypeAttribute(440)>]
member GetTimeHierarchy :
id : Guid *
uniqueName : string *
?sessionId : Nullable<Guid>
(* Defaults:
let _sessionId = defaultArg sessionId null
*)
-> ActionResult<HierarchyData>
Parameters
- id
- Type: System.Guid
The ID of the time dimension. - uniqueName
- Type: System.String
The unique name of the hierarchy. - sessionId (Optional)
- Type: System.Nullable<Guid>
Current session ID.
Return Value
Type:
ActionResult<HierarchyData>The operation completed successfully. The payload contains a
HierarchyData object.
See Also