API error messages
Introduction
IntroductionAccess tokenACLApplication dependencyApplicationApplication tierArchive connectorArtifactCatalogCatalog item runChange historyCI buildCI build detailCI configurationCI eventCI jobClusterComponentsCredentialCredential providerCustom filterDashboardDashboard columnDatabase configurationData retention policyDeployer applicationDevOps Insight data sourceDirectory providerDynamic environmentEmail configurationEmail notifierEnvironmentEnvironment tierGatewayGroupInstalling or upgrading remote agentsJobKerberos keytabMicroserviceMicroservice mappingMiscellaneousObjectObject tagsParameterPersonaPipelinePluginPlugin configurationPlugin catalogProcedureProcessProcess dependencyProcess stepProjectPropertyReleaseReportReporting filterReport object associationReport object attributeReport object typeResourceRolling deployScheduleSCM syncServerServer settings categoryService accounts for webhooksSessionSingle sign-on for OpenID ConnectSingle sign-on for SAMLSnapshotsTier mapTriggerUserUser emailUtility resourceWait dependencyWebhook resultWidgetWidget filter overrideWorkflowWorkflow definitionWork itemsWorkspaceZone
Perl API response and element glossary
Introduction
Examples
Troubleshooting
IntroductionaccesstokenaclaclentryactualparameterapplicationapplicationdependencyapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuildcibuilddetailciconfigurationcieventclustercomponentcredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectopenidconnectconfigurationoutputparameterpersonapersonacategorypersonapagepipelinepluginplugincatalogpluginconfigurationprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulescmsyncsearchfilterserverserversettingserversettingcategoryserviceaccountsessionsnapshotstagestatestatedefinitionstringresulttagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseraccesstokenuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

ReportObjectAssociation

2 minute readReference

createReportObjectAssociation

Creates 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 CD/RO.

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

Deletes 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

Retrieves 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

Retrieves all report object associations for the 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

Modifies 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 CD/RO.

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 */)
▼
reportingfilter
reportobjectattribute