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. |
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.
getReportObjectAttribute
Retrieve a report object attribute by name.
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) |
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 |
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
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. |
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 */)