Get Batches Count

Request the number of batches that fulfill the query criteria. Takes the same filtering parameters as the GET query.

Method

GET /batch/count

Parameters

Query Parameters

Name Description
batchId Filter by batch id.
type Filter by batch type.
tenantIdIn Filter by a comma-separated list of tenant ids. A batch matches if it has one of the given tenant ids.
withoutTenantId Only include batches which belong to no tenant. Value can effectively only be true, as false is the default behavior.
suspended 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.

Result

A JSON object that contains the count as the only property.

Name Value Description
count Number The number of matching batches.

Response codes

Code Media type Description
200 application/json Request successful.
400 application/json Returned if some of the query parameters are invalid, for example if a sortOrder parameter is supplied, but no sortBy. See the Introduction for the error response format.

Example

Request

GET /batch/count?type=aBatchType

Response

Status 200.

{
  "count": 1
}

On this Page: