Report object attribute

createReportObjectAttribute

Creates a new report object attribute.

Arguments

Argument Name	Type	Description
reportObjectTypeName	String	(Required) Report object type for which this attribute is defined. The attribute is owned by the specified report object type.
reportObjectAttributeName	String	(Required) The name of the report object attribute.
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	ReportObjectAttributeType	Type of report object attribute.

Argument Name

Type

Description

reportObjectTypeName

String

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

reportObjectAttributeName

String

(Required) The name of the report object attribute.

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

ReportObjectAttributeType

Type of report object attribute.

Positional arguments

reportObjectTypeName, reportObjectAttributeName

Usage

ec-perl

$cmdr->createReportObjectAttribute(<reportObjectTypeName>, <reportObjectAttributeName>, {<optionals>});▼

ectool

ectool createReportObjectAttribute reportObjectTypeName,  reportObjectAttributeName, [optionals]▼

deleteReportObjectAttribute

Deletes a report object attribute.

Arguments

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

Argument Name

Type

Description

reportObjectTypeName

String

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

reportObjectAttributeName

String

(Required) The name of the report object attribute.

Positional arguments

reportObjectTypeName, reportObjectAttributeName

Usage

ec-perl

$cmdr->deleteReportObjectAttribute(<reportObjectTypeName>, <reportObjectAttributeName>);▼

ectool

ectool deleteReportObjectAttribute reportObjectTypeName,  reportObjectAttributeName▼

getReportObjectAttribute

Retrieves a report object attribute by name.

Arguments

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

Argument Name

Type

Description

reportObjectTypeName

String

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

reportObjectAttributeName

String

(Required) The name of the report object attribute.

Positional arguments

reportObjectTypeName, reportObjectAttributeName

Usage

ec-perl

$cmdr->getReportObjectAttribute(<reportObjectTypeName>, <reportObjectAttributeName>);▼

ectool

ectool getReportObjectAttribute reportObjectTypeName,  reportObjectAttributeName▼

getReportObjectAttributes

Retrieves all report object attributes for the report object type.

Arguments

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

Argument Name

Type

Description

reportObjectTypeName

String

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

Positional arguments

reportObjectTypeName

Usage

ec-perl

$cmdr->getReportObjectAttributes(<reportObjectTypeName>);▼

ectool

ectool getReportObjectAttributes reportObjectTypeName▼

getReportObjectAttributeValues

Retrieves possible values for the specified reportObjectAttributeName object. Contents of the result set varies based on the type of reportObjectAttributeName:

For enumerated types, all possible types are returned.
For string types, all values in the CloudBees Analytics server are returned.
For Boolean types, the Boolean values in the CloudBees Analytics server are returned.

Arguments

Argument Name	Type	Description
reportObjectTypeName	String	(Required) Report object type for which this attribute is defined. The attribute is owned by the specified report object type.
reportObjectAttributeName	String	(Required) The name of the report object attribute.
actualParameters	Map	Parameters passed as arguments to the reporting filter.
dashboardName	String	The name of the dashboard.
dashboardProjectName	String	The name of the dashboard project.
filters	Collection	A list of zero or more filter criteria definitions used to define objects to find.
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

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

reportObjectAttributeName

String

(Required) The name of the report object attribute.

actualParameters

Map

Parameters passed as arguments to the reporting filter.

dashboardName

String

The name of the dashboard.

dashboardProjectName

String

The name of the dashboard project.

filters

Collection

A list of zero or more filter criteria definitions used to define objects to find.

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.

Positional arguments

reportObjectTypeName, reportObjectAttributeName

Usage

ec-perl

$cmdr->getReportObjectAttributeValues(<reportObjectTypeName>, <reportObjectAttributeName>, {<optionals>});▼

ectool

ectool getReportObjectAttributeValues reportObjectTypeName,  reportObjectAttributeName, [optionals]▼

modifyReportObjectAttribute

Modifies a report object attribute.

Arguments

Argument Name	Type	Description
reportObjectTypeName	String	(Required) Report object type for which this attribute is defined. The attribute is owned by the specified report object type.
reportObjectAttributeName	String	(Required) The name of the report object attribute.
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	The 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	ReportObjectAttributeType	Type of report object attribute.

Argument Name

Type

Description

reportObjectTypeName

String

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

reportObjectAttributeName

String

(Required) The name of the report object attribute.

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

The 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

ReportObjectAttributeType

Type of report object attribute.

Positional arguments

reportObjectTypeName, reportObjectAttributeName

Usage

ec-perl

$cmdr->modifyReportObjectAttribute(<reportObjectTypeName>, <reportObjectAttributeName>, {<optionals>});▼

ectool

ectool modifyReportObjectAttribute reportObjectTypeName,  reportObjectAttributeName, [optionals]▼