Job.Get

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

Gets the details of a job by the JobID.

URL parameters

URL parameter ordering

The URL parameters below are listed in the order they should be entered in the API URL.

Name	Required	Type	Description
`JobID`	True	numeric	Unique identifier of the job. Comma-separated list of `JobID`’s to see the details of more than one job.
`IncludeJobStatistics`	False	boolean	True to include job statistics. Default is False.

Responses

Name	Type	Description
`Result`	string	`Success` if the operation was successful.
`Job`	Job	Information about the jobs requested.

Sample request

curl -X GET "https://api.mozenda.com/rest?WebServiceKey=XXXXX&Service=Mozenda10&Operation=Job.Get&JobID=32476"

Sample responses

XML

<?xml version="1.0" encoding="utf-8" ?>
<JobGetResponse
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<Result>Success</Result>
	<Job>
		<ActiveJob>True</ActiveJob>
		<JobID>XXXXX</JobID>
		<JobType>WebPageHarvest</JobType>
		<Created>2008-11-05 17:04:36</Created>
		<Modified>2008-11-14 13:20:19</Modified>
		<Status>Running</Status>
		<Started />
		<Ended />
		<ScheduleID />
		<ScheduleItemType>WebPageHarvest</ScheduleItemType>
		<ScheduleItemID>1001</ScheduleItemID>
		<ErrorCode />
		<ErrorMessage />
		<ErrorFirst />
		<ErrorLast />
		<ErrorCount />
		<WarningFirst />
		<WarningLast />
		<WarningCount />
	</Job>
</JobGetResponse>

JSON (add `&ResponseFormat=JSON`)

{
   "Job":{
      "ActiveJob":false,
      "Created":"2020-04-23 14:40:20",
      "Modified":"2020-04-23 15:42:03",
      "JobType":"WebPageHarvest",
      "State":"Canceled",
      "Status":"Canceled",
      "Command":"",
      "Start":"",
      "Started":"2020-04-23 15:40:24",
      "Ended":"2020-04-23 15:42:03",
      "JobRestriction":"imdb.com",
      "JobID":32476,
      "ScheduleID":"0",
      "ScheduleItemType":"WebPageHarvest",
      "ScheduleItemID":1028,
      "ErrorCode":"",
      "ErrorMessage":"",
      "ErrorDetail":"",
      "ErrorFirst":"",
      "ErrorLast":"",
      "ErrorCount":"",
      "WarningFirst":"",
      "WarningLast":"",
      "WarningCount":""
   },
   "JsonResult":{
      "Command":"Job.Get",
      "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.Cancel