Get Batch Workflow
Returns the structure of one batch workflow, including its batch-level and document-level fields.
POST Parameters
| Parameter | Required | Value | Description |
|---|---|---|---|
api_key | {key} | An API key that can access the batch resource. | |
batchworkflow_id | {integer} | The batch workflow to return. |
Sample Request
POST https://api-app.xtracta.com/v1/batch/batchworkflow HTTP/1.1 api_key=123&batchworkflow_id=456789
Sample Response
<?xml version="1.0" encoding="UTF-8"?>
<batch_response>
<status>200</status>
<message>The request has been successfully processed</message>
<BatchWorkflows>
<Id>456789</Id>
<BatchFields/>
<DocumentFields/>
</BatchWorkflows>
</batch_response>
Schema Definition
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
<xs:element name="batch_response">
<xs:complexType><xs:sequence>
<xs:element name="status" type="xs:positiveInteger"/>
<xs:element name="message" type="xs:string"/>
<xs:element name="BatchWorkflows" type="xs:anyType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence></xs:complexType>
</xs:element>
</xs:schema>
Error responses
For JSON and XML responses generated by this endpoint, the response is wrapped in batch_response and includes the HTTP status code and a message.
| Status | Message | Description |
|---|---|---|
400 | batchworkflow_id is required | Supply the batch workflow ID. |
400 | batchworkflow_id must be natural number | Use a positive integer batch workflow ID. |
404 | No records found | No accessible batch workflow matched the ID. |
500 | Internal server error occurred. Please try again later or contact support@xtracta.com | Retry and contact support with the batch workflow ID and request timestamp if it persists. |
Authentication, permission, IP-access-control, and rate-limit failures can be returned before this endpoint processes the request. Confirm the API key and caller access first.