Deployment

Get List

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.

get/deployment

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/deployment
  • Auth: HTTP basic

Query parameters

idstring

Filter by deployment id

namestring

Filter by the deployment name. Exact match.

nameLikestring

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%).

sourcestring

Filter by the deployment source.

withoutSourceboolean

Filter by the deployment source whereby source is equal to null.

tenantIdInstring

Filter by a comma-separated list of tenant ids. A deployment must have one of the given tenant ids.

withoutTenantIdboolean

Only include deployments which belong to no tenant. Value may only be true, as false is the default behavior.

includeDeploymentsWithoutTenantIdboolean

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.

afterstring date-time

Restricts to all deployments 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.

beforestring date-time

Restricts to all deployments 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.

sortBy'id' | 'name' | 'deploymentTime' | 'tenantId'

Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter.

sortOrder'asc' | 'desc'

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.

firstResultinteger

Pagination of results. Specifies the index of the first result to return.

maxResultsinteger

Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

Response

Request successful.

idstring nullable

The id of the deployment.

tenantIdstring nullable

The tenant id of the deployment.

deploymentTimestring date-time nullable

The time when the deployment was created.

sourcestring nullable

The source of the deployment.

namestring nullable

The name of the deployment.

Changes

No recorded changes to this operation across all 1 revision of this API.