ReportObjectType commands

createReportObjectType

Create a new report object type.

Arguments

Argument Name Type Description

reportObjectTypeName

String

Unique name of the report object type. (Required)

colorCode

String

The color associated with the report object type, in hexcode format '#rrggbb'.

description

String

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

displayName

String

Display name of report object type.

sourceType

String

Category of the third-party tool that data for the given report object type is obtained from.

sourceTypeDescription

String

Description of the category of the third-party tool that may be displayed on the UI.

storagePattern

String

Storage pattern for report object type.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.createReportObjectType(
                reportObjectTypeName: 'test-reportObjectTypeName'
                /* optional arguments */)

deleteReportObjectType

Delete a report object type.

Arguments

Argument Name Type Description

reportObjectTypeName

String

Unique name of the report object type. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteReportObjectType(
                reportObjectTypeName: 'test-reportObjectTypeName')

getReportObjectType

Retrieve a report object type by name.

Arguments

Argument Name Type Description

reportObjectTypeName

String

Unique name of the report object type. (Required)

includeDetails

Boolean

True to include details such as report object associations details (default is false)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getReportObjectType(
                reportObjectTypeName: 'test-reportObjectTypeName'
                /* optional arguments */)

getReportObjectTypes

Retrieve all report object types in a project.

Arguments

Argument Name Type Description

includeDetails

Boolean

True to include details such as report object associations details (default is false)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getReportObjectTypes(
                /* optional arguments */)

modifyReportObjectType

Modify a report object type.

Arguments

Argument Name Type Description

reportObjectTypeName

String

Unique name of the report object type. (Required)

colorCode

String

The color associated with the report object type, in hexcode format '#rrggbb'.

description

String

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

displayName

String

Display name of report object type.

newName

String

New name for an existing object that is being renamed.

sourceType

String

Category of the third-party tool that data for the given report object type is obtained from.

sourceTypeDescription

String

Description of the category of the third-party tool that may be displayed on the UI.

storagePattern

String

Storage pattern for report object type.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyReportObjectType(
                reportObjectTypeName: 'test-reportObjectTypeName'
                /* optional arguments */)