createDashboard
Creates a new dashboard.
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. |
columns |
Collection |
List of the columns to display for the dashboard of type COMMAND_CENTER. |
description |
String |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
layout |
DashboardLayout |
Layout to use for adding the widgets to the dashboard. |
type |
DashboardType |
Type of the dashboard. |
deleteDashboard
getDashboard
Retrieves a dashboard 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. |
includeDetails |
Boolean |
True to include details such as widget details (default is false). |
modifyDashboard
Modifies a dashboard.
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. |
clearColumns |
Boolean |
Whether or not to clear columns for the dashboard. |
columns |
Collection |
List of the columns to display for the dashboard of type COMMAND_CENTER. |
customize |
Boolean |
Set to true to create a custom copy of the out-of-the-box Release Command Center dashboard. |
description |
String |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
layout |
DashboardLayout |
Layout to use for adding the widgets to the dashboard. |
newName |
String |
The new name for an existing object that is being renamed. |
type |
DashboardType |
Type of the dashboard. |