For the specified CI build, use these API commands to manage CI build data from within CloudBees CD/RO:
-
Store CI build data in CloudBees CD/RO including code commit details, test results, and build artifacts.
-
Associate CI build data with a CloudBees CD/RO release, pipeline, or published artifact.
createCIBuildDetail
Creates a new CI build for a project.
Arguments | Descriptions |
---|---|
projectName | The project with which the CI build detail object is associated. |
ciBuildDetailName | The name of the CI build. |
buildData | The build data from a CI job or a CI
pipeline in JSON format. |
buildTriggerSource | The source system which triggered this CI build. Specify |
ciBuildAssociationType | Represents how a CI build
is associated with CloudBees CD/RO. Use |
For use with pipeline run associations: | |
flowRuntimeId | (Required) The id of the CloudBees CD/RO runtime with which the CI build is associated. Use getPipelineRuntimes to get a list of runtime ids. Argument Type: UUID |
flowRuntimeStateId | The id of the flow runtime state that triggered the CI Build. Argument Type: UUID |
For use with release associations: | |
releaseName | (Required) The name of the release with which the CI build
is associated. |
releaseProjectName | The name of the project containing
the release with which the CI build is associated. Required if + Argument Type: String |
Response
Returns a ciBuildDetailInfo object.
ec-perl
syntax: $cmdr->createCIBuildDetail (<projectName>, <ciBuildDetailName>, <flowRuntimeID>, <buildData>, <buildTriggerSource>, <ciBuildAssociationType>, {<optionals>});
ectool
syntax: ectool createCIBuildDetail <projectName> <ciBuildDetailName> <flowRuntimeID> <buildData> <buildTriggerSource> <ciBuildAssociationType> [optionals]
deleteCIBuildDetail
Deletes a CI build object
Arguments | Descriptions |
---|---|
projectName | The project with which the CI build detail object is associated. Argument Type: String |
ciBuildDetailName | The name of the CI build. Argument Type: String |
flowRuntimeId | (Optional) The id of the flow runtime to which the CI build should be associated with. Argument Type: UUID |
releaseName | (Optional) The name of the release that the CI build should be associated with. Argument Type: String |
releaseProjectName | (Optional) The name of the project that contains the release that the CI build should be associated with. Argument Type: String |
getCIBuildDetail
Retrieve the specified CI build details.
Arguments | Descriptions |
---|---|
projectName | The project with which the CI build detail object is associated. Argument Type: String |
ciBuildDetailName | The name of the CI build Argument Type: String |
For use with pipeline run associations: | |
flowRuntimeId | (Required) The id of the CloudBees CD/RO runtime with which the CI build is associated. Use getPipelineRuntimes to get a list of runtime ids. Argument Type: UUID |
For use with release associations: | |
flowRuntimeId | (Required) The id of the CloudBees CD/RO runtime with which the
CI build is associated. Use getPipelineRuntimes to get a list of runtime ids.
Available if Argument Type: UUID |
releaseName | (Required) The name of the release with which the CI build
is associated.
Available if Argument Type: String |
releaseProjectName | The name of the project containing
the release with which the CI build is associated. Required if Argument Type: String |
Response
Returns a ciBuildDetailInfo object.
getCIBuildDetails
Retrieve all CI builds.
Arguments | Descriptions |
---|---|
projectName | The project with which the CI build detail object is associated. Argument Type: String |
For use with pipeline run associations: | |
flowRuntimeId | The id of the CloudBees CD/RO runtime with which the CI build is associated. Use getPipelineRuntimes to get a list of runtime ids. Argument Type: UUID |
For use with release associations: | |
excludeReleaseBuilds | Boolean flag— Available only with Argument Type: Boolean |
flowRuntimeId | The id of the CloudBees CD/RO runtime with which the
CI build is associated. Use getPipelineRuntimes to get a list of runtime ids.
Available if Argument Type: UUID |
releaseName | The name of the release with which the CI build
is associated.
Available if Argument Type: String |
releaseProjectName | The name of the project containing
the release with which the CI build is associated. Required if Argument Type: String |
Response
Returns a list of ciBuildDetailInfo objects.
modifyCIBuildDetail
Modifies an existing CI build detail object.
Arguments | Descriptions |
---|---|
projectName | The project with which the CI build detail object is associated. Argument Type: String |
ciBuildDetailName | The name of the CI build. Argument Type: String |
buildData | The build data from a CI job or a CI pipeline in JSON format. Argument Type: String |
buildTriggerSource | The source system which triggered this CI build. Specify Argument Type: BuildTriggerSource |
ciBuildAssociationType | Represents how a CI build
is associated with CloudBees CD/RO. Use Argument Type: CIBuildAssociationType |
newName | New name for this |
For use with pipeline run associations: | |
flowRuntimeId | (Required) The id of the CloudBees CD/RO runtime with which the CI build is associated. Use getPipelineRuntimes to get a list of runtime ids.+ Argument Type: UUID |
flowRuntimeStateId | The name of the stage which contains the flowRuntimeState that triggered the CI Build. Argument Type: UUID |
stageName | The name of the stage in a pipeline. Argument Type: String |
clearFlowRuntimes | (Optional) Boolean flag— |
For use with release associations: | |
releaseName | (Required) The name of the release with which the CI build is associated. Argument Type: String |
releaseProjectName | The name of the project containing
the release with which the CI build is associated. Required if Argument Type: String |
clearReleases | (Optional) Boolean flag— Set to Argument Type: Boolean |
Response
Returns a ciBuildDetailInfo object.
ec-perl
syntax: $cmdr->modifyCIBuildDetail (<projectName>, <ciBuildDetailName>, <flowRuntimeID>, <buildData>, <buildTriggerSource>, <ciBuildAssociationType>, {<optionals>});
ectool
syntax: ectool modifyCIBuildDetail <projectName> <ciBuildDetailName> <flowRuntimeID> <buildData> <buildTriggerSource> <ciBuildAssociationType> [optionals]
setCIBuildDetail
This command is a wrapper for create/modifyCIBuildDetail
API. It abstracts the logic for whether the build data needs to be created or, if it already exists, updated.
Arguments | Descriptions |
---|---|
projectName | The project with which the CI build detail object is associated. |
ciBuildDetailName | The name of the CI build. |
buildData | The build data from a CI job or a CI
pipeline in JSON format. |
buildTriggerSource | The source system which triggered this CI build. Specify |
ciBuildAssociationType | Represents how a CI build
is associated with CloudBees CD/RO. Use |
For use with pipeline run associations: | |
flowRuntimeId | (Required) The id of the CloudBees CD/RO runtime with which the CI build is associated. getPipelineRuntimes to get a list of runtime ids. Argument Type: UUID |
flowRuntimeStateId | The name of the stage which contains the flowRuntimeState that triggered the CI Build. Argument Type: UUID |
stageName | The name of the stage in a pipeline. Argument Type: String |
clearFlowRuntimes | (Optional) Boolean flag— |
For use with release associations: | |
releaseName | (Required) The name of the release with which the CI build
is associated. |
releaseProjectName | The name of the project containing
the release with which the CI build is associated. Required if + Argument Type: String |
clearReleases | (Optional) Boolean flag— |
Response
Returns a ciBuildDetailInfo object.
ec-perl
syntax: $cmdr->setCIBuildDetail (<projectName>, <ciBuildDetailName>, <flowRuntimeID>, <buildData>, <buildTriggerSource>, <ciBuildAssociationType>, {<optionals>});
ectool
syntax: ectool setCIBuildDetail <projectName> <ciBuildDetailName> <flowRuntimeID> <buildData> <buildTriggerSource> <ciBuildAssociationType> [optionals]