Widget filter override

2 minute readReference

createWidgetFilterOverride

Creates a new widget filter override.

Arguments

Argument Name Type Description

projectName

String

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

dashboardName

String

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

widgetName

String

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

dashboardFilterName

String

(Required) The name of the dashboard filter.

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.

Positional arguments

projectName, dashboardName, widgetName, dashboardFilterName

Usage

ec-perl

$cmdr->createWidgetFilterOverride(<projectName>, <dashboardName>, <widgetName>, <dashboardFilterName>, {<optionals>});

ectool

ectool createWidgetFilterOverride projectName, dashboardName, widgetName, dashboardFilterName, [optionals]

deleteWidgetFilterOverride

Deletes a widget filter override.

Arguments

Argument Name Type Description

projectName

String

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

dashboardName

String

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

widgetName

String

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

dashboardFilterName

String

(Required) The name of the dashboard filter.

Positional arguments

projectName, dashboardName, widgetName, dashboardFilterName

Usage

ec-perl

$cmdr->deleteWidgetFilterOverride(<projectName>, <dashboardName>, <widgetName>, <dashboardFilterName>);

ectool

ectool deleteWidgetFilterOverride projectName, dashboardName, widgetName, dashboardFilterName

getWidgetFilterOverride

Retrieves a widget filter override by dashboard filter name.

Arguments

Argument Name Type Description

projectName

String

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

dashboardName

String

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

widgetName

String

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

dashboardFilterName

String

(Required) The name of the dashboard filter.

Positional arguments

projectName, dashboardName, widgetName, dashboardFilterName

Usage

ec-perl

$cmdr->getWidgetFilterOverride(<projectName>, <dashboardName>, <widgetName>, <dashboardFilterName>);

ectool

ectool getWidgetFilterOverride projectName, dashboardName, widgetName, dashboardFilterName

getWidgetFilterOverrides

Retrieves all widget filter overrides for the widget.

Arguments

Argument Name Type Description

projectName

String

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

dashboardName

String

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

widgetName

String

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

Positional arguments

projectName, dashboardName, widgetName

Usage

ec-perl

$cmdr->getWidgetFilterOverrides(<projectName>, <dashboardName>, <widgetName>);

ectool

ectool getWidgetFilterOverrides projectName, dashboardName, widgetName

modifyWidgetFilterOverride

Modifies a widget filter override.

Arguments

Argument Name Type Description

projectName

String

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

dashboardName

String

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

widgetName

String

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

dashboardFilterName

String

(Required) The name of the dashboard filter.

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.

Positional arguments

projectName, dashboardName, widgetName, dashboardFilterName

Usage

ec-perl

$cmdr->modifyWidgetFilterOverride(<projectName>, <dashboardName>, <widgetName>, <dashboardFilterName>, {<optionals>});

ectool

ectool modifyWidgetFilterOverride projectName, dashboardName, widgetName, dashboardFilterName, [optionals]