Skip to main content
GET
/
deployment
Get List
curl --request GET \
  --url http://{host}:{port}/{contextPath}/deployment \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "id": "someId",
    "name": "deploymentName",
    "source": "process application",
    "tenantId": null,
    "deploymentTime": "2013-04-23T13:42:43.000+0200"
  }
]

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

​
id
string

Filter by deployment id

​
name
string

Filter by the deployment name. Exact match.

​
nameLike
string

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
string

Filter by the deployment source.

​
withoutSource
boolean
default:false

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

​
tenantIdIn
string

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

​
withoutTenantId
boolean
default:false

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

​
includeDeploymentsWithoutTenantId
boolean
default:false

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

​
before
string<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
enum<string>

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

Available options:
id,
name,
deploymentTime,
tenantId
​
sortOrder
enum<string>

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.

Available options:
asc,
desc
​
firstResult
integer

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

​
maxResults
integer

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.

​
id
string | null

The id of the deployment.

​
tenantId
string | null

The tenant id of the deployment.

​
deploymentTime
string<date-time> | null

The time when the deployment was created.

​
source
string | null

The source of the deployment.

​
name
string | null

The name of the deployment.

​
links
object[] | null

The links associated to this resource, with method, href and rel.