JobControllerRunJob2 Method |
Runs a job using provided options.
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("Run2/{id}")]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(404)]
[ProducesResponseTypeAttribute(409)]
[ProducesResponseTypeAttribute(440)]
[ProducesResponseTypeAttribute(500)]
public ActionResult<IDictionary<Guid, long>> RunJob2(
Guid id,
[FromBodyAttribute] RunJobsOptions options,
Guid? sessionId = null
)<HttpPostAttribute("Run2/{id}")>
<ProducesResponseTypeAttribute(403)>
<ProducesResponseTypeAttribute(404)>
<ProducesResponseTypeAttribute(409)>
<ProducesResponseTypeAttribute(440)>
<ProducesResponseTypeAttribute(500)>
Public Function RunJob2 (
id As Guid,
<FromBodyAttribute> options As RunJobsOptions,
Optional sessionId As Guid? = Nothing
) As ActionResult(Of IDictionary(Of Guid, Long))public:
[HttpPostAttribute(L"Run2/{id}")]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(404)]
[ProducesResponseTypeAttribute(409)]
[ProducesResponseTypeAttribute(440)]
[ProducesResponseTypeAttribute(500)]
ActionResult<IDictionary<Guid, long long>^>^ RunJob2(
Guid id,
[FromBodyAttribute] RunJobsOptions^ options,
Nullable<Guid> sessionId = nullptr
)[<HttpPostAttribute("Run2/{id}")>]
[<ProducesResponseTypeAttribute(403)>]
[<ProducesResponseTypeAttribute(404)>]
[<ProducesResponseTypeAttribute(409)>]
[<ProducesResponseTypeAttribute(440)>]
[<ProducesResponseTypeAttribute(500)>]
member RunJob2 :
id : Guid *
[<FromBodyAttribute>] options : RunJobsOptions *
?sessionId : Nullable<Guid>
(* Defaults:
let _sessionId = defaultArg sessionId null
*)
-> ActionResult<IDictionary<Guid, int64>>
Parameters
- id
- Type: SystemGuid
ID of the job to run. - options
- Type: Dundas.BI.WebApi.ModelsRunJobsOptions
An object that carries all needed information about the jobs that need to be run. - sessionId (Optional)
- Type: SystemNullableGuid
ID of the current session.
Return Value
Type:
ActionResultIDictionaryGuid,
Int64The operation completed successfully. The payload contains a dictionary of
Int64 job run ID by
Guid job ID.
See Also