Using the Perl API
Perl API reference
IntroductionACL managementApplication dependencyApplicationsApplication tier Artifact managementCatalogsChange historyCI build detailCI configurationCI jobsComponentsCredential managementCustom filtersDatabase configurationData retentionCloudBees AnalyticsDirectory provider managementDynamic environmentsEmail configuration managementEmail notifier managementEnvironmentEnvironment tierGateway and zone managementInstalling or upgrading remote agentsJob managementMicroservicesObject tagsParameter managementPersonasPipelines and releasesPlugin managementProcedure managementProcessProcess dependencyProcess stepProject managementProperty managementResource managementRolling deploySchedule managementServer managementSingle sign-onSnapshotsTier mapUser and group managementWait dependenciesWebhhook managementWorkflow definition managementWorkflow managementWork itemsWorkspace managementMiscellaneous management
Perl API response and element glossary
Using the Groovy API
IntroductionExamplesTroubleshooting
Groovy API reference
IntroductionaccesstokenaclaclentryactualparameteractualparametersapplicationapplicationdependencyapplicationservicemappingapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuildcibuilddetailciconfigurationcieventclustercomponentcontainercredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeployerservicedeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmentmapenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvironmentvariableenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectoutputparameterpersonapersonacategorypersonapagepipelinepluginpluginconfigurationportprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulesearchfilterserverserversettingserversettingcategoryserviceaccountserviceserviceclustermappingservicedependencyservicemapdetailsessionsnapshotstagestatestatedefinitiontagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

CiBuildDetail

4 minute readReference

createCIBuildDetail

Creates a new CI build for a project.

Arguments

Argument Name Type Description

projectName

String

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

ciBuildDetailName

String

The name of the CI build detail (Required)

buildData

String

The build data from a CI system in JSON format.

buildTriggerSource

String

The source of the build trigger.

ciBuildAssociationType

String

Represents how a CI build is associated with flow

flowRuntimeId

String

The id of the flow runtime to which the CI build should be associated with.

flowRuntimeStateId

String

The id of the flow runtime state which triggered the CI build.

releaseName

String

The name of the release that the CI build should be associated with.

releaseProjectName

String

The name of the project that contains the release that the CI build should be associated with.

stageName

String

The name of the stage that contains the task which triggered the CI build.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.createCIBuildDetail(
                projectName: 'test-projectName',
                ciBuildDetailName: 'test-ciBuildDetailName'
                /* optional arguments */)

deleteCIBuildDetail

Deletes a CI build detail

Arguments

Argument Name Type Description

projectName

String

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

ciBuildDetailName

String

The name of the CI build detail (Required)

flowRuntimeId

String

The id of the flow runtime to which the CI build should be associated with.

releaseName

String

The name of the release that the CI build should be associated with.

releaseProjectName

String

The name of the project that contains the release that the CI build should be associated with.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteCIBuildDetail(
                projectName: 'test-projectName',
                ciBuildDetailName: 'test-ciBuildDetailName'
                /* optional arguments */)

getCIBuildDetail

Retrieve a CI build detail by name.

Arguments

Argument Name Type Description

projectName

String

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

ciBuildDetailName

String

The name of the CI build detail (Required)

flowRuntimeId

String

The id of the flow runtime to which the CI build should be associated with.

releaseName

String

The name of the release that the CI build should be associated with.

releaseProjectName

String

The name of the project that contains the release that the CI build should be associated with.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.getCIBuildDetail(
                projectName: 'test-projectName',
                ciBuildDetailName: 'test-ciBuildDetailName'
                /* optional arguments */)

getCIBuildDetails

Retrieve all CI build details.

Arguments

Argument Name Type Description

projectName

String

The name of the project that the CI build is associated with.

excludeReleaseBuilds

Boolean

Whether to exclude CI builds associated with the release when retrieving CI builds for a specified release run.

flowRuntimeId

String

The id of the flow runtime to which the CI build should be associated with.

releaseName

String

The name of the release that the CI build should be associated with.

releaseProjectName

String

The name of the project that contains the release that the CI build should be associated with.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.getCIBuildDetails(
                /* optional arguments */)

modifyCIBuildDetail

Modifies an existing CI build.

Arguments

Argument Name Type Description

projectName

String

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

ciBuildDetailName

String

The name of the CI build detail (Required)

buildData

String

The build data from a CI system in JSON format.

buildTriggerSource

String

The source of the build trigger.

ciBuildAssociationType

String

Represents how a CI build is associated with flow

clearFlowRuntimes

Boolean

True to clear references to all pipeline runs.

clearReleases

Boolean

True to clear references to all releases.

flowRuntimeId

String

The id of the flow runtime to which the CI build should be associated with.

flowRuntimeStateId

String

The id of the flow runtime state which triggered the CI build.

newName

String

New name for an existing object that is being renamed.

releaseName

String

The name of the release that the CI build should be associated with.

releaseProjectName

String

The name of the project that contains the release that the CI build should be associated with.

stageName

String

The name of the stage that contains the task which triggered the CI build.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyCIBuildDetail(
                projectName: 'test-projectName',
                ciBuildDetailName: 'test-ciBuildDetailName'
                /* optional arguments */)

setCIBuildDetail

Set an existing CI build detail to a release or pipeline run.

Arguments

Argument Name Type Description

ciBuildDetailName

String

The name of the CI build detail (Required)

projectName

String

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

buildData

String

The build data from a CI system in JSON format.

buildTriggerSource

String

The source of the build trigger.

ciBuildAssociationType

String

Represents how a CI build is associated with flow

clearFlowRuntimes

Boolean

True to clear references to all pipeline runs.

clearReleases

Boolean

True to clear references to all releases.

flowRuntimeId

String

The id of the flow runtime to which the CI build should be associated with.

flowRuntimeStateId

String

The id of the flow runtime state which triggered the CI build.

releaseName

String

The name of the release that the CI build should be associated with.

releaseProjectName

String

The name of the project that contains the release that the CI build should be associated with.

stageName

String

The name of the stage that contains the task which triggered the CI build.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.setCIBuildDetail(
                ciBuildDetailName: 'test-ciBuildDetailName',
                projectName: 'test-projectName'
                /* optional arguments */)
cibuild
ciconfiguration