DashboardColumn

createDashboardColumn

Create a dashboard column.

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)
column	String	The name of the dashboard column. (Required)
afterColumn	String	The name of the column after which the column should be placed. When creating the column if neither 'beforeColumn' nor 'afterColumn' are specified, then the column is added as the last column in the dashboard.
beforeColumn	String	The name of the column before which the column should be placed. When creating the column if neither 'beforeColumn' nor 'afterColumn' are specified, then the column is added as the last column in the dashboard.

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)

column

String

The name of the dashboard column. (Required)

afterColumn

String

The name of the column after which the column should be placed. When creating the column if neither 'beforeColumn' nor 'afterColumn' are specified, then the column is added as the last column in the dashboard.

beforeColumn

String

The name of the column before which the column should be placed. When creating the column if neither 'beforeColumn' nor 'afterColumn' are specified, then the column is added as the last column in the dashboard.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

deleteDashboardColumn

Delete a dashboard column.

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)
column	String	The name of the dashboard column. (Required)
deleteWidgets	Boolean	Whether to delete the widgets associated with the column that is being deleted. (Required)
addToColumn	String	The column to which the widgets associated with the column being deleted should be added. Required if deleteWidgets is false, and there are existing widgets in the column being deleted.

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)

column

String

The name of the dashboard column. (Required)

deleteWidgets

Boolean

Whether to delete the widgets associated with the column that is being deleted. (Required)

addToColumn

String

The column to which the widgets associated with the column being deleted should be added. Required if deleteWidgets is false, and there are existing widgets in the column being deleted.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

modifyDashboardColumn

Modify a dashboard column.

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)
column	String	The name of the dashboard column. (Required)
afterColumn	String	The name of the column after which the column should be placed. When creating the column if neither 'beforeColumn' nor 'afterColumn' are specified, then the column is added as the last column in the dashboard.
beforeColumn	String	The name of the column before which the column should be placed. When creating the column if neither 'beforeColumn' nor 'afterColumn' are specified, then the column is added as the last column in the dashboard.
newName	String	New name for an existing object that is being renamed.

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)

column

String

The name of the dashboard column. (Required)

afterColumn

String

The name of the column after which the column should be placed. When creating the column if neither 'beforeColumn' nor 'afterColumn' are specified, then the column is added as the last column in the dashboard.

beforeColumn

String

The name of the column before which the column should be placed. When creating the column if neither 'beforeColumn' nor 'afterColumn' are specified, then the column is added as the last column in the dashboard.

newName

String

New name for an existing object that is being renamed.

Usage

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


ElectricFlow ef = new ElectricFlow()

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