Skip to main content
GET
/
history
/
batch
/
count
Get Historic Batch Count
curl --request GET \
  --url http://{host}:{port}/{contextPath}/history/batch/count \
  --header 'Authorization: Basic <encoded-value>'
{
  "count": 1
}

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

batchId
string

Filter by batch id.

type
string

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

completed
boolean

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.

tenantIdIn
string

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

Response

Request successful.

count
integer

The number of matching instances.