AdminControllerGetDiagnosticsStatus Method |
Gets status of the application and system diagnostics generation.
Namespace:
Dundas.BI.WebApi.Controllers
Assembly:
Dundas.BI.WebApi (in Dundas.BI.WebApi.dll) Version: 2.0.0.0 (26.1.0.1000)
Syntax[HttpGetAttribute("diagnostics/{diagnosticsId}/status")]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(405)]
[ProducesResponseTypeAttribute(410)]
[ProducesResponseTypeAttribute(440)]
public ActionResult<string> GetDiagnosticsStatus(
Guid diagnosticsId,
Guid? sessionId = null,
string? key = null
)<HttpGetAttribute("diagnostics/{diagnosticsId}/status")>
<ProducesResponseTypeAttribute(403)>
<ProducesResponseTypeAttribute(405)>
<ProducesResponseTypeAttribute(410)>
<ProducesResponseTypeAttribute(440)>
Public Function GetDiagnosticsStatus (
diagnosticsId As Guid,
Optional sessionId As Guid? = Nothing,
Optional key As String = Nothing
) As ActionResult(Of String)public:
[HttpGetAttribute(L"diagnostics/{diagnosticsId}/status")]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(405)]
[ProducesResponseTypeAttribute(410)]
[ProducesResponseTypeAttribute(440)]
ActionResult<String^>^ GetDiagnosticsStatus(
Guid diagnosticsId,
Nullable<Guid> sessionId = nullptr,
String^ key = nullptr
)[<HttpGetAttribute("diagnostics/{diagnosticsId}/status")>]
[<ProducesResponseTypeAttribute(403)>]
[<ProducesResponseTypeAttribute(405)>]
[<ProducesResponseTypeAttribute(410)>]
[<ProducesResponseTypeAttribute(440)>]
member GetDiagnosticsStatus :
diagnosticsId : Guid *
?sessionId : Nullable<Guid> *
?key : string
(* Defaults:
let _sessionId = defaultArg sessionId null
let _key = defaultArg key null
*)
-> ActionResult<string>
Parameters
- diagnosticsId
- Type: SystemGuid
The ID of the diagnostics. - sessionId (Optional)
- Type: SystemNullableGuid
The current session ID. - key (Optional)
- Type: SystemString
The local access key.
Return Value
Type:
ActionResultStringThe operation completed successfully. The payload contains a
String representing the diagnostics generation status.
Remarks
See Also