createDashboard
Create a new dashboard.
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) |
columns | String array | 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 | String | Layout to use for adding the widgets to the dashboard. |
type | String | Type of the dashboard. |
deleteDashboard
getDashboard
Retrieve a dashboard 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) |
includeDetails | Boolean | True to include details such as widget details (default is false) |
getDashboards
modifyDashboard
Modify a dashboard.
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) |
clearColumns | Boolean | Whether or not to clear columns for the dashboard. |
columns | String array | 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 | String | Layout to use for adding the widgets to the dashboard. |
newName | String | New name for an existing object that is being renamed. |
type | String | Type of the dashboard. |