Introduction
IntroductionAccess tokenACLApplication dependencyApplicationApplication tierArchive connectorArtifactCatalogCatalog item runChange historyCI buildCI build detailCI configurationCI eventCI jobClusterComponentsCredentialCredential providerCustom filterDashboardDashboard columnDatabase configurationData retention policyDeployer applicationDevOps Insight data sourceDirectory providerDynamic environmentEmail configurationEmail notifierEnvironmentEnvironment tierGatewayGroupInstalling or upgrading remote agentsJobKerberos keytabMicroserviceMicroservice mappingMiscellaneousObjectObject tagsParameterPersonaPipelinePluginPlugin configurationPlugin catalogProcedureProcessProcess dependencyProcess stepProjectPropertyReleaseReportReporting filterReport object associationReport object attributeReport object typeResourceRolling deployScheduleSCM syncServerServer settings categoryService accounts for webhooksSessionSingle sign-on for OpenID ConnectSingle sign-on for SAMLSnapshotsTier mapTriggerUserUser emailUtility resourceWait dependencyWebhook resultWidgetWidget filter overrideWorkflowWorkflow definitionWork itemsWorkspaceZone
Perl API response and element glossary
Introduction
Examples
Troubleshooting
IntroductionaccesstokenaclaclentryactualparameterapplicationapplicationdependencyapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuildcibuilddetailciconfigurationcieventclustercomponentcredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectopenidconnectconfigurationoutputparameterpersonapersonacategorypersonapagepipelinepluginplugincatalogpluginconfigurationprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulescmsyncsearchfilterserverserversettingserversettingcategoryserviceaccountsessionsnapshotstagestatestatedefinitionstringresulttagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseraccesstokenuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

CI build detail

4 minute readReference

createCIBuildDetail

Creates a new CI build for a project.

Arguments

Argument Name Type Description

projectName

String

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

ciBuildDetailName

String

(Required) The name of the CI build detail.

buildData

String

The build data from a CI system in JSON format.

buildTriggerSource

BuildTriggerSource

The source of the build trigger.

ciBuildAssociationType

CIBuildAssociationType

Represents how a CI build is associated with flow.

flowRuntimeId

UUID

The ID of the flow runtime the CI build should be associated with.

flowRuntimeStateId

UUID

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.

Positional arguments

projectName, ciBuildDetailName

Usage

ec-perl

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

ectool

ectool createCIBuildDetail projectName,  ciBuildDetailName, [optionals]
▼

deleteCIBuildDetail

Deletes a CI build object.

Arguments

Argument Name Type Description

projectName

String

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

ciBuildDetailName

String

(Required) The name of the CI build detail.

flowRuntimeId

UUID

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.

Positional arguments

projectName, ciBuildDetailName

Usage

ec-perl

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

ectool

ectool deleteCIBuildDetail projectName,  ciBuildDetailName, [optionals]
▼

getCIBuildDetail

Retrieves the specified CI build details.

Arguments

Argument Name Type Description

projectName

String

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

ciBuildDetailName

String

(Required) The name of the CI build detail.

flowRuntimeId

UUID

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.

Positional arguments

projectName, ciBuildDetailName

Usage

ec-perl

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

ectool

ectool getCIBuildDetail projectName,  ciBuildDetailName, [optionals]
▼

getCIBuildDetails

Retrieves all CI builds.

Arguments

Argument Name Type Description

excludeReleaseBuilds

Boolean

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

flowRuntimeId

UUID

The ID of the flow runtime the CI build should be associated with.

projectName

String

The name of the project that the CI build is 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.

Positional arguments

None.

Usage

ec-perl

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

ectool

ectool getCIBuildDetails [optionals]
▼

modifyCIBuildDetail

Modifies an existing CI build detail object.

Arguments

Argument Name Type Description

projectName

String

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

ciBuildDetailName

String

(Required) The name of the CI build detail.

buildData

String

The build data from a CI system in JSON format.

buildTriggerSource

BuildTriggerSource

The source of the build trigger.

ciBuildAssociationType

CIBuildAssociationType

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

UUID

The ID of the flow runtime the CI build should be associated with.

flowRuntimeStateId

UUID

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.

Positional arguments

projectName, ciBuildDetailName

Usage

ec-perl

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

ectool

ectool modifyCIBuildDetail projectName,  ciBuildDetailName, [optionals]
▼

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

projectName

String

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

ciBuildDetailName

String

(Required) The name of the CI build detail.

buildData

String

The build data from a CI system in JSON format.

buildTriggerSource

BuildTriggerSource

The source of the build trigger.

ciBuildAssociationType

CIBuildAssociationType

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

UUID

The ID of the flow runtime the CI build should be associated with.

flowRuntimeStateId

UUID

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.

Positional arguments

projectName, ciBuildDetailName

Usage

ec-perl

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

ectool

ectool setCIBuildDetail projectName,  ciBuildDetailName, [optionals]
▼
CI build
CI configuration