createReportingFilter

Back to index

Summary

Creates a new reporting filter.

projectName

Stringrequired

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

dashboardName

Stringrequired

Unique name of the dashboard within the project.

reportingFilterName

Stringrequired

The name of the reporting filter.

actualParameter

Arrayoptional

Parameters passed reporting filter.

afterReportingFilter

Stringoptional

The name of the reporting filter after which this reporting filter should be placed.

beforeReportingFilter

Stringoptional

The name of the reporting filter before which this reporting filter should be placed.

description

Stringoptional

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

filters

Stringoptional

String representation of CompositeFilter object used for additional attribute values filtering.

operator

Stringoptional

The operator is allowed to use in a reporting filter.

orderIndex

Integeroptional

Order that the reporting filter should be displayed.

parameterName

Stringoptional

The parameter name to filter on it.

reportObjectTypeName

Stringoptional

The name of the report object type, if the reporting filter is a custom filter.

required

Booleanoptional

The flag to see is this reporting filter required to be used.

type

Stringoptional

The type of the field value.

widgetName

Stringoptional

The name of the widget this reporting filter is scoped to.

Usage

Perl

$cmdr->createReportingFilter(
  "test-projectName", # projectName
  "test-dashboardName", # dashboardName
  "test-reportingFilterName" # reportingFilterName
  # optionals
);▼

ectool

ectool createReportingFilter \
  "test-projectName" `# projectName` \
  "test-dashboardName" `# dashboardName` \
  "test-reportingFilterName" `# reportingFilterName` \
  # optionals▼

Examples

Perl

$cmdr->createReportingFilter("Default", "ExecDashboard", "MonthlyRollup");▼

ectool

ectool createReportingFilter Default ExecDashboard MonthlyRollup▼