Get Deployment Count
Queries for the number of deployments that fulfill given parameters. Takes the same parameters as the Get Deployments method.
Method
GET /deployment/count
Parameters
Query Parameters
| Name | Description |
|---|---|
| id | Filter by deployment id. |
| name | Filter by the deployment name. Exact match. |
| nameLike | Filter by the deployment name that the parameter is a substring of. The parameter can include the wildcard % to express like-strategy such as: starts with (%name), ends with (name%) or contains (%name%). |
| source | Filter by the deployment source. |
| withoutSource | Filter by the deployment source whereby source is equal to null. |
| tenantIdIn | Filter by a comma-separated list of tenant ids. A deployment must have one of the given tenant ids. |
| withoutTenantId | Only include deployments which belong to no tenant. Value may only be true, as false is the default behavior. |
| includeDeploymentsWithoutTenantId | Include deployments which belong to no tenant. Can be used in combination with tenantIdIn. Value may only be true, as false is the default behavior. |
| after | Restricts to all deployments after the given date. The date must have the format yyyy-MM-dd'T'HH:mm:ss, e.g., 2013-01-23T14:42:45. |
| before | Restricts to all deployments before the given date. The date must have the format yyyy-MM-dd'T'HH:mm:ss, e.g., 2013-01-23T14:42:45. |
| sortBy | Sort the results lexicographically by a given criterion. Valid values are
id, name and deploymentTime.
Must be used in conjunction with the sortOrder parameter. |
| sortOrder | Sort the results in a given order. Values may be asc for ascending order or desc for descending order.
Must be used in conjunction with the sortBy parameter. |
| firstResult | Pagination of results. Specifies the index of the first result to return. |
| maxResults | Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. |
Result
A JSON object that contains the count as the only property.
| Name | Value | Description |
|---|---|---|
| count | Number | The number of matching deployments. |
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, or if an invalid operator for variable comparison is used. See the Introduction for the error response format. |
Example
Request
GET /deployment/count?name=deploymentName
Response
{"count": 1}