Job.GetList

Description

Gets all the active jobs for the account.

Required parameters

None

Optional parameters

Job.Created (YYYY-MM-DD. Returns jobs that were created greater than or equal to the date specified)
Job.Started (YYYY-MM-DD. Returns jobs that were started greater than or equal to the date specified)
Job.Ended (YYYY-MM-DD. Returns jobs that ended less than or equal to the date specified)
Job.State (All, Active, Archived)

Returns

A response containing the Status, Command, Created Date, ScheduleItemID and ErrorMessage of all jobs for a particular account in the system.

Example request url

Example response

<?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>