Get Batch Status
Retrieves the current processing status of a batch PDF job.
| Description | Returns the processing status of the job to consolidate multiple PDFs in Unified Command Platform |
|---|---|
| URL |
/pdf/{batchPdfId}/status |
| Method | GET |
| Parameter |
|
| Content Type | application/json |
Response
Copy Code
Status Code: 200 OK
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"createdTs": "2025-11-21T10:30:00Z",
"completedTs": "2025-11-21T10:32:15Z",
"waiting": 0,
"inProcess": 0,
"completed": 5,
"errors": 0,
"total": 5
}
| Field | Type | Description |
|---|---|---|
|
id |
GUID |
Batch PDF identifier |
|
createdTs |
string |
ISO 8601 timestamp when batch was created |
|
completedTs |
string |
ISO 8601 timestamp when batch completed (null if processing) |
|
waiting |
integer |
Number of items waiting to be processed |
|
inProcess |
integer |
Number of items currently being processed |
|
completed |
integer |
Number of items successfully completed |
|
errors |
integer |
Number of items that encountered errors |
|
total |
integer |
Total number of items in the batch |