ReportObjectAssociation commands

createReportObjectAssociation

Create a new report object association.

Arguments

Argument Name Type Description

reportObjectTypeName

String

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

associatedType

String

The name of the associated type. (Required)

description

String

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

required

Boolean

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

sourceFields

String

Comma-separated list of fields in the report object type that should match the fields in the target or associated object type in order to establish a correlation between the two types.

targetFields

String

Comma-separated list of fields in the associated object type that should match the fields in the source report object type in order to establish a correlation between the two types.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

deleteReportObjectAssociation

Delete a report object association.

Arguments

Argument Name Type Description

reportObjectTypeName

String

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

associatedType

String

The name of the associated type. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteReportObjectAssociation(
                reportObjectTypeName: 'test-reportObjectTypeName',
                associatedType: 'test-associatedType')

getReportObjectAssociation

Retrieve a report object association by associated type.

Arguments

Argument Name Type Description

reportObjectTypeName

String

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

associatedType

String

The name of the associated type. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getReportObjectAssociation(
                reportObjectTypeName: 'test-reportObjectTypeName',
                associatedType: 'test-associatedType')

getReportObjectAssociations

all report object associations for the pointed report object type

Arguments

Argument Name Type Description

reportObjectTypeName

String

Report object type for which this association is defined. The association 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.getReportObjectAssociations(
                reportObjectTypeName: 'test-reportObjectTypeName')

modifyReportObjectAssociation

Modify a report object association.

Arguments

Argument Name Type Description

reportObjectTypeName

String

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

associatedType

String

The name of the associated type. (Required)

description

String

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

required

Boolean

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

sourceFields

String

Comma-separated list of fields in the report object type that should match the fields in the target or associated object type in order to establish a correlation between the two types.

targetFields

String

Comma-separated list of fields in the associated object type that should match the fields in the source report object type in order to establish a correlation between the two types.

Usage

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


ElectricFlow ef = new ElectricFlow()

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