CiBuildDetail

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 the CI build should be associated with.
flowRuntimeStateId	String	The ID of the flow runtime state that 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 the CI build should be associated with.
stageName	String	The name of the stage that contains the task which triggered the CI build.

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 the CI build should be associated with.

flowRuntimeStateId

String

The ID of the flow runtime state that 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 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 object.

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 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 the CI build should be associated with.

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

Retrieves the specified CI build details.

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 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 the CI build should be associated with.

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

Retrieves all CI builds.

Arguments

Argument Name	Type	Description
projectName	String	The name of the project that the CI build is associated with.
excludeReleaseBuilds	Boolean	Specifies if CI builds associated with the release should be excluded when retrieving CI builds for a specified release run.
flowRuntimeId	String	The ID of the flow runtime 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 the CI build should be associated with.

Argument Name

Type

Description

projectName

String

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

excludeReleaseBuilds

Boolean

Specifies if CI builds associated with the release should be excluded when retrieving CI builds for a specified release run.

flowRuntimeId

String

The ID of the flow runtime 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 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 detail object.

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 the CI build should be associated with.
flowRuntimeStateId	String	The ID of the flow runtime state that 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 the CI build should be associated with.
stageName	String	The name of the stage that contains the task which triggered the CI build.

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 the CI build should be associated with.

flowRuntimeStateId

String

The ID of the flow runtime state that 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 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

This command is a wrapper for the create/modifyCIBuildDetail API. It abstracts the logic for whether the build data needs to be created or, if it already exists, updated.

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 the CI build should be associated with.
flowRuntimeStateId	String	The ID of the flow runtime state that 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 the CI build should be associated with.
stageName	String	The name of the stage that contains the task which triggered the CI build.

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 the CI build should be associated with.

flowRuntimeStateId

String

The ID of the flow runtime state that 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 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 */)▼