API error messages
Introduction
IntroductionAccess tokenACLApplication dependencyApplicationApplication tierArchive connectorArtifactCatalogChange 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
IntroductionaccesstokenaclaclentryactualparameterapplicationapplicationdependencyapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcibuildcibuilddetailciconfigurationcieventclustercompliancecomponentcredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectopenidconnectconfigurationoutputparameterpersonapersonacategorypersonapagepipelinepluginplugincatalogpluginconfigurationprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulescmsyncsearchfilterserverserversettingserversettingcategoryserviceaccountsessionsnapshotstagestatestatedefinitionstringresulttagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseraccesstokenuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

Report object association

2 minute readReference

createReportObjectAssociation

Creates a new report object association.

Arguments

Argument Name Type Description

reportObjectTypeName

String

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

associatedType

String

(Required) The name of the associated type.

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.

Positional arguments

reportObjectTypeName, associatedType

Usage

ec-perl

$cmdr->createReportObjectAssociation(<reportObjectTypeName>, <associatedType>, {<optionals>});
▼

ectool

ectool createReportObjectAssociation reportObjectTypeName associatedType [optionals]
▼

deleteReportObjectAssociation

Deletes a report object association.

Arguments

Argument Name Type Description

reportObjectTypeName

String

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

associatedType

String

(Required) The name of the associated type.

Positional arguments

reportObjectTypeName, associatedType

Usage

ec-perl

$cmdr->deleteReportObjectAssociation(<reportObjectTypeName>, <associatedType>);
▼

ectool

ectool deleteReportObjectAssociation reportObjectTypeName associatedType
▼

getReportObjectAssociation

Retrieves a report object association by associated type.

Arguments

Argument Name Type Description

reportObjectTypeName

String

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

associatedType

String

(Required) The name of the associated type.

Positional arguments

reportObjectTypeName, associatedType

Usage

ec-perl

$cmdr->getReportObjectAssociation(<reportObjectTypeName>, <associatedType>);
▼

ectool

ectool getReportObjectAssociation reportObjectTypeName associatedType
▼

getReportObjectAssociations

Retrieves all report object associations for the report object type.

Arguments

Argument Name Type Description

reportObjectTypeName

String

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

Positional arguments

reportObjectTypeName

Usage

ec-perl

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

ectool

ectool getReportObjectAssociations reportObjectTypeName
▼

modifyReportObjectAssociation

Modifies a report object association.

Arguments

Argument Name Type Description

reportObjectTypeName

String

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

associatedType

String

(Required) The name of the associated type.

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.

Positional arguments

reportObjectTypeName, associatedType

Usage

ec-perl

$cmdr->modifyReportObjectAssociation(<reportObjectTypeName>, <associatedType>, {<optionals>});
▼

ectool

ectool modifyReportObjectAssociation reportObjectTypeName associatedType [optionals]
▼
Reporting filter
Report object attribute