modifyWidgetFilterOverride

On this page
Back to index

Summary

Modifies a widget filter override.
projectName
Stringrequired
The name for the project that must be unique among all projects.
dashboardName
Stringrequired
Unique name of the dashboard within the project.
widgetName
Stringrequired
Name of the widget within the dashboard this widget filter override is scoped to.
dashboardFilterName
Stringrequired
The name of the dashboard filter.
description
Stringoptional
Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
ignoreFilter
Booleanoptional
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
Stringoptional
The parameter name to use when applying the filter to the report instead of the parameter name specified in the dashboard filter.

Usage

Groovy

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 */ )