modifyWidgetFilterOverride

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

Perl

$cmdr->modifyWidgetFilterOverride(
  "test-projectName", # projectName
  "test-dashboardName", # dashboardName
  "test-widgetName", # widgetName
  "test-dashboardFilterName" # dashboardFilterName
  # optionals
);▼

ectool

ectool modifyWidgetFilterOverride \
  "test-projectName" `# projectName` \
  "test-dashboardName" `# dashboardName` \
  "test-widgetName" `# widgetName` \
  "test-dashboardFilterName" `# dashboardFilterName` \
  # optionals▼

Examples

Perl

$cmdr->modifyWidgetFilterOverride("Default", "ExecDashboard", "MyWidget" "AprilReleases", newName => "AprilRollup");▼

ectool

ectool modifyWidgetFilterOverride Default ExecDashboard MyWidget AprilReleases --newName AprilRollup▼