modifyDashboard

On this page
Back to index

Summary

Modifies a dashboard.
projectName
Stringrequired
The name for the project that must be unique among all projects.
dashboardName
Stringrequired
Unique name of the dashboard within the project.
clearColumns
Booleanoptional
Whether or not to clear columns for the dashboard.
columns
Array<Unknown>optional
List of the columns to display for the dashboard of type COMMAND_CENTER.
customize
Booleanoptional
Set to true to create a custom copy of the out-of-the-box Release Command Center dashboard.
description
Stringoptional
Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
layout
Stringoptional
Layout to use for adding the widgets to the dashboard.
newName
Stringoptional
The new name for an existing object that is being renamed.
type
Stringoptional
Type of the dashboard.
Possible values: "COMMAND_CENTER", "STANDARD"

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow import com.electriccloud.client.groovy.models.* ElectricFlow ef = new ElectricFlow() def result = ef.modifyDashboard( projectName: "test-projectName", dashboardName: "test-dashboardName" /* optional arguments */ )