Batch

Get List Count

Requests the number of batches that fulfill the query criteria. Takes the same filtering parameters as the Get Batches method.

get/batch/count

Request

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

Query parameters

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.

countinteger

The number of matching instances.

Changes

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