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

4 minute readReference

createReport

Creates a new report.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

reportName

String

(Required) The name of the report.

definition

String

The Elasticsearch query definition to use for retrieving report data.

description

String

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

parameters

String

Input parameters in JSON format accepted by the report definition.

reportObjectTypeForSourceType

String

The report object type name to use to determine the source type for the report. Set this if the sourceType of the report’s reportObjectType is different from the actual source of the report data.

reportObjectTypeName

String

Report object type name.

reportQuery

String

The report query in JSON format. It will be translated to the Elasticsearch query definition when retrieving report data.

title

String

The title of report.

uri

String

An advanced mode option for identifying the Elasticsearch URI to use for retrieving report data. By default, the reportObjectTypeName argument will be used to construct the URI based on the Elasticsearch index for the report object, e.g., ef-deployment-*/_search?pretty.

Positional arguments

projectName, reportName

Usage

ec-perl

$cmdr->createReport(<projectName>, <reportName>, {<optionals>});
▼

ectool

ectool createReport projectName reportName [optionals]
▼

deleteReport

Deletes a report.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

reportName

String

(Required) The name of the report.

Positional arguments

projectName, reportName

Usage

ec-perl

$cmdr->deleteReport(<projectName>, <reportName>);
▼

ectool

ectool deleteReport projectName reportName
▼

getReport

Retrieves a report by name.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

reportName

String

(Required) The name of the report.

Positional arguments

projectName, reportName

Usage

ec-perl

$cmdr->getReport(<projectName>, <reportName>);
▼

ectool

ectool getReport projectName reportName
▼

getReports

Retrieves all reports in a project.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

Positional arguments

projectName

Usage

ec-perl

$cmdr->getReports(<projectName>);
▼

ectool

ectool getReports projectName
▼

modifyReport

Modifies a report.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

reportName

String

(Required) The name of the report.

definition

String

The Elasticsearch query definition to use for retrieving report data.

description

String

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

newName

String

The new name for an existing object that is being renamed.

parameters

String

Input parameters in JSON format accepted by the report definition.

reportObjectTypeForSourceType

String

The report object type name to use to determine the source type for the report. Set this if the sourceType of the report’s reportObjectType is different from the actual source of the report data.

reportObjectTypeName

String

Report object type name.

reportQuery

String

The report query in JSON format. It will be translated to the Elasticsearch query definition when retrieving report data.

title

String

The title of report.

uri

String

An advanced mode option for identifying the Elasticsearch URI to use for retrieving report data. By default, the reportObjectTypeName argument will be used to construct the URI based on the Elasticsearch index for the report object, e.g., ef-deployment-*/_search?pretty.

Positional arguments

projectName, reportName

Usage

ec-perl

$cmdr->modifyReport(<projectName>, <reportName>, {<optionals>});
▼

ectool

ectool modifyReport projectName reportName [optionals]
▼

runLicenseReport

Retrieves the license information details for the specified controller or the operations center.

When a CloudBees CI or operations center instance has several licenses, the one that applies is that with the greatest timestamp (timestamp in the event sent from CloudBees CI). There can be only one license in existence per controller URL at one time.

Arguments

Argument Name Type Description

instances

Collection

Instance identifiers.

Positional arguments

None.

Usage

ec-perl

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

ectool

ectool runLicenseReport [optionals]
▼

runReport

Retrieves data for the requested report from the reporting system.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

reportName

String

(Required) The name of the report.

actualParameters

Map

Parameters passed as arguments to the report.

dashboardName

String

The name of the dashboard that the widget using the report belongs to.

dashboardProjectName

String

Set if the dashboard is in a different project than the report.

definition

String

The Elasticsearch query definition to use for retrieving report data.

filters

Collection

A list of zero or more filter criteria definitions used to define objects to find.

previewMode

Boolean

Whether the report should be run in preview mode returning a small result sample.

reportObjectTypeName

String

Report object type name.

reportQuery

String

The report query in JSON format. It will be translated to the Elasticsearch query definition when retrieving report data.

uri

String

An advanced mode option for identifying the Elasticsearch URI to use for retrieving report data. By default, the reportObjectTypeName argument will be used to construct the URI based on the Elasticsearch index for the report object, e.g., ef-deployment-*/_search?pretty.

widgetName

String

The name of the widget using the report.

Positional arguments

projectName, reportName

Usage

ec-perl

$cmdr->runReport(<projectName>, <reportName>, {<optionals>});
▼

ectool

ectool runReport projectName reportName [optionals]
▼

runUserReport

This report produces a list of users based on the applied time filter. If the selected time period is undefined, it selects all users since the license started. A new user entry appears in the report when:

  • The user has signed in to the CloudBees CI system in the selected period.

  • The user has committed in the CloudBees CI system in the selected period.

Arguments

Argument Name Type Description

actualParameters

Map

Parameters passed as arguments to the report.

beginDate

String

Start date.

endDate

String

End date.

filters

Collection

A list of zero or more filter criteria definitions used to define objects to find.

format

ResponseFormat

Response format.

instances

Collection

Instance identifiers.

status

EmailStatus

User verification status.

tool

ToolType

Tool type.

Positional arguments

None.

Usage

ec-perl

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

ectool

ectool runUserReport [optionals]
▼

sendReportingData

Sends data to the DevOps Insight server.

Arguments

Argument Name Type Description

reportObjectTypeName

String

(Required) The name of the report object for which the data(payload) is being sent to the DevOps Insight server.

payload

String

(Required) The payload with the attribute values for the report object in JSON text format.

validate

Boolean

Whether to validate the fields in the payload based on the attributes defined for the report object type.

Positional arguments

reportObjectTypeName, payload

Usage

ec-perl

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

ectool

ectool sendReportingData reportObjectTypeName payload [optionals]
▼
Release
Reporting filter