Sign in
Historic Batch

Get Historic Batch Count

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

get/history/batch/count

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/history/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.

completedboolean

Filter completed or not completed batches. If the value is true, only completed batches, i.e., end time is set, are returned. Otherwise, if the value is false, only running batches, i.e., end time is null, are returned.

tenantIdInstring

Filter by a comma-separated list of tenant ids. 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.

Response

Request successful.

countinteger

The number of matching instances.

Changes

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