Sign in
Batch

Get List

Queries for batches that fulfill given parameters. Parameters may be the properties of batches, such as the id or type. The size of the result set can be retrieved by using the Get Batch Count method.

get/batch

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/batch
  • Auth: HTTP basic

Query parameters

sortBy'batchId' | 'tenantId'

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

sortOrder'asc' | 'desc'

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.

firstResultinteger

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

maxResultsinteger

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

batchIdstring

Filter by batch id.

typestring

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

tenantIdInstring

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

withoutTenantIdboolean

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

suspendedboolean

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.

createdBystring

Only include batches that were started by this user id.

startedBeforestring 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.

startedAfterstring 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.

withFailuresboolean

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

withoutFailuresboolean

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

Response

Request successful.

idstring nullable

The id of the batch.

typestring nullable

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

totalJobsinteger nullable

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

jobsCreatedinteger nullable

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

batchJobsPerSeedinteger nullable

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).

invocationsPerBatchJobinteger nullable

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.

seedJobDefinitionIdstring nullable

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

monitorJobDefinitionIdstring nullable

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

batchJobDefinitionIdstring nullable

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

suspendedboolean nullable

Indicates whether this batch is suspended or not.

tenantIdstring nullable

The tenant id of the batch.

createUserIdstring nullable

The id of the user that created the batch.

startTimestring date-time nullable

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.cibseven.org/manual/2.1/reference/rest/overview/date-format/)

executionStartTimestring date-time nullable

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.cibseven.org/manual/2.1/reference/rest/overview/date-format/)

Changes

No recorded changes to this operation across all 1 revision of this API.