Skip to main content
GET
/
batch
Get List
curl --request GET \
  --url http://{host}:{port}/{contextPath}/batch \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "id": "aBatchId",
    "type": "aBatchType",
    "totalJobs": 10,
    "batchJobsPerSeed": 100,
    "jobsCreated": 10,
    "invocationsPerBatchJob": 1,
    "seedJobDefinitionId": "aSeedJobDefinitionId",
    "monitorJobDefinitionId": "aMonitorJobDefinitionId",
    "batchJobDefinitionId": "aBatchJobDefinitionId",
    "suspended": false,
    "tenantId": "aTenantId",
    "createUserId": "aUserId"
  }
]

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

​
sortBy
enum<string>

Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter.

Available options:
batchId,
tenantId
​
sortOrder
enum<string>

Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.

Available options:
asc,
desc
​
firstResult
integer

Pagination of results. Specifies the index of the first result to return.

​
maxResults
integer

Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

​
batchId
string

Filter by batch id.

​
type
string

Filter by batch type. See the User Guide for more information about batch types.

​
tenantIdIn
string

Filter by a comma-separated list of Strings. A batch matches if it has one of the given tenant ids.

​
withoutTenantId
boolean

Only include batches which belong to no tenant. Value can effectively only be true, as false is the default behavior.

​
suspended
boolean

A Boolean value which indicates whether only active or suspended batches should be included. When the value is set to true, only suspended batches will be returned and when the value is set to false, only active batches will be returned.

​
createdBy
string

Only include batches that were started by this user id.

​
startedBefore
string<date-time>

Only include batches that were started before the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

​
startedAfter
string<date-time>

Only include batches that were started after the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

​
withFailures
boolean

Only include batches having jobs with failures. Value can only be true.

​
withoutFailures
boolean

Only include batches having jobs without failures. Value can only be true.

Response

Request successful.

​
id
string | null

The id of the batch.

​
type
string | null

The type of the batch. See the User Guide for more information about batch types.

​
totalJobs
integer | null

The total jobs of a batch is the number of batch execution jobs required to complete the batch.

​
jobsCreated
integer | null

The number of batch execution jobs already created by the seed job.

​
batchJobsPerSeed
integer | null

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
integer | null

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 | null

The job definition id for the seed jobs of this batch.

​
monitorJobDefinitionId
string | null

The job definition id for the monitor jobs of this batch.

​
batchJobDefinitionId
string | null

The job definition id for the batch execution jobs of this batch.

​
suspended
boolean | null

Indicates whether this batch is suspended or not.

​
tenantId
string | null

The tenant id of the batch.

​
createUserId
string | null

The id of the user that created the batch.

​
startTime
string<date-time> | null

The time the batch was started. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ. For further information, please see the [documentation] (https://docs.camunda.org/manual/7.22/reference/rest/overview/date-format/)

​
executionStartTime
string<date-time> | null

The time the batch execution was started, i.e., at least one batch job has been executed. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ. For further information, please see the [documentation] (https://docs.camunda.org/manual/7.22/reference/rest/overview/date-format/)