ReportObjectAttribute

createReportObjectAttribute

Create a new report object attribute.

Arguments

Argument Name	Type	Description
reportObjectTypeName	String	Report object type for which this attribute is defined. The attribute is owned by the specified report object type. (Required)
reportObjectAttributeName	String	The name of the report object attribute. (Required)
description	String	Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
displayName	String	Display name of report object attribute.
enumerationValues	String	Enumeration values of report object attribute.
required	Boolean	Whether the association between the report object type and attribute is always present.
type	String	Type of report object attribute.

Argument Name

Type

Description

reportObjectTypeName

String

Report object type for which this attribute is defined. The attribute is owned by the specified report object type. (Required)

reportObjectAttributeName

String

The name of the report object attribute. (Required)

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

displayName

String

Display name of report object attribute.

enumerationValues

String

Enumeration values of report object attribute.

required

Boolean

Whether the association between the report object type and attribute is always present.

type

String

Type of report object attribute.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.createReportObjectAttribute(
                reportObjectTypeName: 'test-reportObjectTypeName',
                reportObjectAttributeName: 'test-reportObjectAttributeName'
                /* optional arguments */)▼

deleteReportObjectAttribute

Delete a report object attribute.

Arguments

Argument Name	Type	Description
reportObjectTypeName	String	Report object type for which this attribute is defined. The attribute is owned by the specified report object type. (Required)
reportObjectAttributeName	String	The name of the report object attribute. (Required)

Argument Name

Type

Description

reportObjectTypeName

String

Report object type for which this attribute is defined. The attribute is owned by the specified report object type. (Required)

reportObjectAttributeName

String

The name of the report object attribute. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteReportObjectAttribute(
                reportObjectTypeName: 'test-reportObjectTypeName',
                reportObjectAttributeName: 'test-reportObjectAttributeName')▼

getReportObjectAttribute

Retrieve a report object attribute by name.

Arguments

Argument Name	Type	Description
reportObjectTypeName	String	Report object type for which this attribute is defined. The attribute is owned by the specified report object type. (Required)
reportObjectAttributeName	String	The name of the report object attribute. (Required)

Argument Name

Type

Description

reportObjectTypeName

String

Report object type for which this attribute is defined. The attribute is owned by the specified report object type. (Required)

reportObjectAttributeName

String

The name of the report object attribute. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getReportObjectAttribute(
                reportObjectTypeName: 'test-reportObjectTypeName',
                reportObjectAttributeName: 'test-reportObjectAttributeName')▼

getReportObjectAttributeValues

Retrieve the report object attribute values from DevOps Insight Server

Arguments

Argument Name	Type	Description
reportObjectTypeName	String	Report object type for which this attribute is defined. The attribute is owned by the specified report object type. (Required)
reportObjectAttributeName	String	The name of the report object attribute. (Required)
actualParameters	ActualParameter array	Parameters passed as arguments to the reporting filter.
dashboardName	String	The name of the dashboard.
dashboardProjectName	String	The name of the dashboard project.
filters	Filter array	Filters
fromIndex	Integer	The index of the first value to be retrieved, numbered from 0
maxValues	Integer	The maximum number of values to return at a time
reportingFilterName	String	The name of the reporting filter.
valueStartsWith	String	String that the values begin with

Argument Name

Type

Description

reportObjectTypeName

String

Report object type for which this attribute is defined. The attribute is owned by the specified report object type. (Required)

reportObjectAttributeName

String

The name of the report object attribute. (Required)

actualParameters

ActualParameter array

Parameters passed as arguments to the reporting filter.

dashboardName

String

The name of the dashboard.

dashboardProjectName

String

The name of the dashboard project.

filters

Filter array

Filters

fromIndex

Integer

The index of the first value to be retrieved, numbered from 0

maxValues

Integer

The maximum number of values to return at a time

reportingFilterName

String

The name of the reporting filter.

valueStartsWith

String

String that the values begin with

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getReportObjectAttributeValues(
                reportObjectTypeName: 'test-reportObjectTypeName',
                reportObjectAttributeName: 'test-reportObjectAttributeName'
                /* optional arguments */)▼

getReportObjectAttributes

All report object attributes for the pointed report object type.

Arguments

Argument Name	Type	Description
reportObjectTypeName	String	Report object type for which this attribute is defined. The attribute is owned by the specified report object type. (Required)

Argument Name

Type

Description

reportObjectTypeName

String

Report object type for which this attribute is defined. The attribute is owned by the specified report object type. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

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

modifyReportObjectAttribute

Modify a report object attribute.

Arguments

Argument Name	Type	Description
reportObjectTypeName	String	Report object type for which this attribute is defined. The attribute is owned by the specified report object type. (Required)
reportObjectAttributeName	String	The name of the report object attribute. (Required)
description	String	Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
displayName	String	Display name of report object attribute.
enumerationValues	String	Enumeration values of report object attribute.
newName	String	New name for an existing object that is being renamed.
required	Boolean	Whether the association between the report object type and attribute is always present.
type	String	Type of report object attribute.

Argument Name

Type

Description

reportObjectTypeName

String

Report object type for which this attribute is defined. The attribute is owned by the specified report object type. (Required)

reportObjectAttributeName

String

The name of the report object attribute. (Required)

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

displayName

String

Display name of report object attribute.

enumerationValues

String

Enumeration values of report object attribute.

newName

String

New name for an existing object that is being renamed.

required

Boolean

Whether the association between the report object type and attribute is always present.

type

String

Type of report object attribute.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyReportObjectAttribute(
                reportObjectTypeName: 'test-reportObjectTypeName',
                reportObjectAttributeName: 'test-reportObjectAttributeName'
                /* optional arguments */)▼