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>18</JobCount>
<JobList>
<Job>
<ActiveJob>True</ActiveJob>
<Created>2024-04-29 04:56:29</Created>
<Modified>2024-04-29 04:56:55</Modified>
<ItemSourceName>Mozenda - New test</ItemSourceName>
<JobID>20407</JobID>
<Name>April 29, 2024, 4:56 AM</Name>
<Description />
<JobType>WebPageHarvest</JobType>
<State>Error</State>
<Status>Error</Status>
<Duration>24</Duration>
<Command />
<Start />
<Started>2024-04-29 04:56:30</Started>
<Ended>2024-04-29 04:56:54</Ended>
<JobRestriction>boydjen.com</JobRestriction>
<JobKey>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</JobKey>
<ScheduleID>0</ScheduleID>
<ScheduleItemType>WebPageHarvest</ScheduleItemType>
<ScheduleItemID>11532</ScheduleItemID>
<ErrorCode>ElementNotFound</ErrorCode>
<ErrorMessage>An item could not be found on the page.</ErrorMessage>
<ErrorDetail>Action 'Begin Item List - TitleList' whose first xPath is '[[FrameAll:true]] //*[@id='gnewtonCareerHome']//tr[4]/td[1]/div/div[1]/a[1]' was not found on page '2'.</ErrorDetail>
<ErrorFirst>2024-04-29 04:56:54</ErrorFirst>
<ErrorLast>2024-04-29 04:56:54</ErrorLast>
<ErrorCount>1</ErrorCount>
<WarningFirst />
<WarningLast />
<WarningCount />
<BatchID>20407</BatchID>
<BatchOrder>1</BatchOrder>
<SequenceID />
</Job>
<Job>
<ActiveJob>True</ActiveJob>
<Created>2024-04-29 04:56:29</Created>
<Modified>2024-04-29 04:56:39</Modified>
<ItemSourceName>Support - NEW</ItemSourceName>
<JobID>20408</JobID>
<Name>April 29, 2024, 4:56 AM</Name>
<Description />
<JobType>WebPageHarvest</JobType>
<State>Running</State>
<Status>Running</Status>
<Duration />
<Command />
<Start />
<Started>2024-04-29 04:56:31</Started>
<Ended />
<JobRestriction>louisianaschools.com</JobRestriction>
<JobKey>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</JobKey>
<ScheduleID>0</ScheduleID>
<ScheduleItemType>WebPageHarvest</ScheduleItemType>
<ScheduleItemID>11380</ScheduleItemID>
<ErrorCode />
<ErrorMessage />
<ErrorDetail />
<ErrorFirst />
<ErrorLast />
<ErrorCount />
<WarningFirst />
<WarningLast />
<WarningCount />
<BatchID>20408</BatchID>
<BatchOrder>1</BatchOrder>
<SequenceID />
</Job>
</JobList>
</JobGetResponse>
JSON (add &ResponseFormat=JSON)
{
"JobCount": 18,
"Job": [
{
"ActiveJob": true,
"Created": "2024-04-29 04:56:29",
"Modified": "2024-04-29 04:56:55",
"ItemSourceName": "Mozenda - New test",
"JobID": 20407,
"Name": "April 29, 2024, 4:56 AM",
"Description": "",
"JobType": "WebPageHarvest",
"State": "Error",
"Status": "Error",
"Duration": "24",
"Command": "",
"Start": "",
"Started": "2024-04-29 04:56:30",
"Ended": "2024-04-29 04:56:54",
"JobRestriction": "boydjen.com",
"JobKey": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"ScheduleID": "0",
"ScheduleItemType": "WebPageHarvest",
"ScheduleItemID": 11532,
"ErrorCode": "ElementNotFound",
"ErrorMessage": "An item could not be found on the page.",
"ErrorDetail": "Action 'Begin Item List - TitleList' whose first xPath is '[[FrameAll:true]] //*[@id='gnewtonCareerHome']//tr[4]/td[1]/div/div[1]/a[1]' was not found on page '2'.",
"ErrorFirst": "2024-04-29 04:56:54",
"ErrorLast": "2024-04-29 04:56:54",
"ErrorCount": "1",
"WarningFirst": "",
"WarningLast": "",
"WarningCount": "",
"BatchID": "20407",
"BatchOrder": "1",
"SequenceID": null
},
{
"ActiveJob": true,
"Created": "2024-04-29 04:56:29",
"Modified": "2024-04-29 05:01:22",
"ItemSourceName": "Support - NEW",
"JobID": 20408,
"Name": "April 29, 2024, 4:56 AM",
"Description": "",
"JobType": "WebPageHarvest",
"State": "Running",
"Status": "Running",
"Duration": "",
"Command": "",
"Start": "",
"Started": "2024-04-29 04:56:31",
"Ended": "",
"JobRestriction": "louisianaschools.com",
"JobKey": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"ScheduleID": "0",
"ScheduleItemType": "WebPageHarvest",
"ScheduleItemID": 11380,
"ErrorCode": "",
"ErrorMessage": "",
"ErrorDetail": "",
"ErrorFirst": "",
"ErrorLast": "",
"ErrorCount": "",
"WarningFirst": "",
"WarningLast": "",
"WarningCount": "",
"BatchID": "20408",
"BatchOrder": "1",
"SequenceID": null
}
],
"JsonResult": {
"Command": "Job.GetList",
"AutoLoggedIn": false,
"WebConsoleKey": "",
"Result": "Success",
"ErrorCode": "",
"ErrorDescription": "",
"ErrorList": []
}
}