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 type

2 minute readReference

createReportObjectType

Creates a new report object type.

Arguments

Argument Name Type Description

reportObjectTypeName

String

(Required) Unique name of the report object type.

colorCode

String

The color associated with the report object type, in hexcode format #rrggbb.

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

displayName

String

Display name of report object type.

sourceType

String

Category of the third-party tool that data for the given report object type is obtained from.

sourceTypeDescription

String

Description of the category of the third-party tool that may be displayed on the UI.

storagePattern

ReportObjectTypeStoragePattern

Storage pattern for report object type.

Positional arguments

reportObjectTypeName

Usage

ec-perl

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

ectool

ectool createReportObjectType reportObjectTypeName [optionals]
▼

deleteReportObjectType

Deletes a report object type.

Arguments

Argument Name Type Description

reportObjectTypeName

String

(Required) Unique name of the report object type.

Positional arguments

reportObjectTypeName

Usage

ec-perl

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

ectool

ectool deleteReportObjectType reportObjectTypeName
▼

getReportObjectType

Retrieves a report object type by name.

Arguments

Argument Name Type Description

reportObjectTypeName

String

(Required) Unique name of the report object type.

includeDetails

Boolean

True to include details such as report object associations details (default is false).

Positional arguments

reportObjectTypeName

Usage

ec-perl

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

ectool

ectool getReportObjectType reportObjectTypeName [optionals]
▼

getReportObjectTypes

Retrieves all report object types in a project.

Arguments

Argument Name Type Description

includeDetails

Boolean

True to include details such as report object associations details (default is false).

Positional arguments

None.

Usage

ec-perl

$cmdr->getReportObjectTypes({<optionals>});
▼

ectool

ectool getReportObjectTypes [optionals]
▼

modifyReportObjectType

Modifies a report object type.

Arguments

Argument Name Type Description

reportObjectTypeName

String

(Required) Unique name of the report object type.

colorCode

String

The color associated with the report object type, in hexcode format #rrggbb.

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

displayName

String

Display name of report object type.

newName

String

New name for an existing object that is being renamed.

sourceType

String

Category of the third-party tool that data for the given report object type is obtained from.

sourceTypeDescription

String

Description of the category of the third-party tool that may be displayed on the UI.

storagePattern

ReportObjectTypeStoragePattern

Storage pattern for report object type.

Positional arguments

reportObjectTypeName

Usage

ec-perl

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

ectool

ectool modifyReportObjectType reportObjectTypeName [optionals]
▼
Report object attribute
Resource