Using the Perl API
IntroductionAccess tokensACL 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 managementPlugin configuration managementProcedure managementProcessProcess dependencyProcess stepProject managementProperty managementResource managementRolling deploySchedule managementService accounts for webhooksServer managementSingle sign on for SAMLSnapshotsTier mapTrigger managementUser and group managementUser profile email managementWait dependenciesWorkflow definition managementWorkflow managementWork itemsWorkspace managementMiscellaneous management
Perl API response and element glossary
IntroductionExamplesTroubleshooting
IntroductionaccesstokenaclaclentryactualparameteractualparametersapplicationapplicationdependencyapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuildcibuilddetailciconfigurationcieventclustercomponentcredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectopenidconnectconfigurationoutputparameterpersonapersonacategorypersonapagepipelinepluginplugincatalogpluginconfigurationprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulescmsyncsearchfilterserverserversettingserversettingcategoryserviceaccountsessionsnapshotstagestatestatedefinitiontagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

TriggerErrorDetail

1 minute readReference

createTriggerErrorDetail

Creates trigger error detail

Arguments

Argument Name Type Description

applicationName

String

The name of the application

errorCode

String

Error code

errorMessage

String

Error message

includeDetails

Boolean

True to include details (default is false)

path

String

Property path string.

pipelineName

String

The name of the pipeline

procedureName

String

The name of the procedure

projectName

String

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

releaseName

String

The name of the release

scmSyncName

String

The name of the scmSync

triggerName

String

The name of the trigger

webhookHeaders

String

JSON contains webhook headers.

webhookPayload

String

JSON contains webhook payload.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.createTriggerErrorDetail(
                /* optional arguments */)
▼

deleteTriggerErrorDetail

Deletes trigger error detail

Arguments

Argument Name Type Description

triggerErrorDetailId

String

the id of trigger error detail (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteTriggerErrorDetail(
                triggerErrorDetailId: 'test-triggerErrorDetailId')
▼

getTriggerErrorDetails

Retrieve a list of trigger error details

Arguments

Argument Name Type Description

applicationName

String

The name of the application

includeDetails

Boolean

True to include details (default is false)

path

String

Property path string.

pipelineName

String

The name of the pipeline

procedureName

String

The name of the procedure

projectName

String

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

releaseName

String

The name of the release

scmSyncName

String

The name of the scmSync

triggerName

String

The name of the trigger

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getTriggerErrorDetails(
                /* optional arguments */)
▼
trigger
user