Batch Details

get
Batch Details

https://apigateway.boost.rs/skillfinder/batch/:id
Request
Response
Request
Path Parameters
id
required
integer
ID of the batch to get details for.
Headers
Authentication
required
string
Authorisation token received from oAuth API. Bearer :token
Response
200: OK
Current batch status and information is returned.
{
"success": true,
"message": "",
"result": {
"id": 1,
"name": "Test batch",
"total_documents": 4,
"processed_documents": 1,
"pending_documents": 3
}
}
404: Not Found
The batch provided could not be found in the database.
{
"message": "Resource not found",
"success": false,
"result": null
}

Response fields

Field name

Description

id

Batch ID

name

The name given to the batch.

status

Batch status.

'active' - all documents have been processed.

'queued' - documents will start processing based on arrival.

'processing' - some documents are being processed right now.

total_documents

Total number of documents request in the batch.

processed_documents

Number of documents for which the processing is complete.

pending_documents

Number of documents which are queued.