Application

countApplicationEnvironmentInventoryObjects

Retrieves count of inventory items by application.

Arguments

Argument Name	Type	Description
filters	Collection	A list of zero or more filter criteria definitions used to define objects to find.

Argument Name

Type

Description

filters

Collection

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

Positional arguments

None.

Usage

ec-perl

$cmdr->countApplicationEnvironmentInventoryObjects({<optionals>});▼

ectool

ectool countApplicationEnvironmentInventoryObjects [optionals]▼

createApplication

Creates a new application for a project.

Arguments

Argument Name	Type	Description
projectName	String	(Required) The name for the project that must be unique among all projects.
applicationName	String	(Required) The name of the application.
applicationType	ApplicationType	The type of the application.
description	String	Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

Argument Name

Type

Description

projectName

String

(Required) The name for the project that must be unique among all projects.

applicationName

String

(Required) The name of the application.

applicationType

ApplicationType

The type of the application.

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

Positional arguments

projectName, applicationName

Usage

ec-perl

$cmdr->createApplication(<projectName>, <applicationName>, {<optionals>});▼

ectool

ectool createApplication projectName,  applicationName, [optionals]▼

deleteApplication

Deletes an application.

Arguments

Argument Name	Type	Description
projectName	String	(Required) The name for the project that must be unique among all projects.
applicationName	String	(Required) The name of the application.
foreground	Boolean	True to delete the object in the foreground. The default is to delete the object in the background.
retainInventory	Boolean	True if you wish to retain inventory after deleting the application.

Argument Name

Type

Description

projectName

String

(Required) The name for the project that must be unique among all projects.

applicationName

String

(Required) The name of the application.

foreground

Boolean

True to delete the object in the foreground. The default is to delete the object in the background.

retainInventory

Boolean

True if you wish to retain inventory after deleting the application.

Positional arguments

projectName, applicationName

Usage

ec-perl

$cmdr->deleteApplication(<projectName>, <applicationName>, {<optionals>});▼

ectool

ectool deleteApplication projectName,  applicationName, [optionals]▼

getApplication

Retrieves an application by name.

Arguments

Argument Name	Type	Description
projectName	String	(Required) The name for the project that must be unique among all projects.
applicationName	String	(Required) The name of the application.
applicationEntityRevisionId	UUID	The revision ID of the versioned object.
validate	Boolean	If passed 1, then all validations check if the definition is complete and valid.

Argument Name

Type

Description

projectName

String

(Required) The name for the project that must be unique among all projects.

applicationName

String

(Required) The name of the application.

applicationEntityRevisionId

UUID

The revision ID of the versioned object.

validate

Boolean

If passed 1, then all validations check if the definition is complete and valid.

Positional arguments

projectName, applicationName

Usage

ec-perl

$cmdr->getApplication(<projectName>, <applicationName>, {<optionals>});▼

ectool

ectool getApplication projectName,  applicationName, [optionals]▼

getApplicationEnvironmentInventory

Retrieves inventory items by application.

Arguments

Argument Name	Type	Description
filters	Collection	A list of zero or more filter criteria definitions used to define objects to find.
firstResult	Integer	Result pagination: the first row to return.
numObjects	Integer	The number of objects to return as the first page of results.

Argument Name

Type

Description

filters

Collection

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

firstResult

Integer

Result pagination: the first row to return.

numObjects

Integer

The number of objects to return as the first page of results.

Positional arguments

None.

Usage

ec-perl

$cmdr->getApplicationEnvironmentInventory({<optionals>});▼

ectool

ectool getApplicationEnvironmentInventory [optionals]▼

getApplications

Retrieves the specified applications in a project.

Arguments

Argument Name	Type	Description
projectName	String	(Required) The name for the project that must be unique among all projects.
applicationType	ApplicationType	The type of the application.
includeEntityRevisions	Boolean	Include the revisions of application the search results.
referenceComponentName	String	Name of the master component.
referenceComponentProject	String	Project name of the master component.

Argument Name

Type

Description

projectName

String

(Required) The name for the project that must be unique among all projects.

applicationType

ApplicationType

The type of the application.

includeEntityRevisions

Boolean

Include the revisions of application the search results.

referenceComponentName

String

Name of the master component.

referenceComponentProject

String

Project name of the master component.

Positional arguments

projectName

Usage

ec-perl

$cmdr->getApplications(<projectName>, {<optionals>});▼

ectool

ectool getApplications projectName, [optionals]▼

modifyApplication

Modifies an existing application.

Arguments

Argument Name	Type	Description
projectName	String	(Required) The name for the project that must be unique among all projects.
applicationName	String	(Required) The name of the application.
applicationType	ApplicationType	The type of the application.
description	String	Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
newName	String	The new name for an existing object that is being renamed.

Argument Name

Type

Description

projectName

String

(Required) The name for the project that must be unique among all projects.

applicationName

String

(Required) The name of the application.

applicationType

ApplicationType

The type of the application.

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

newName

String

The new name for an existing object that is being renamed.

Positional arguments

projectName, applicationName

Usage

ec-perl

$cmdr->modifyApplication(<projectName>, <applicationName>, {<optionals>});▼

ectool

ectool modifyApplication projectName,  applicationName, [optionals]▼