GET /api/v1/ExternalBatch
This request returns the list of external batches optionally filtered by an import group and / or one or more status values.
Use the limit parameter to control the number of batches returned.
Request Endpoint
/api/v1/ExternalBatch
Sample Curl
curl -X GET --header 'Accept: application/json' --header 'Pragma: no-cache' --header 'Cache-Control: no-cache' 'http://localhost/BrainwareAPI/api/v1/ExternalBatch?group=ImportGroup&status=20&limit=100'
Sample Request
GET /ExternalBatch
Query Parameters
| Parameter | Description | Type | Required |
|---|---|---|---|
| group | Import group name | string | Optional |
| status | List of external batch status values | Array[string] | Optional |
| limit | Number of external batches to return | string | Optional |
Response Parameters
| Element | Description | Type |
|---|---|---|
| batchCountUnlimited | Total number of external batches in the system for the request | integer |
| importGroups | List of import groups | Array |
| name | Import group name | string |
| extBatches | List of external batches that belong to the import group | Array |
| reference | External batch reference | string |
| name | External batch name | string |
| status | External batch status | integer |
| docCount | Number of external documents in the batch | integer |
Sample Response
{ "batchCountUnlimited": 0,
"importGroups": [
{ "name": "string",
"extBatches": [
{
"reference": "string",
"name": "string",
"status": 0,
"docCount": 0
}
]
}
]
}
Response Codes
| Code | Description |
|---|---|
| 200 | External batch list returned |
| 204 | No external batches found. |