SessionController.GetSession Method |
Gets information about a session.
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("GetSession")]
[ProducesResponseTypeAttribute(410)]
[ProducesResponseTypeAttribute(440)]
public ActionResult<SessionData> GetSession(
[FromBodyAttribute] GetSessionOptions options,
Guid? sessionId = null
)
<HttpPostAttribute("GetSession")>
<ProducesResponseTypeAttribute(410)>
<ProducesResponseTypeAttribute(440)>
Public Function GetSession (
<FromBodyAttribute> options As GetSessionOptions,
Optional sessionId As Guid? = Nothing
) As ActionResult(Of SessionData)
public:
[HttpPostAttribute(L"GetSession")]
[ProducesResponseTypeAttribute(410)]
[ProducesResponseTypeAttribute(440)]
ActionResult<SessionData^>^ GetSession(
[FromBodyAttribute] GetSessionOptions^ options,
Nullable<Guid> sessionId = nullptr
)
[<HttpPostAttribute("GetSession")>]
[<ProducesResponseTypeAttribute(410)>]
[<ProducesResponseTypeAttribute(440)>]
member GetSession :
[<FromBodyAttribute>] options : GetSessionOptions *
?sessionId : Nullable<Guid>
(* Defaults:
let _sessionId = defaultArg sessionId null
*)
-> ActionResult<SessionData>
Parameters
- options
- Type: Dundas.BI.WebApi.Models.GetSessionOptions
The options for retrieving the session. - sessionId (Optional)
- Type: System.Nullable<Guid>
The ID of the current session.
Return Value
Type:
ActionResult<SessionData>The operation completed successfully. The payload contains a
SessionData object.
See Also