Using the Perl API
Perl API reference
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 managementGet application environment inventoryInstalling 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
Using the Groovy API
IntroductionExamplesTroubleshooting
Groovy API reference
IntroductionaccesstokenaclaclentryactualparameteractualparametersapplicationapplicationdependencyapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuildcibuilddetailciconfigurationcieventclustercomponentcredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectopenidconnectconfigurationoutputparameterpersonapersonacategorypersonapagepipelinepluginplugincatalogpluginconfigurationprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulescmsyncsearchfilterserverserversettingserversettingcategoryserviceaccountsessionsnapshotstagestatestatedefinitiontagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

WidgetFilterOverride

3 minute readReference

createWidgetFilterOverride

Create a new widget filter override.

Arguments

Argument Name Type Description

projectName

String

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

dashboardName

String

Unique name of the dashboard within the project. (Required)

widgetName

String

Name of the widget within the dashboard this widget filter override is scoped to. (Required)

dashboardFilterName

String

The name of the dashboard filter. (Required)

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

ignoreFilter

Boolean

Whether to ignore the dashboard filter and not apply it to the report. All other arguments are ignored if this argument is set to true.

parameterName

String

The parameter name to use when applying the filter to the report instead of the parameter name specified in the dashboard filter.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.createWidgetFilterOverride(
                projectName: 'test-projectName',
                dashboardName: 'test-dashboardName',
                widgetName: 'test-widgetName',
                dashboardFilterName: 'test-dashboardFilterName'
                /* optional arguments */)

deleteWidgetFilterOverride

Delete a widget filter override.

Arguments

Argument Name Type Description

projectName

String

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

dashboardName

String

Unique name of the dashboard within the project. (Required)

widgetName

String

Name of the widget within the dashboard this widget filter override is scoped to. (Required)

dashboardFilterName

String

The name of the dashboard filter. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteWidgetFilterOverride(
                projectName: 'test-projectName',
                dashboardName: 'test-dashboardName',
                widgetName: 'test-widgetName',
                dashboardFilterName: 'test-dashboardFilterName')

getWidgetFilterOverride

Retrieve a widget filter override by dashboard filter name.

Arguments

Argument Name Type Description

projectName

String

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

dashboardName

String

Unique name of the dashboard within the project. (Required)

widgetName

String

Name of the widget within the dashboard this widget filter override is scoped to. (Required)

dashboardFilterName

String

The name of the dashboard filter. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getWidgetFilterOverride(
                projectName: 'test-projectName',
                dashboardName: 'test-dashboardName',
                widgetName: 'test-widgetName',
                dashboardFilterName: 'test-dashboardFilterName')

getWidgetFilterOverrides

Retrieve all widget filter overrides for the pointed widget.

Arguments

Argument Name Type Description

projectName

String

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

dashboardName

String

Unique name of the dashboard within the project. (Required)

widgetName

String

Name of the widget within the dashboard this widget filter override is scoped to. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getWidgetFilterOverrides(
                projectName: 'test-projectName',
                dashboardName: 'test-dashboardName',
                widgetName: 'test-widgetName')

modifyWidgetFilterOverride

Modify a widget filter override.

Arguments

Argument Name Type Description

projectName

String

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

dashboardName

String

Unique name of the dashboard within the project. (Required)

widgetName

String

Name of the widget within the dashboard this widget filter override is scoped to. (Required)

dashboardFilterName

String

The name of the dashboard filter. (Required)

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

ignoreFilter

Boolean

Whether to ignore the dashboard filter and not apply it to the report. All other arguments are ignored if this argument is set to true.

parameterName

String

The parameter name to use when applying the filter to the report instead of the parameter name specified in the dashboard filter.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyWidgetFilterOverride(
                projectName: 'test-projectName',
                dashboardName: 'test-dashboardName',
                widgetName: 'test-widgetName',
                dashboardFilterName: 'test-dashboardFilterName'
                /* optional arguments */)
widget
workflow