get
https://api.cloud.mbanq.com/v1/runreports/jobHistory/
Use this API to check the status and execution history of a specific background job, such as a statement generation job triggered via the Generate Account Statement endpoint.
Prerequisites
- Pass the
jobIdas a path parameter. ThejobIdis returned in the response when a job is created (e.g., when generating an account statement).
Example Request
GET /v1/runreports/jobHistory/{jobId}
Job Status Values
| Status | Description |
|---|---|
COMPLETED | The job finished successfully. |
FAILED | The job encountered an error during execution. |
What's Returned
The response includes:
status— Whether the jobCOMPLETEDorFAILED.jobId— The unique identifier of the job.errorMessage— The error details if the jobFAILED(e.g., a missing required parameter).documentId— The ID of the generated document when the job completes successfully. Use this ID to download the statement PDF.generateStatement— Indicates whether the job was a statement generation job.parentEntityType— The type of entity the job was run against (e.g.,savings).