ReportingFilter

createReportingFilter

Create a new reporting filter.

Arguments

Argument Name	Type	Description
projectName	String	The name for the project that must be unique among all projects. (Required)
dashboardName	String	Unique name of the dashboard within the project. (Required)
reportingFilterName	String	The name of the reporting filter. (Required)
actualParameters	ActualParameter array	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.

Argument Name

Type

Description

projectName

String

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

dashboardName

String

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

reportingFilterName

String

The name of the reporting filter. (Required)

actualParameters

ActualParameter array

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.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.createReportingFilter(
                projectName: 'test-projectName',
                dashboardName: 'test-dashboardName',
                reportingFilterName: 'test-reportingFilterName'
                /* optional arguments */)▼

deleteReportingFilter

Delete a reporting filter.

Arguments

Argument Name	Type	Description
projectName	String	The name for the project that must be unique among all projects. (Required)
dashboardName	String	Unique name of the dashboard within the project. (Required)
reportingFilterName	String	The name of the reporting filter. (Required)
widgetName	String	The name of the widget this reporting filter is scoped to.

Argument Name

Type

Description

projectName

String

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

dashboardName

String

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

reportingFilterName

String

The name of the reporting filter. (Required)

widgetName

String

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

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteReportingFilter(
                projectName: 'test-projectName',
                dashboardName: 'test-dashboardName',
                reportingFilterName: 'test-reportingFilterName'
                /* optional arguments */)▼

getReportingFilter

Retrieve a reporting filter by name.

Arguments

Argument Name	Type	Description
projectName	String	The name for the project that must be unique among all projects. (Required)
dashboardName	String	Unique name of the dashboard within the project. (Required)
reportingFilterName	String	The name of the reporting filter. (Required)
widgetName	String	The name of the widget this reporting filter is scoped to.

Argument Name

Type

Description

projectName

String

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

dashboardName

String

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

reportingFilterName

String

The name of the reporting filter. (Required)

widgetName

String

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

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.getReportingFilter(
                projectName: 'test-projectName',
                dashboardName: 'test-dashboardName',
                reportingFilterName: 'test-reportingFilterName'
                /* optional arguments */)▼

getReportingFilters

Retrieve all reporting filters.

Arguments

Argument Name	Type	Description
projectName	String	The name for the project that must be unique among all projects. (Required)
dashboardName	String	Unique name of the dashboard within the project. (Required)
widgetName	String	The name of the widget this reporting filter is scoped to.

Argument Name

Type

Description

projectName

String

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

dashboardName

String

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

widgetName

String

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

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.getReportingFilters(
                projectName: 'test-projectName',
                dashboardName: 'test-dashboardName'
                /* optional arguments */)▼

modifyReportingFilter

Modify a reporting filter.

Arguments

Argument Name	Type	Description
projectName	String	The name for the project that must be unique among all projects. (Required)
dashboardName	String	Unique name of the dashboard within the project. (Required)
reportingFilterName	String	The name of the reporting filter. (Required)
actualParameters	ActualParameter array	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	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.

Argument Name

Type

Description

projectName

String

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

dashboardName

String

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

reportingFilterName

String

The name of the reporting filter. (Required)

actualParameters

ActualParameter array

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

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.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyReportingFilter(
                projectName: 'test-projectName',
                dashboardName: 'test-dashboardName',
                reportingFilterName: 'test-reportingFilterName'
                /* optional arguments */)▼