Create Batch
Creates an empty batch for a supported batch workflow.
POST Parameters
| Parameter | Required | Value | Description |
|---|---|---|---|
api_key | {key} | An API key that can access the batch resource. | |
batch_workflow_id | {integer} | The batch workflow that defines the new batch. |
Sample Request
POST https://api-app.xtracta.com/v1/batch/create HTTP/1.1 api_key=123&batch_workflow_id=456789
Sample Response
<?xml version="1.0" encoding="UTF-8"?> <batch_response> <status>200</status> <message>The request has been successfully processed</message> <batch_id>987654</batch_id> </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="batch_id" type="xs:positiveInteger"/>
</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 | batch_workflow_id is required | Supply the batch workflow ID. |
400 | batch_workflow_id must be natural number | Use a positive integer batch workflow ID. |
404 | Invalid batch_workflow_id provided | No accessible batch workflow matched the ID. |
500 | Could not create a batch | Batch creation did not return a new batch ID. Retry, then contact support if it persists. |
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.