countApplicationEnvironmentInventoryObjects
Retrieve count of inventory items by application
Arguments
Argument Name | Type | Description |
---|---|---|
filters | Filter array | Filters |
createApplication
Creates a new application for a project.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
applicationName | String | The name of the application (Required) |
applicationType | String | The type of the application |
description | String | Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
deleteApplication
Deletes an application
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
applicationName | String | The name of the application (Required) |
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. |
getApplication
Find a application by name.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
applicationName | String | The name of the application (Required) |
applicationEntityRevisionId | String | Revisionid of the versioned object |
validate | Boolean | If passed 1, then all validations check if the definition is complete and valid. |
getApplicationDependencies
Gets the dependencies of an application.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
applicationName | String | The name of the application (Required) |
dependentApplicationName | String | The name of application which this application depends on. |
dependentProjectName | String | The name the project containing the dependent application. |
dependentSnapshotName | String | The name of snapshot of the dependent application. |
snapshotName | String | Name of the snapshot; must be unique within the application. |
getApplicationEnvironmentInventory
Retrieve inventory items by application
Arguments
Argument Name | Type | Description |
---|---|---|
filters | Filter array | Filters |
firstResult | Integer | Result pagination: the first row to return. |
numObjects | Integer | The number of objects to return as the first page of results. |
getApplications
Retrieve all applications in a project.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
applicationType | String | 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. |
getEnvironmentApplications
getPartialApplicationRevision
Returns partial application object for snapshot creation
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
applicationName | String | The name of the application (Required) |
revisionNumber | Integer | Revision number (Required) |
Usage
import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*
ElectricFlow ef = new ElectricFlow()
def result = ef.getPartialApplicationRevision(
projectName: 'test-projectName',
applicationName: 'test-applicationName',
revisionNumber: 'test-revisionNumber')
modifyApplication
Modifies an existing application.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
applicationName | String | The name of the application (Required) |
applicationType | String | The type of the application |
description | String | Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
newName | String | New name for an existing object that is being renamed. |