Flow API guide
IntroductionRoadmap to CloudBees Flow APIsUsing the CloudBees Flow Perl APICloudBees Flow Perl API Response and Element GlossaryUsing the CloudBees Flow RESTful APIUsing the Flow DSLUsing the CloudBees Flow Groovy APIUsing JRubyCloudBees Flow Error MessagesCloudBees Flow Perl API Response and Element Glossary
Perl API Commands
IntroductionACL ManagementApplication DependencyApplicationsApplication Tier Artifact ManagementCatalogsChange HistoryComponentsCredential ManagementCustom FiltersDatabase ConfigurationData RetentionDevOps InsightDirectory Provider ManagementDynamic EnvironmentsEmail Configuration ManagementEmail Notifier ManagementEnvironmentEnvironment TierGateway and Zone ManagementInstalling or Upgrading Remote AgentsJob ManagementMicroservicesObject TagsParameter ManagementPersonasPipelines and ReleasesPlugin ManagementProcedure ManagementProcessProcess DependencyProcess StepProject ManagementProperty ManagementResource ManagementRolling DeploySchedule ManagementServer ManagementSingle Sign-OnSnapshotsTier MapUser and Group ManagementWait DependenciesWebhhook ManagementWorkflow Definition ManagementWorkflow ManagementWork ItemsWorkspace ManagementMiscellaneous Management
Groovy API guide
IntroductionExamples
Groovy API commands
Introductionaclaclentryactualparameteractualparametersappdepapplicationappservicemappingapptierarchiveconnectorartifactartifactversioncatalogcatalogitemclustercomponentcontainercredentialdashboarddashboardcolumndataretentiondeployerappdeployerconfdeployerservicedeployhistorydirproviderdoisdatasourceemailconfigemailnotifierentitychangeenvinvenvironmentenvmapenvtemeplateenvtemptierenvtemptiermapenvtemptiermappingenvtemptierresourcemappingenvtierenvvareventsubflowruntimeformaloutparamformalparamgategatewaygrouphookjobjobstepkerberoskeytablicensenoteobjectoutputparampersonapersonacatpersonapagepipelinepipelinerunnamepluginportprocdependprocedureprocessprocstepprojectpropertyreleasereportreportfilterreportobjassocreportobjattrreportobjtyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartrollingrundiscoverysamlidentitysamlserviceschedulesearchfilterserverserviceserviceacctserviceclusterservicedepservicemapsessionsnapshotstagestatestatedeftagtasktiermaptiermappingtransdeftransitionuserutilitywaitdependwidgetwidgetfilteroverrideworkdefworkflowworkitemworkspacezone
Groovy API argument models

Widget commands

5 minute readReference

createWidget

Create a new widget.

Arguments

Argument NameTypeDescription

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 dashboard widget. (Required)

actualParameters

actualParameter array

Actual parameter values for the parameters defined on the widget’s report.

afterWidget

String

The name of the widget after which this widget should be placed.

attributeDataTypes

attributeDataType array

Widget parameters used by UI to control data types of attributes

attributePaths

attributePath array

Widget parameters used by UI to control paths of attributes

beforeWidget

String

The name of the widget before which this widget should be placed.

colorRanges

String

The JSON with color ranges definition for the widget.

colors

color array

Color map used when rendering the widget. The usage of the color map depends on the widget’s visualization type.

column

String

The column in a COMMANDER_CENTER dashboard that the widget belongs to. Required for a COMMANDER_CENTER dashboard widget unless the widget section is 'SUMMARY' in which case it is not applicable.

description

String

Comment text describing this object that is not interpreted at all by CloudBees Flow.

iconUrl

String

The icon to display for the widget.

linkParameters

linkParameter array

Widget parameters used by UI to construct the drill-down link for the widget.

linkTarget

String

Determines the page to navigate to when the user drills down through the dashboard widget.

orderIndex

Integer

Specifies the relative display order for the widget

phase

String

Deprecated: Use 'column' instead
The column in a COMMANDER_CENTER dashboard that the widget belongs to. Required for a COMMANDER_CENTER dashboard widget unless the widget section is 'SUMMARY' in which case it is not applicable.

reportName

String

Name of an existing report backing the widget

reportProjectName

String

Set if the report is in a different project than the dashboard.

section

String

The section of a COMMAND_CENTER dashboard to display the widget in. Applicable for a COMMANDER_CENTER dashboard widget.

title

String

The title to display for the widget. If not set, use the report title.

visualization

String

Type of visualization data in the widget.

visualizationProperties

visualizationProperty array #

Properties or settings used by the widget’s visualization type.

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.apis.model.*


ElectricFlow ef = new ElectricFlow()

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

deleteWidget

Delete a widget.

Arguments

Argument NameTypeDescription

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 dashboard widget. (Required)

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.apis.model.*


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteWidget(
                projectName: 'test-projectName',
                dashboardName: 'test-dashboardName',
                widgetName: 'test-widgetName')

getWidget

Retrieve a dashboard widget by name.

Arguments

Argument NameTypeDescription

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 dashboard widget. (Required)

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.apis.model.*


ElectricFlow ef = new ElectricFlow()

def result = ef.getWidget(
                projectName: 'test-projectName',
                dashboardName: 'test-dashboardName',
                widgetName: 'test-widgetName')

getWidgets

Retrieve all dashboard widgets for dashboard.

Arguments

Argument NameTypeDescription

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)

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.apis.model.*


ElectricFlow ef = new ElectricFlow()

def result = ef.getWidgets(
                projectName: 'test-projectName',
                dashboardName: 'test-dashboardName')

modifyWidget

Modify a widget.

Arguments

Argument NameTypeDescription

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 dashboard widget. (Required)

actualParameters

actualParameter array

Actual parameter values for the parameters defined on the widget’s report.

afterWidget

String

The name of the widget after which this widget should be placed.

attributeDataTypes

attributeDataType array

Widget parameters used by UI to control data types of attributes

attributePaths

attributePath array

Widget parameters used by UI to control paths of attributes

beforeWidget

String

The name of the widget before which this widget should be placed.

clearAttributeDataTypes

Boolean

Whether or not to clear attribute data types for the widget.

clearAttributePaths

Boolean

Whether or not to clear attribute paths for the widget.

clearColors

Boolean

Whether or not to clear color for the widget.

clearLinkParameters

Boolean

Whether or not to clear link parameters for the widget.

clearVisualizationProperties

Boolean

Whether or not to clear visualization properties for the widget.

colorRanges

String

The JSON with color ranges definition for the widget.

colors

color array

Color map used when rendering the widget. The usage of the color map depends on the widget’s visualization type.

column

String

The column in a COMMANDER_CENTER dashboard that the widget belongs to. Required for a COMMANDER_CENTER dashboard widget unless the widget section is 'SUMMARY' in which case it is not applicable.

description

String

Comment text describing this object that is not interpreted at all by CloudBees Flow.

iconUrl

String

The icon to display for the widget.

linkParameters

linkParameter array

Widget parameters used by UI to construct the drill-down link for the widget.

linkTarget

String

Determines the page to navigate to when the user drills down through the dashboard widget.

newName

String

New name for an existing object that is being renamed.

orderIndex

Integer

Specifies the relative display order for the widget

phase

String

Deprecated: Use 'column' instead
The column in a COMMANDER_CENTER dashboard that the widget belongs to. Required for a COMMANDER_CENTER dashboard widget unless the widget section is 'SUMMARY' in which case it is not applicable.

reportName

String

Name of an existing report backing the widget

reportProjectName

String

Set if the report is in a different project than the dashboard.

section

String

The section of a COMMAND_CENTER dashboard to display the widget in. Applicable for a COMMANDER_CENTER dashboard widget.

title

String

The title to display for the widget. If not set, use the report title.

visualization

String

Type of visualization data in the widget.

visualizationProperties

visualizationProperty array #

Properties or settings used by the widget’s visualization type.

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.apis.model.*


ElectricFlow ef = new ElectricFlow()

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

moveWidget

Move a widget within a dashboard.

Arguments

Argument NameTypeDescription

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 dashboard widget. (Required)

beforeWidget

String

The name of the widget before which the widget should be placed. Blank to move the widget to the last position in the specified section or phase.

column

String

The column in a COMMANDER_CENTER dashboard to display the widget in. Applicable only for COMMAND_CENTER type of dashboard.

section

String

The section of a dashboard to display the widget in. Applicable only for COMMAND_CENTER type of dashboard. Required if column is not set.

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.apis.model.*


ElectricFlow ef = new ElectricFlow()

def result = ef.moveWidget(
                projectName: 'test-projectName',
                dashboardName: 'test-dashboardName',
                widgetName: 'test-widgetName'
                /* optional arguments */)
waitdepend
widgetfilteroverride