Edit on Github

Get Deployments

Queries for deployments that fulfill given parameters. Parameters may be the properties of deployments, such as the id or name or a range of the deployment time. The size of the result set can be retrieved by using the Get Deployment count method.

Method

GET /deployment

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`, `deploymentTime` and `tenantId`. 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 array of deployment objects. Each deployment object has the following properties:

Name	Value	Description
id	String	The id of the deployment.
name	String	The name of the deployment.
source	String	The source of the deployment.
tenantId	String	The tenant id of the deployment.
deploymentTime	Date	The date and time of the deployment.

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?name=deploymentName

Response

[
  {
    "id": "someId",
    "name": "deploymentName",
    "source": "process application",
    "tenantId": null,
    "deploymentTime": "2013-04-23T13:42:43"
  }
]

Options