Set Job Retries Async (POST)
Create a batch to set retries of jobs associated with given processes asynchronously.
Method
POST /process-instance/job-retries
Parameters
Request Body
A JSON object with the following properties:
Name | Description |
---|---|
processInstances | A list of process instance ids to fetch jobs, for which retries will be set. |
processInstanceQuery |
A process instance query like the request body for the
Get Instances (POST)
method.
|
retries | An integer representing the number of retries. Please note that the value cannot be negative or null. |
Please note that if both processInstances and processInstanceQuery are provided, then the resulting execution will be performed on the union of these sets.
Response Body
A JSON object corresponding to the Batch interface in the engine. Its properties are as follows:
Name | Value | Description |
---|---|---|
id | String | The id of the batch. |
type | String | The type of the batch. See the User Guide for more information about batch types. |
totalJobs | Number | The total jobs of a batch is the number of batch execution jobs required to complete the batch. |
jobsCreated | Number | The number of batch execution jobs already created by the seed job. |
batchJobsPerSeed | Number |
The number of batch execution jobs created per seed job invocation.
The batch seed job is invoked until it has created all batch execution jobs required by
the batch (see totalJobs property).
|
invocationsPerBatchJob | Number |
Every batch execution job invokes the command executed by the batch
invocationsPerBatchJob times. E.g., for a process instance
migration batch this specifies the number of process instances which
are migrated per batch execution job.
|
seedJobDefinitionId | String | The job definition id for the seed jobs of this batch. |
batchJobDefinitionId | String | The job definition id for the batch execution jobs of this batch. |
suspended | Boolean | Indicates wheter this batch is suspended or not. |
tenantId | String | The tenant id of the batch. |
Response Codes
Code | Media type | Description |
---|---|---|
200 | application/json | Request successful. |
400 | application/json | Returned if some of the query parameters are invalid, for example if neither processInstanceIds, nor processInstanceQuery is present. Or if the retry count is not specified. See the Introduction for the error response format. |
Example
Request
POST /process-instance/job-retries
Request Body:
{
"retries" : numberOfRetries,
"processInstances": ["aProcess","secondProcess"],
"processInstanceQuery": {
"processDefinitionId": "aProcessDefinitionId"
}
}
Response
Status 200 OK
{
"id": "aBatchId",
"type": "aBatchType",
"totalJobs": 10,
"batchJobsPerSeed": 100,
"jobsCreated": 10,
"invocationsPerBatchJob": 1,
"seedJobDefinitionId": "aSeedJobDefinitionId",
"monitorJobDefinitionId": "aMonitorJobDefinitionId",
"batchJobDefinitionId": "aBatchJobDefinitionId",
"suspened": false,
"tenantId": "aTenantId"
}