Description
Gets the progress of the agent.
URL parameters
| Name |
Required |
Type |
Description |
JobID |
True |
string |
Unique identifier of the job. |
Responses
| Name |
Type |
Description |
Result |
string |
Success if the operation was successful. |
AgentID |
numeric |
Unique identifier of the agent. |
JobID |
string |
Unique identifier of the job. |
List |
List |
Object containing details about the most recently attained row in the agent. |
Sample request
curl -X GET "https://api.mozenda.com/rest?WebServiceKey=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&Service=Mozenda10&Operation=Job.GetAgentProgress&JobID=32476"
Sample responses
XML
<?xml version="1.0" encoding="utf-8" ?>
<JobGetAgentProgressResponse
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<Result>Success</Result>
<AgentID>1029</AgentID>
<JobID>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</JobID>
<BeginListList>
<BeginList>
<ListName>ForumTitleList</ActiveJob>
<AgentPage>1</AgentPage>
<Type>BeginAnchorList</Type>
<RestartItemIndex>5</RestartItemIndex>
</BeginList>
</BeginListList>
</JobGetAgentProgressResponse>
JSON (add &ResponseFormat=JSON)
{
"AgentID":1028,
"JobID":32476,
"BeginList":[
{
"ListName":"Test-02, Clean (1073)",
"AgentPage":1,
"Type":"BeginDataList",
"RestartItemIndex":"15",
"ItemID":"1015",
"IMDbSeriesRating":"8.2",
"TVTitle":"15. Mozart in the Jungle (2014–2018)",
}
],
"JsonResult":{
"Command":"Job.GetAgentProgress",
"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
}
}
}