Skip to main content
GET
/
batch
/
count
Get List Count
curl --request GET \
  --url http://{host}:{port}/{contextPath}/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.

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

​
count
integer

The number of matching instances.