Job.Pause
  • 25 May 2021
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Job.Pause

  • Dark
    Light
  • PDF

Article Summary

Description

Issues the Pause command for a job currently running in the system.

URL parameters

NameRequiredTypeDescription
JobIDTruestringUnique identifier of the job.

Responses

NameTypeDescription
ResultstringSuccess if the operation was successful.

Sample request

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

Sample responses

XML

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

JSON (add &ResponseFormat=JSON)

{
  "JsonResult": {
    "Command": "Job.Pause",
    "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