getReleases

Back to index

Summary

Retrieve all releases.

You must specify the projectName argument for backward compatibility with CloudBees CD/RO 6.2 and earlier.

projectName

Stringrequired

Name for the project; must be unique among all projects.

excludeRuntimeDetails

Booleanoptionaldeprecated

True to exclude runtime details for each release.

filters

Collectionoptional

A list of zero or more filter criteria definitions used to define objects to find.

firstResult

Integeroptional

Result pagination: the first row to return.

includeRuntimeDetails

Booleanoptional

True to include detailed information about release last run or a run specified in releaseFlowRuntimeMapping with flowRuntimeId, available only when the response returns a maximum of 10 releases. Default value is false.

includeRuntimes

Booleanoptional

True to include release last run information in response. Default value is false.

maxResults

Integeroptional

Result pagination: the number of rows to return.

releaseFlowRuntimeMappings

Mapoptional

Map of releaseId and flowRuntimeId.

sortKey

Stringoptional

How to sort the results.

sortOrder

Stringoptional

Specifies the order to sort the results.

Possible values: "ascending", "descending"

viewName

Stringoptionaldeprecated

The name of the view.

Usage

Perl

$cmdr->getReleases(
  "test-projectName" # projectName
  # optionals
);▼

ectool

ectool getReleases \
  "test-projectName" `# projectName` \
  # optionals▼

Examples

Perl

$cmdr->getReleases("Default", {firstResult => 2, maxResults => 200});▼

ectool

ectool getReleases "Default" --firstResult 2 --maxResults 200▼