Read BatchStatus
Retrieves the details of a batch object that has been previously created.
Parameters
Path Params | |
---|---|
yourCompany: | string |
batch_id | string |
Query Auth | |
---|---|
key: | string |
Header Auth | |
---|---|
apiKey: | string |
Sample Response
{
"BatchStatus": {
"Id": "10",
"BatchId": "bd7cIzgnq2ehYoCSYUfp",
"Response": "{\"SuccessNumber\":2,\"FailureNumber\":0,\"SuccessAccountId\":0,\"Success\":[{\"Leads\":{\"LeadId\":394607,\"LeadName\":\"John Doe\"}},{\"Leads\":{\"LeadId\":394608,\"LeadName\":\"Test Lead\"}}],\"Failure\":[]}",
"RequestStartTime": "2021-12-13 09:51:27",
"RequestEndTime": "2021-12-13 09:51:27",
"Status": "Completed"
}
}
<BatchStatus>
<Id>10</Id>
<BatchId>bd7cIzgnq2ehYoCSYUfp</BatchId>
<Response>{"SuccessNumber":2,"FailureNumber":0,"SuccessAccountId":0,"Success":[{"Leads":{"LeadId":394607,"LeadName":"John Doe"}},{"Leads":{"LeadId":394608,"LeadName":"Test Lead"}}],"Failure":[]}</Response>
<RequestStartTime>2021-12-13 09:51:27</RequestStartTime>
<RequestEndTime>2021-12-13 09:51:27</RequestEndTime>
<Status>Completed</Status>
</BatchStatus>
{
"BatchStatus": {
"Id": "10",
"BatchId": "bd7cIzgnq2ehYoCSYUfp",
"Response": "{\"SuccessNumber\":2,\"FailureNumber\":0,\"SuccessAccountId\":0,\"Success\":[{\"Leads\":{\"LeadId\":394607,\"LeadName\":\"John Doe\",\"Record\":1}},{\"Leads\":{\"LeadId\":394608,\"LeadName\":\"Test Lead\",\"Record\":2}}],\"Failure\":[]}",
"RequestStartTime": "2021-12-13 09:51:27",
"RequestEndTime": "2021-12-13 09:51:27",
"Status": "Completed"
}
}
<BatchStatus>
<Id>10</Id>
<BatchId>bd7cIzgnq2ehYoCSYUfp</BatchId>
<Response>{"SuccessNumber":2,"FailureNumber":0,"SuccessAccountId":0,"Success":[{"Leads":{"LeadId":394607,"LeadName":"John Doe","Record":1}},{"Leads":{"LeadId":394608,"LeadName":"Test Lead","Record":2}}],"Failure":[]}</Response>
<RequestStartTime>2021-12-13 09:51:27</RequestStartTime>
<RequestEndTime>2021-12-13 09:51:27</RequestEndTime>
<Status>Completed</Status>
</BatchStatus>
WADL
<?xml version="1.0" encoding="utf-8"?>
<application>
<resources base="https://{yourCompany}.agiliron.net/agiliron/api-40/">
<resource path="BatchStatus">
<method name="GET">
<request>
<param name="key" type="xsd:string" style="query" required="true"/>
<param name="batch_id" type="xsd:string" style="query" required="true"/>
</request>
<response status="200">
<representation mediaType="application/xml" element="yn:ResultSet"/>
</response>
<response status="400">
<representation mediaType="application/xml" element="ya:Error"/>
</response>
</method>
</resource>
</resources>
</application>
Updated about 20 hours ago