Job.GetList

Updated on 25 May 2021
2 Minutes to read
Contributors

Print
Share
Dark
Light
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

Description

Gets all the active jobs for the account.

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
`Job.Created`	False	date	`YYYY-MM-DD`. Returns jobs that were created greater than or equal to the date specified.
`Job.Started`	False	date	`YYYY-MM-DD`. Returns job that were started greater than or equal to the date specified.
`Job.Ended`	False	date	`YYYY-MM-DD`. Returns jobs that ended less than or equal to the date specified.
`Job.State`	False	string	All, Active, or Archived.

Responses

Name	Type	Description
`Result`	string	`Success` if the operation was successful.
`JobCount`	numeric	Total number of jobs returned.
`Job`	Job	Information about the jobs in the account.

Example request url

curl -X GET 'https://api.mozenda.com/rest?WebServiceKey=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&Service=Mozenda10&Operation=Job.GetList&Job.State=Active'

Example 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>
	<JobCount>10</JobCount>
	<JobList>
		<Job>
			<ActiveJob>True</ActiveJob>
			<JobID>114313</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>
		<Job>
			<ActiveJob>True</ActiveJob>
			<JobID>1024335</JobID>
			<JobType>WebPageHarvest</JobType>
			<Created>2008-11-06 16:04:36</Created>
			<Modified>2008-11-14 14:20:19</Modified>
			<Status>Running</Status>
			<Started />
			<Ended />
			<ScheduleID />
			<ScheduleItemType>WebPageHarvest</ScheduleItemType>
			<ScheduleItemID>1002</ScheduleItemID>
			<ErrorCode />
			<ErrorMessage />
			<ErrorFirst />
			<ErrorLast />
			<ErrorCount />
			<WarningFirst />
			<WarningLast />
			<WarningCount />
		</Job>
	</JobList>
</JobGetResponse>

JSON (add `&ResponseFormat=JSON`)

{
   "JobCount":3,
   "Job":[
      {
         "ActiveJob":true,
         "Created":"2020-04-23 11:49:18",
         "Modified":"2020-04-23 15:18:33",
         "JobType":"WebPageHarvest",
         "State":"Error",
         "Status":"Error",
         "Command":"",
         "Start":"2020-04-23 15:17:50",
         "Started":"2020-04-23 15:17:52",
         "Ended":"2020-04-23 15:18:33",
         "JobRestriction":"mozenda.com",
         "JobID":32442,
         "ScheduleID":"0",
         "ScheduleItemType":"WebPageHarvest",
         "ScheduleItemID":1038,
         "ErrorCode":"HttpServiceUnavailable",
         "ErrorMessage":"The website was unavailable.",
         "ErrorDetail":"The server is currently unavailable.",
         "ErrorFirst":"2020-04-23 12:36:23",
         "ErrorLast":"2020-04-23 15:18:33",
         "ErrorCount":"92",
         "WarningFirst":"",
         "WarningLast":"",
         "WarningCount":""
      },
      {
         "ActiveJob":true,
         "Created":"2020-04-23 11:49:17",
         "Modified":"2020-04-23 12:34:25",
         "JobType":"WebPageHarvest",
         "State":"Stopped",
         "Status":"Paused",
         "Command":"",
         "Start":"2020-04-23 12:32:49",
         "Started":"2020-04-23 12:32:51",
         "Ended":"2020-04-23 12:34:25",
         "JobRestriction":"mozenda.com",
         "JobID":32440,
         "ScheduleID":"0",
         "ScheduleItemType":"WebPageHarvest",
         "ScheduleItemID":1038,
         "ErrorCode":"Timeout",
         "ErrorMessage":"A web page could not be downloaded because the website was unable to provide the web page.",
         "ErrorDetail":"A timeout occurred when trying to load page \u00271\u0027. This error can also be returned  when the first action on this page cannot be found.",
         "ErrorFirst":"2020-04-23 12:25:09",
         "ErrorLast":"2020-04-23 12:31:49",
         "ErrorCount":"4",
         "WarningFirst":"",
         "WarningLast":"",
         "WarningCount":""
      },
      {
         "ActiveJob":true,
         "Created":"2020-04-23 11:49:13",
         "Modified":"2020-04-23 10:55:33",
         "JobType":"WebPageHarvest",
         "State":"Stopped",
         "Status":"Paused",
         "Command":"",
         "Start":"2020-04-23 11:56:32",
         "Started":"2020-04-23 11:54:36",
         "Ended":"2020-04-23 11:55:32",
         "JobRestriction":"mozenda.com",
         "JobID":32426,
         "ScheduleID":"0",
         "ScheduleItemType":"WebPageHarvest",
         "ScheduleItemID":1038,
         "ErrorCode":"Timeout",
         "ErrorMessage":"A web page could not be downloaded because the website was unable to provide the web page.",
         "ErrorDetail":"A timeout occurred when trying to load page \u00271\u0027. This error can also be returned  when the first action on this page cannot be found.",
         "ErrorFirst":"2020-04-23 11:51:33",
         "ErrorLast":"2020-04-23 11:55:32",
         "ErrorCount":"3",
         "WarningFirst":"",
         "WarningLast":"",
         "WarningCount":""
      }
   ],
   "JsonResult":{
      "Command":"Job.GetList",
      "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.Pause