Batch Management
The Batch Management API offers endpoints to monitor and control batch operations in Gameball, ensuring seamless tracking and execution. It allows you to check the status and retrieve the results of a batch job, providing transparency and insight into processed requests. Additionally, it enables you to cancel an ongoing batch execution when needed, giving you greater control over bulk processing workflows.
Available APIs
GET - Check Batch Operation Status
Security: Requires apiKey and secretKey headers.
Request
Path Parameters
jobId string
Required
The unique identifier for the job, generated by the creation endpoint. which is used to cancel the operation when needed.
Response
application/json
operation string
The type of batch operation being processed (e.g., customer creation, order processing, balance adjustment).
finishedCount number
The number of successfully processed requests in the batch job.
errorCount number
The number of failed requests within the batch job.
totalCount number
The total number of requests included in the batch job.
startedAt DateTime
The timestamp indicating when the batch job started processing.
createdAt DateTime
The timestamp indicating when the batch job was created.
status string
The current status of the batch job (e.g., pending, in progress, completed, failed).
response Object
An object containing additional details or results related to the batch job execution. The object may have one or both cases; an array of succeeded results and/or array of failed results.
Sample Response
DELETE - Stop Batch Operation
The Stop Batch Operation API allows you to cancel an ongoing batch job before it completes. This ensures greater control over bulk processing workflows, enabling you to halt jobs that are no longer needed, incorrectly configured, or consuming excessive resources.
Security: Requires apiKey and secretKey headers.
Request
Path Parameters
jobId string
Required
The unique identifier for the job, generated by the creation endpoint. which is used to cancel the operation when needed.
Response
application/json
204 - No Content: Successfully stopped the batch job, confirming that the operation has been terminated.
Last updated