Job.Cancel

Updated on 14 May 2024
1 Minute to read
Contributors

Print
Share
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback!

Description

Cancels a job in the system.

Job Status

A job must be in a Paused or Error state to cancel a job.

URL parameters

Name	Required	Type	Description
`JobID`	True	string	Unique identifier of the job.

Responses

Name	Type	Description
`Result`	string	`Success` if the operation was successful.

Example request url

curl -X GET "https://api.mozenda.com/rest?WebServiceKey=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&Service=Mozenda10&Operation=Job.Cancel&JobID=32476"

Sample responses

XML

<?xml version="1.0" encoding="utf-8" ?>
<JobCancelResponse
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<Result>Success</Result>
</JobCancelResponse>

JSON (add `&ResponseFormat=JSON`)

{
   "JsonResult":{
      "Command":"Job.Cancel",
      "AutoLoggedIn":false,
      "WebConsoleKey":"",
      "Result":"Success",
      "ErrorCode":"",
      "ErrorDescription":"",
      "ErrorList":[

      ],
      "ExecutionTime":{
         "Ticks":0,
         "Days":0,
         "Hours":0,
         "Milliseconds":0,
         "Minutes":0,
         "Seconds":0,
         "TotalDays":0,
         "TotalHours":0,
         "TotalMilliseconds":0,
         "TotalMinutes":0,
         "TotalSeconds":0
      }
   }
}

Was this article helpful?

What's Next

Job.GetAgentProgress