POST /api/v1/ExternalBatch
This request creates an external batch within an import group.
Notes
- External batches are sets of one or more documents which are to be imported.
- The external batch is created inside an import group.
- If the indicated import group does not yet exist, it will be created.
- Optionally, names can be assigned to each batch.
- When an external batch is created, it is empty and has a status value of 10 indicating that documents can be added.
Request Endpoint
/api/v1/ExternalBatch
Sample Curl
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'Pragma: no-cache' --header 'Cache-Control: no-cache' -d 'ExternalBatchName' 'http://localhost/BrainwareAPI/api/v1/ExternalBatch'
Sample Request
POST 'BWB0000000001' 'http://localhost/BrainwareAPI/api/v1/ExternalBatch'
POST /ExternalBatch
{
"name": "ExternalBatchName",
"importGroupName": "ImportGroupName"
}
Response
| Element | Description | Type | ||
|---|---|---|---|---|
| reference | External batch reference | string | ||
Sample Response
{ "reference": "string" }
Response Codes
| Code | Description |
|---|---|
| 200 | Returns a unique reference to the created external batch. |
| 400 | Request is invalid. |
| 409 | External batch name exists. |
| 422 | External batch name and/or import group name is invalid. |