Reporting filter

3 minute readReference

createReportingFilter

Creates a new reporting filter.

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.

reportingFilterName

String

(Required) The name of the reporting filter.

actualParameters

Map

Parameters passed reporting filter.

description

String

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

filters

String

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

operator

String

The operator is allowed to use in a reporting filter.

orderIndex

Integer

Order that the reporting filter should be displayed.

parameterName

String

The parameter name to filter on it.

reportObjectTypeName

String

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

required

Boolean

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

type

String

The type of the field value.

widgetName

String

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

Positional arguments

projectName, dashboardName, reportingFilterName

Usage

ec-perl

$cmdr->createReportingFilter(<projectName>, <dashboardName>, <reportingFilterName>, {<optionals>});

ectool

ectool createReportingFilter projectName, dashboardName, reportingFilterName, [optionals]

deleteReportingFilter

Deletes a reporting filter.

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.

reportingFilterName

String

(Required) The name of the reporting filter.

widgetName

String

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

Positional arguments

projectName, dashboardName, reportingFilterName

Usage

ec-perl

$cmdr->deleteReportingFilter(<projectName>, <dashboardName>, <reportingFilterName>, {<optionals>});

ectool

ectool deleteReportingFilter projectName, dashboardName, reportingFilterName, [optionals]

getReportingFilter

Retrieves a reporting filter by 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.

reportingFilterName

String

(Required) The name of the reporting filter.

widgetName

String

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

Positional arguments

projectName, dashboardName, reportingFilterName

Usage

ec-perl

$cmdr->getReportingFilter(<projectName>, <dashboardName>, <reportingFilterName>, {<optionals>});

ectool

ectool getReportingFilter projectName, dashboardName, reportingFilterName, [optionals]

getReportingFilters

Retrieves all reporting filters.

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

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

Positional arguments

projectName, dashboardName

Usage

ec-perl

$cmdr->getReportingFilters(<projectName>, <dashboardName>, {<optionals>});

ectool

ectool getReportingFilters projectName, dashboardName, [optionals]

modifyReportingFilter

Modifies a reporting filter.

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.

reportingFilterName

String

(Required) The name of the reporting filter.

actualParameters

Map

Parameters passed reporting filter.

description

String

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

filters

String

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

newName

String

The new name for an existing object that is being renamed.

operator

String

The operator is allowed to use in a reporting filter.

orderIndex

Integer

Order that the reporting filter should be displayed.

parameterName

String

The parameter name to filter on it.

reportObjectTypeName

String

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

required

Boolean

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

type

String

The type of the field value.

widgetName

String

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

Positional arguments

projectName, dashboardName, reportingFilterName

Usage

ec-perl

$cmdr->modifyReportingFilter(<projectName>, <dashboardName>, <reportingFilterName>, {<optionals>});

ectool

ectool modifyReportingFilter projectName, dashboardName, reportingFilterName, [optionals]