JobControllerEnableJob Method |
Enables or disables a job.
Namespace:
Dundas.BI.WebApi.Controllers
Assembly:
Dundas.BI.WebApi (in Dundas.BI.WebApi.dll) Version: 2.0.0.0 (25.2.0.1000)
Syntax[HttpPutAttribute("EnableJob/{id}")]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(404)]
[ProducesResponseTypeAttribute(440)]
public ActionResult<bool> EnableJob(
Guid id,
[FromBodyAttribute] bool enabled,
Guid? sessionId = null
)<HttpPutAttribute("EnableJob/{id}")>
<ProducesResponseTypeAttribute(403)>
<ProducesResponseTypeAttribute(404)>
<ProducesResponseTypeAttribute(440)>
Public Function EnableJob (
id As Guid,
<FromBodyAttribute> enabled As Boolean,
Optional sessionId As Guid? = Nothing
) As ActionResult(Of Boolean)public:
[HttpPutAttribute(L"EnableJob/{id}")]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(404)]
[ProducesResponseTypeAttribute(440)]
ActionResult<bool>^ EnableJob(
Guid id,
[FromBodyAttribute] bool enabled,
Nullable<Guid> sessionId = nullptr
)[<HttpPutAttribute("EnableJob/{id}")>]
[<ProducesResponseTypeAttribute(403)>]
[<ProducesResponseTypeAttribute(404)>]
[<ProducesResponseTypeAttribute(440)>]
member EnableJob :
id : Guid *
[<FromBodyAttribute>] enabled : bool *
?sessionId : Nullable<Guid>
(* Defaults:
let _sessionId = defaultArg sessionId null
*)
-> ActionResult<bool>
Parameters
- id
- Type: SystemGuid
The ID of the job to enable or disable. - enabled
- Type: SystemBoolean
A Boolean used to enable or disable a job. - sessionId (Optional)
- Type: SystemNullableGuid
The current session ID.
Return Value
Type:
ActionResultBooleanThe operation completed successfully. The payload contains a
Boolean indicating success (or failure if the job is running).
See Also