Introduction
Using JRuby
API error messages
API command line access
Using DSL
IntroductionGetting started with DSLGenerating DSL scriptsDSL automation as codeDSL editorsTroubleshooting and FAQs
DSL method reference
Using the RESTful API
Using the Perl API
Perl API reference
IntroductionACL managementApplication dependencyApplicationsApplication tier Artifact managementCatalogsChange historyCI build detailCI configurationCI jobsComponentsCredential managementCustom filtersDatabase configurationData retentionCloudBees AnalyticsDirectory provider managementDynamic environmentsEmail configuration managementEmail notifier managementEnvironmentEnvironment tierGateway and zone managementInstalling or upgrading remote agentsJob managementMicroservicesObject tagsParameter managementPersonasPipelines and releasesPlugin managementProcedure managementProcessProcess dependencyProcess stepProject managementProperty managementResource managementRolling deploySchedule managementServer managementSingle sign-onSnapshotsTier mapUser and group managementWait dependenciesWebhhook managementWorkflow definition managementWorkflow managementWork itemsWorkspace managementMiscellaneous management
Perl API response and element glossary
Using the Groovy API
IntroductionExamplesTroubleshooting
Groovy API reference
IntroductionaccesstokenaclaclentryactualparameteractualparametersapplicationapplicationdependencyapplicationservicemappingapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuildcibuilddetailciconfigurationcieventclustercomponentcontainercredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeployerservicedeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmentmapenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvironmentvariableenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectoutputparameterpersonapersonacategorypersonapagepipelinepluginpluginconfigurationportprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulesearchfilterserverserversettingserversettingcategoryserviceaccountserviceserviceclustermappingservicedependencyservicemapdetailsessionsnapshotstagestatestatedefinitiontagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

CloudBees Analytics

30 minute readReference
On this page

Dashboard Commands

createDashboard

Creates a new dashboard for the specified project.

You must specify projectName and dashboardName.

ArgumentsDescriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

dashboardName

Unique name of the dashboard within the projectName.

Argument Type: String

columns

(Optional) List of the columns to display for the dashboard of type COMMAND_CENTER.

Argument Type: String

description

(Optional) Comment text describing this object; not interpreted at all by CloudBees CD/RO .

Argument Type: String

layout

(Optional) Layout to use for adding the widgets to the dashboard. Use FLOW.

Argument Type: DashboardLayout

phases

(Optional) List of the phases to display for the dashboard of type COMMAND_CENTER.

This argument is deprecated and is replaced by columns.

Argument Type: String

type

(Optional) Type of dashboard. Allowed types: COMMAND_CENTER or STANDARD. If not specified, STANDARD is used.

Argument Type: DashboardType

Positional arguments

projectName, dashboardName

Response

Returns a dashboard object.

ec-perl

syntax: $<object>->createDashboard(<projectName>, <dashboardName>, {<optionals>});

Example
$ec->createDashboard("Default", "Executive Overview", {description => "Activity at a glance"});

ectool

syntax: ectool createDashboard <projectName> <dashboardName> [optionals]

Example
ectool createDashboard Default "Executive Overview"

Back to top

createDashboardColumn

Creates a dashboard column in a Command Center type of dashboard.

You must specify projectName, dashboardName, and column.

ArgumentsDescriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

dashboardName

Unique name of the dashboard within the projectName.

Argument Type: String

column

Name of the dashboard column.

Argument Type: String

afterColumn

(Optional) Name of the column after which the column should be placed. If neither beforeColumn nor afterColumn are specified, then the column is added as the last column in the dashboard.

Argument Type: String

beforeColumn

(Optional) Name of the column before which the column should be placed. If neither beforeColumn nor afterColumn is specified, then the column is added as the last column in the dashboard.

Argument Type: String

Positional arguments

projectName, dashboardName, and column

Response

Returns a dashboard column object.

ec-perl

syntax: $<object>->createDashboardColumn(<projectName>, <dashboardName>, <column>, {<optionals>});

Example
$ec->createDashboardColumn("Default", "Command Center Test", "Development", {afterColumn => "Planning"});

ectool

syntax: ectool createDashboardColumn <projectName> <dashboardName> <column> [optionals]

Example
ectool createDashboardColumn "Default" "Command Center Test" "Testing" --beforeColumn "SystemTest"

Back to top

deleteDashboard

Delete the specified dashboard.

You must specify projectName and dashboardName.

ArgumentsDescriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

dashboardName

Unique name of the dashboard within the projectName.

Argument Type: String

Positional arguments

projectName, dashboardName

Response

None.

ec-perl

syntax: $<object>->deleteDashboard(<projectName>, <dashboardName>);

Example
$ec->deleteDashboard("Default", "Weekly Overview");

ectool

syntax: ectool deleteDashboard <projectName> <dashboardName>]

Example
ectool deleteDashboard "Default" "Weekly Overview"

Back to top

deleteDashboardColumn

Deletes a dashboard column from a Command Center type of dashboard.

You must specify projectName, dashboardName, column, and deleteWidgets.

ArgumentsDescriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

dashboardName

Unique name of the dashboard within the projectName.

Argument Type: String

column

Name of the dashboard column.

Argument Type: String

deleteWidgets

< Boolean flag — 0|1|true|false >

Whether to delete the widgets associated with the column that is being deleted. If you specify 0 or false and widgets exist in the column, you must also specify addToColumn.

Argument Type: Boolean

addToColumn

(Optional) Column to which the widgets associated with the column being deleted should be added. Required if deleteWidgets is 0 or false and widgets exist in the column.

Argument Type: String

Positional arguments

projectName, dashboardName, and column

Response

None.

ec-perl

syntax: $<object>->deleteDashboardColumn(<projectName>, <dashboardName>, <columnName>, {deleteWidgets ⇒ <0|1|true|false>, addToColumn ⇒ <column>});

Examples
$ec->deleteDashboardColumn("Default", "Command Center Test", "Development", {deleteWidgets => "false", addToColumn => "Planning"});
$ec->deleteDashboardColumn("Default", "Command Center Test", "Development", {deleteWidgets => "true"});

ectool

syntax: ectool deleteDashboardColumn <projectName> <dashboardName> <columnName> --deleteWidgets <0|1|true|false> [--addToColumn <column>]

Examples
ectool deleteDashboardColumn "Default" "Command Center Test" "Development" --deleteWidgets "false" --addToColumn "Planning"
ectool deleteDashboardColumn "Default" "Command Center Test" "Development" --deleteWidgets "true"

Back to top

getDashboard

Get the specified dashboard.

You must specify the projectName and dashboardName.

ArgumentsDescriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

dashboardName

Unique name of the dashboard within the projectName.

Argument Type: String

includeDetails

(Optional) < Boolean flag — 0|1|true|false >

When this argument is set to true or 1,include propertySheet and widget details. If not specified, false is used.

Argument Type: Boolean

Positional arguments

projectName, dashboardName

Response

Returns a dashboard object.

ec-perl

syntax: $<object>->getDashboard(<projectName>, <dashboardName>, {includeDetails ⇒ <0|1|true|false>]});

Example
$ec->getDashboard("Default", "Weekly Overview", {includeDetails => true});

ectool

syntax: ectool getDashboard <projectName> <dashboardName> [--includeDetails <0|1|true|false>]

Example
ectool getDashboard Default "Weekly Overview" --includeDetails true

Back to top

getDashboards

Get all dashboards or (optionally) dashboards for the specified project.

ArgumentsDescriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

Positional arguments

None.

Response

Returns one or more dashboard objects.

ec-perl

syntax: $<object>->getDashboards, {projectName};

Example
$ec->getDashboards {projectName => Default};

ectool

syntax: ectool getDashboards [projectName]

Example
ectool getDashboards --projectName Default

Back to top

modifyDashboard

Modifies an existing dashboard for the specified project.

You must specify the projectName and dashboardName.

ArgumentsDescriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

dashboardName

Unique name of the dashboard within the projectName.

Argument Type: String

clearColumns

(Optional) < Boolean flag — 0|1|true|false >

When this argument is set to true or 1, columns are cleared. If not specified, false is used.

Argument Type: Boolean

clearPhases

(Optional) < Boolean flag — 0|1|true|false >

This argument is deprecated and is replaced by clearColumns.

When this argument is set to true or 1, phases are cleared. If not specified, false is used.

Argument Type: Boolean

columns

(Optional) List of the columns to display for the dashboard. Applies only to a COMMAND_CENTER type of dashboard.

Argument Type: Collection

customize

(Optional) < Boolean flag — 0|1|true|false >

Set to 1 or true to create a custom copy of the out-of-the-box Release Command Center dashboard.

Argument Type: Boolean

description

(Optional) Comment text describing this object; not interpreted at all by CloudBees CD/RO .

Argument Type: String

layout

(Optional) Layout to use for adding the widgets to the dashboard. Use FLOW.

Argument Type: DashboardLayout

newName

(Optional) New dashboard name.

Argument Type: String

phases

(Optional) List of the phases to display for a dashboard of type COMMAND_CENTER.

This argument is deprecated and is replaced by columns.

Argument Type: String

type

(Optional) Type of dashboard. Allowed types: COMMAND_CENTER, STANDARD. If not specified, STANDARD is used.

Argument Type: DashboardType

If customize is true, dashboardName is Release Command Center, and projectName is CloudBees, then a copy is created with a predefined name of Release Command Center in the CloudBees project. The associated reports are not cloned at the same time. If you need to modify the report definitions, you must create a copy of the report before changing it (as with other out-of-the-box reports).

Positional arguments

projectName, dashboardName

Response

Returns an updated dashboard object.

ec-perl

syntax: $<object>->modifyDashboard(<projectName>, <dashboardName>, {<optionals>});

Example
$ec->modifyDashboard("Default", "Executive Overview", {newName => "Weekly Overview"});

ectool

syntax: ectool modifyDashboard <projectName> <dashboardName> [optionals]

Example
ectool modifyDashboard Default "Executive Overview" --newName "Weekly Overview"

Back to top

modifyDashboardColumn

Modifies a dashboard column in a Command Center type of dashboard.

You must specify projectName, dashboardName, and column.

ArgumentsDescriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

dashboardName

Unique name of the dashboard within the projectName.

Argument Type: String

column

Name of the dashboard column.

Argument Type: String

afterColumn

(Optional) Name of the column after which the column should be placed. If neither beforeColumn nor afterColumn are specified, then the column is added as the last column.

Argument Type: String

beforeColumn

(Optional) Name of the column before which the column should be placed. If neither beforeColumn nor afterColumn are specified, then the column is added as the last column.

Argument Type: String

Positional arguments

projectName, dashboardName, and column

Response

Returns an updated dashboard column object.

ec-perl

syntax: $<object>->modifyDashboardColumn(<projectName>, <dashboardName>, <column>, {<optionals>});

Example
$ec->modifyDashboardColumn("Default", "Command Center Test", "Development", {afterColumn => "Planning"});

ectool

syntax: ectool modifyDashboardColumn <projectName> <dashboardName> <column> [optionals]

Example
ectool modifyDashboardColumn "Default" "Command Center Test" "Development" --beforeColumn "Production"

Back to top

Data Source Commands

createDevOpsInsightDataSource

Creates a new data source for the specified project.

You must specify projectName, releaseName, and devOpsInsightDataSourceName.

ArgumentsDescriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

releaseName

Name of the release.

Argument Type: String

devOpsInsightDataSourceName

Name of this data source.

Argument Type: String

description

(Optional) User-provided text describing this instance.

Argument Type: String

pluginKey

(Optional) Plugin key. For example, EC-MyPlugin.

Argument Type: String

pluginParameters

(Optional) Plugin parameters to be passed to the plugin for creating the required schedule and polling procedure.

Argument Type: Map

reportObjectTypeName

(Optional) Name of the report object type.

Argument Type: String

Positional arguments

projectName, releaseName, devOpsInsightDataSourceName

Response

Returns a devOpsInsightDataSource object.

ec-perl

syntax: $<object>->createDevOpsInsightDataSource(<projectName>, <releaseName>, <devOpsInsightDataSourceName>, {<optionals>});

Example
$ec->createDevOpsInsightDataSource("Default", "Executive Overview", {description => "Activity at a glance"});

ectool

syntax: ectool createDevOpsInsightDataSource <projectName> <releaseName> <devOpsInsightDataSourceName> [optionals]

Example
ectool createDevOpsInsightDataSource Default "Executive Overview"

Back to top

deleteDevOpsInsightDataSource

Delete the specified data source.

You must specify projectName, releaseName, and devOpsInsightDataSourceName.

ArgumentsDescriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

releaseName

Name of the release.

Argument Type: String

devOpsInsightDataSourceName

Name of this data source.

Argument Type: String

Positional arguments

projectName, releaseName, devOpsInsightDataSourceName

Response

None.

ec-perl

syntax: $<object>->deleteDevOpsInsightDataSource(<projectName>, <releaseName>, <devOpsInsightDataSourceName>);

Example
$ec->deleteDevOpsInsightDataSource("Default", "Weekly Overview");

ectool

syntax: ectool deleteDevOpsInsightDataSource <projectName> <releaseName> <devOpsInsightDataSourceName>]

Example
ectool deleteDevOpsInsightDataSource Default "Weekly Overview"

Back to top

getDevOpsInsightDataSource

Get the specified data source.

You must specify projectName, releaseName, and devOpsInsightDataSourceName.

ArgumentsDescriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

releaseName

Name of the release.

Argument Type: String

devOpsInsightDataSourceName

Name of this data source.

Argument Type: String

Positional arguments

projectName, releaseName, devOpsInsightDataSourceName

Response

Returns a devOpsInsightDataSource object.

ec-perl

syntax: $<object>->getDevOpsInsightDataSource(<projectName>, <releaseName>, <devOpsInsightDataSourceName>, {includeDetails ⇒ <0|1|true|false>]});

Example
$ec->getDevOpsInsightDataSource("Default", "Weekly Overview", {includeDetails => true});

ectool

syntax: ectool getDevOpsInsightDataSource <projectName> <releaseName> <devOpsInsightDataSourceName> [--includeDetails <0|1|true|false>]

Example
ectool getDevOpsInsightDataSource Default "Weekly Overview" --includeDetails true

Back to top

getDevOpsInsightDataSources

Get all data sources or, optionally, data sources for the specified project.

You must specify projectName and releaseName.

ArgumentsDescriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

releaseName

Name of the release.

Argument Type: String

reportObjectTypeName

(Optional) Name of the report object type for which to retrieve the CloudBees Analytics data sources defined for the release. If not specified, then all the CloudBees Analytics data sources defined for the release are retrieved.

Argument Type: String

Positional arguments

projectName, releaseName

Response

Returns one or more devOpsInsightDataSource objects.

ec-perl

syntax: $<object>->getDevOpsInsightDataSources, {projectName};

Example
$ec->getDevOpsInsightDataSources{projectName => Default};

ectool

syntax: ectool getDevOpsInsightDataSources [projectName]

Example
ectool getDevOpsInsightDataSources --projectName Default

Back to top

modifyDevOpsInsightDataSource

Modifies an existing data source for the specified project.

You must specify projectName, releaseName, and devOpsInsightDataSourceName.

ArgumentsDescriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

releaseName

Name of the release.

Argument Type: String

devOpsInsightDataSourceName

Name of this data source.

Argument Type: String

description

(Optional) User-provided text describing this instance.

Argument Type: String

newName

(Optional) New name for the data source that is being renamed.

Argument Type: String

pluginParameters

(Optional) Plugin parameters to be passed to the plugin for creating the required schedule and polling procedure.

Argument Type: Map

Positional arguments

projectName, releaseName, devOpsInsightDataSourceName

Response

Returns a devOpsInsightDataSource object.

ec-perl

syntax: $<object>->modifyDevOpsInsightDataSource(<projectName>, <releaseName>, <devOpsInsightDataSourceNameName>, {<optionals>});

Example
$ec->modifyDevOpsInsightDataSource("Default", "Executive Overview", {newName => "Weekly Overview"});

ectool

syntax: ectool modifyDevOpsInsightDataSource <projectName> <releaseName> <devOpsInsightDataSourceNameName> [optionals]

Example
ectool modifyDevOpsInsightDataSource Default "Executive Overview" --newName "Weekly Overview"

Back to top

Report Commands

createReport

Creates a new report for the specified project.

You must specify projectName and reportName.

ArgumentsDescriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

reportName

Unique name of the report within the projectName. This name appears in report lists.

Argument Type: String

definition

(Optional) The Elasticsearch query definition to use for retrieving the report data from the CloudBees Analytics server.

Argument Type: String

description

(Optional) Report description. If not specified, description is not set.

Argument Type: String

parameters

(Optional) Input parameters in JSON format accepted by the report definition. See Sample DSL below for expected format.

Argument Type: String

reportQuery

(Optional) The report query definition, in JSON format, to use for retrieving the report data from the CloudBees Analytics server. This definition can be built through the Report Editor.

Argument Type: String

title

(Optional) The title of the report. If not specified, title is not set.

Argument Type: String

One of the following is required.

reportObjectTypeName

Report object type name.

Argument Type: String

uri

An advanced mode option for identifying the Elasticsearch URI to use for retrieving the report result from the reporting system. For ElasticSearch, this attribute would point to one or more indices.

Argument Type: String

Positional arguments

projectName, reportName

Response

Returns a report object.

Sample DSL

report reportName: ‘AppsByDeploymentStatus’, projectName: ‘CloudBees’, {
  description: 'report desc'
  uri: 'ef-deployment-*/\_search?pretty'
  // report query definition to use when searching in ElasticSearch.
  definition: '''
{
    "query" : {
    ...
}
  ...
  parameters: ...
  [{
      name: 'appIdParam',
      label: 'Select application'
      // optional default value to use if none specified for runReport
      defaultValue: '',
      // the report should be able to handle he case where the parameter is not required and no optional value is specified.
      required: false,
      // parameter type. Supported types: 'text', 'dateRange', 'select', 'application', 'release', 'environment', 'pipeline'
      // parameter value will be based on the parameter type.
      // UI would need to support the different parameter types. For deploy types such as 'application', 'release', 'environment', 'pipeline',
      // the user should be presented with a chooser to select the application, release, etc and the selected object's id should be returned
      // as the parameter value.
      type: 'application',
      filterExpression: 'match: {"applicationId": "appIdParam"}'
   },
   {
   }]
  ...
}

ec-perl

syntax: $<object>->createReport(<projectName>, <reportName>, {<optionals>});

Example
$ec->createReport("Default", "All Pipeline Runs", {description => "Activity at a glance"});

ectool

syntax: ectool createReport <projectName> <reportName> [optionals]

Example
ectool createReport Default "All Pipeline Runs" --description "Activity at a glance"

Back to top

deleteReport

Delete the specified report.

You must specify the projectName and reportName.

ArgumentsDescriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

reportName

Unique name of the report within the projectName.

Argument Type: String

Positional arguments

projectName, reportName

Response

None.

ec-perl

syntax: $<object>->deleteReport(<projectName>, <reportName>);

Example
$ec->deleteReport("Default", "Weekly Overview");

ectool

syntax: ectool deleteReport <projectName> <reportName>]

Example
ectool deleteReport Default "Weekly Overview"

Back to top

getReport

Get the specified report.

You must specify projectName and reportName.

ArgumentsDescriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

reportName

Unique name of the report within the projectName.

Argument Type: String

Positional arguments

projectName, reportName

Response

Returns a report object.

ec-perl

syntax: $<object>->getreport(<projectName>, <reportdName>);

Example
$ec->getReport("Default", "All Pipeline Runs");

ectool

syntax: ectool getReport <projectName> <reportName>

Example
ectool getReport Default "All Pipeline Runs"

Back to top

getReports

Get all reports from the specified project.

You must specify the projectName.

ArgumentsDescriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

Positional arguments

projectName

Response

Returns all report objects for the specified project.

ec-perl

syntax: $<object>->getReports(<projectName>);

Example
$ec->getReports("Default");

ectool

syntax: ectool getReports <projectName>

Example
ectool getReports Default

Back to top

modifyReport

Creates a new report for the specified project.

You must specify the projectName and reportName.

ArgumentsDescriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

reportName

Unique name of the report within the projectName. This name appears in report lists.

Argument Type: String

definition

(Optional) The Elasticsearch query or search definition to use for retrieving the required data for the reporting system.

Argument Type: String

description

(Optional) Report description. If not specified, description is not set.

Argument Type: String

newName

(Optional) New name for an existing object that is being renamed.

Argument Type: String

parameters

(Optional) Input parameters in JSON format accepted by the report definition.

Argument Type: String

reportObjectTypeName

(Optional) Name of the report object type.

Argument Type: String

reportQuery

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

Argument Type: String

title

(Optional) The title of the report. If not specified, title is not set.

Argument Type: String

uri

(Optional) An advanced mode option for identifying the Elasticsearch URI to use for retrieving the report result from the reporting system. For ElasticSearch, this attribute would point to one or more indices. If not specified, uri is not set.

Argument Type: String

Positional arguments

projectName, reportName

Response

Returns a report object.

ec-perl

syntax: $<object>->modifyReport(<projectName>, <reportName>, {<optionals>});

Example
$ec->modifyReport("Default", "All Pipeline Runs", {uri => "myreport/_search?pretty"});

ectool

syntax: ectool modifyReport <projectName> <reportName> [optionals]

Example
ectool modifyReport Default "All Pipeline Runs" --uri "myreport/_search?pretty"

Back to top

runReport

Run the specified report.

You must specify the projectName and reportName.

ArgumentsDescriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

reportName

Unique name of the report within the projectName.

Argument Type: String

actualParameter

(Optional) Parameters passed as arguments to the report.

Argument Type: String

dashboardName

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

Argument Type: String

dashboardProjectName

(Optional) Specify if the dashboard is in a different project than the report.

Argument Type: String

definition

(Optional) The Elasticsearch query definition to use for retrieving report data.

Argument Type: String

filters

(Optional) Filters

Argument Type: String

previewMode

(Optional) <_Boolean flag_ — 0|1|true|false>

When this argument is set to true or 1,report is run in preview mode. If not specified, false is used. Preview mode returns a small result sample.

Argument Type: Boolean

reportObjectTypeName

(Optional) Report object type name

Argument Type: String

reportQuery

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

Argument Type: String

uri

(Optional) 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.

Argument Type: String

widgetName

(Optional) The name of the widget using the report.

Argument Type: String

Positional arguments

projectName, reportName

Response

Returns a report object.

ec-perl

syntax: $<object>->runReport(<projectName>, <reportName>);

Example
$ec->runReport (Default, "All Pipeline Runs");

ectool

syntax: ectool runReport <projectName> <reportName>

Example
ectool runReport Default "All Pipeline Runs"

Back to top

sendReportingData

Sends data to the CloudBees Analytics server.

You must specify reportObjectTypeName and payload.

ArgumentsDescriptions

reportObjectTypeName

Name of the report object for which the data (payload) is being sent to the CloudBees Analytics server.

Argument Type: String

payload

Payload with the attribute values for the report object in JSON text format.

Argument Type: String

validate

(Optional) If set to true or 1, validate the fields in the payload based on the attributes defined for the report object type.

Default is false or 0.

Argument Type: Boolean

Positional arguments

reportObjectTypeName, payload

Response

None or a status OK message.

===Payload validation

By default, no validation is performed on payload. Setting the validate argument to true causes payload to be validated based on the attributes defined for the report object type.

ec-perl

syntax: $<object>->sendReportingData({reportObjectTypeName ⇒ <reportObjectTypeName>, payload ⇒ <payload>})

Examples
my $payload = qq{{
  "field1": "value1",
  "field2": "value2",
  "field3Integer": 25,
  "field4Date": "2018-02-28'T'20:25:50.555"
}}
$cmdr->sendReportingData({reportObjectTypeName => "sample", payload => $payload})

Each record in the CloudBees Analytics server is automatically assigned an identifier that uniquely identifies the record. For most types of records, you do not need to explicitly assign a user-defined identifier. Each record sent through the sendReportingData command is automatically assigned a unique identifier by the CloudBees Analytics server.

However if the records stored in the CloudBees Analytics server need to be uniquely identified using user-defined identifiers, then the documentId field can be sent as part of the payload in the sendReportingData API. For example:

my $payload = qq{{
  "documentId": "2319024098340985"
  "field1": "value1",
  "field2": "value2",
  "field3Integer": 25,
  "field4Date": "2018-02-28'T'20:25:50.555"
}}
$cmdr->sendReportingData({reportObjectTypeName => "sample", payload => $payload})

If a record already exists with the same documentId, then it will be updated. Otherwise, a new record will be created for the given documentId in the CloudBees Analytics server.

ectool

syntax: ectool sendReportingPayload --reportObjectType <reportObjectTypeName> --payload <payload>

Example
ectool sendReportingPayload --reportObjectType sample --payload ’{"documentId": "2319024098340985", "field1": "value1", "field2": "value2"}’

Back to top

ReportingFilter Commands

createReportingFilter

Creates a new reportingFilter object.

ArgumentsDescriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

dashboardName

Name of the dashboard to which this filter belongs.

Argument Type: String

reportingFilterName

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

Argument Type: String

description

(Optional) A user-defined description of this object.

Argument Type: String

operator

(Optional) Operator type to use when applying the filter to the report. Possible values are:

  • IN

  • EQUALS

  • BETWEEN

Attribute Type: String

orderIndex

(Optional) Order in which the reporting filter should be displayed.

Argument Type: Integer

parameterName

(Optional) Parameter name on which to filter. Required when type is set to DATE.

Argument Type: String

reportObjectTypeName

(Optional) The name of the report object type.

Argument Type: String

required

(Optional) < Boolean flag — 0|1|true|false >

Whether the filter is required and should be enforced on the client side UI.

When this argument is set to true or 1, the association must be present.

Default is false or 0.

Argument Type: Boolean

type

(Optional) The attribute type. Possible values:

  • DATE yyyy-MM-dd This is a special enum value and expects the attribute to be a string formatted using the ISO date format 'yyyy-MM-dd')

  • ENVIRONMENT

  • RELEASE

  • APPLICATION

Attribute Type: String

widgetName

(Optional) Name of the widget within the dashboard, if the reporting filter belongs to a widget.

Argument Type: String

Positional arguments

projectName, dashboardName, reportingFilterName

Response

Returns a reportingFilter object.

ec-perl

syntax: $cmdr->createReportingFilter(<projectName>, <dashboardName>, <reportingFilterName>, {<optionals>});

Example
$cmdr->createReportingFilter("Default", "ExecDashboard", "MonthlyRollup");

ectool

syntax: ectool createReportingFilter <projectName> <dashboardName> <reportingFilterName> [<optionals>]

Example
ectool createReportingFilter Default ExecDashboard MonthlyRollup

Back to top

deleteReportingFilter

Deletes the specified reportReportingFilter object.

ArgumentsDescriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

dashboardName

Name of the dashboard to which this filter belongs.

Argument Type: String

reportingFilterName

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

Argument Type: String

widgetName

(Optional) Name of the widget within the dashboard, if the reporting filter belongs to a widget.

Argument Type: String

Positional arguments

projectName, dashboardName, reportingFilterName

Response

None or a status OK message.

ec-perl

syntax: $cmdr->deleteReportingFilter(<projectName>, <dashboardName> , <reportingFilterName>);

Example
$cmdr->deleteReportingFilter("Default", "ExecDashboard", "MonthlyRollup");

ectool

syntax: ectool deleteReportingFilter <projectName dashboardName reportingFilterName> <associatedType>

Example
ectool deleteReportingFilter "Default", "ExecDashboard", "MonthlyRollup"

Back to top

getReportingFilter

Retrieves the specified reportingFilter object.

ArgumentsDescriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

dashboardName

Name of the dashboard to which this filter belongs.

Argument Type: String

reportingFilterName

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

Argument Type: String

widgetName

(Optional) Name of the widget within the dashboard, if the reporting filter belongs to a widget.

Argument Type: String

Positional arguments

projectName, dashboardName, reportingFilterName

Response

Returns the specified reportingFilter object.

ec-perl

syntax: $cmdr->getReportingFilter(<projectName>, <dashboardName> , <reportingFilterName>);

Example
$cmdr->getReportingFilter("Default", "ExecDashboard", "MonthlyRollup");

ectool

syntax: ectool getReportingFilter <projectName dashboardName reportingFilterName> <associatedType>

Example
ectool getReportingFilter "Default", "ExecDashboard", "MonthlyRollup"

Back to top

getReportingFilters

Retrieves the specified reportingFilter objects.

ArgumentsDescriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

dashboardName

Name of the dashboard to which this filter belongs.

Argument Type: String

widgetName

(Optional) Name of the widget within the dashboard, if the reporting filter belongs to a widget.

Argument Type: String

Positional arguments

projectName, dashboardName

Response

Returns zero or more reportReportingFilter objects.

ec-perl

syntax: $cmdr->getReportingFilters(<projectName>, <dashboardName>);

Example
$cmdr->getReportingFilters("Default", "ExecDashboard");

ectool

syntax: ectool getReportingFilters <projectName, dashboardName>

Example
ectool getReportingFilters Default ExecDashboard

Back to top

modifyReportingFilter

Modifies the specified reportReportingFilter object.

ArgumentsDescriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

dashboardName

Name of the dashboard to which this filter belongs.

Argument Type: String

reportingFilterName

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

Argument Type: String

description

(Optional) A user-defined description of this object.

Argument Type: String

newName

(Optional) Used to rename this attribute.

Argument Type: String

operator

(Optional) Operator type to use when applying the filter to the report. Possible values are:

  • IN

  • EQUALS

  • BETWEEN

Attribute Type: String

orderIndex

(Optional) Order in which the reporting filter should be displayed.

Argument Type: Integer

parameterName

(Optional) Parameter name on which to filter. Required when type is set to DATE.

Argument Type: String

reportObjectTypeName

(Optional) The name of the report object type.

Argument Type: String

type

(Optional) The attribute type. Possible values:

  • DATE yyyy-MM-dd This is a special enum value and expects the attribute to be a string formatted using the ISO date format 'yyyy-MM-dd')

  • ENVIRONMENT

  • RELEASE

  • APPLICATION

Attribute Type: String

required

(Optional) < Boolean flag — 0|1|true|false >

Whether the filter is required and should be enforced on the client side UI.

When this argument is set to true or 1, the association must be present.

Default is false or 0.

Argument Type: Boolean

widgetName

(Optional) Name of the widget within the dashboard, if the reporting filter belongs to a widget.

Argument Type: String

Positional arguments

projectName, dashboardName, reportingFilterName

Response

Returns a reportingFilter object.

ec-perl

syntax: $cmdr->modifyReportingFilter(<projectName>, <dashboardName>, <reportingFilterName>, {<optionals>});

Example
$cmdr->modifyReportingFilter("Default", "ExecDashboard", "MonthlyRollup", newName => "AprilRollup");

ectool

syntax: ectool modifyReportingFilter<<projectName dashboardName reportingFilterName> [<optionals>]

Example
ectool modifyReportingFilter Default ExecDashboard MonthlyRollup --newName AprilRollup

Back to top

Report Object Type Commands

createReportObjectType

Creates a new reportObjectType object.

You must specify reportObjectTypeName.

ArgumentsDescriptions

reportObjectTypeName

Name of the report object type. No special characters or uppercase characters are allowed. Valid characters include [a-z][0-9][-].

Argument Type: String

colorCode

(Optional) Color associated with the report object type in hex code format \#rrggbb.

Argument Type: String

description

(Optional) Comment text describing this object; not interpreted at all by CloudBees CD/RO .

Argument Type: String

displayName

(Optional) Display name of report object type.

Argument Type: String

sourceType

(Optional) Category of the third-party tool from which data for the given report object type is obtained.

Argument Type: String

sourceTypeDescription

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

Argument Type: String

storagePattern

(Optional) Time-based storage pattern used for storing the report object type data. This field, if set, is used by ElasticSearch as the index name pattern.

The valid values are NONE, YYYY, YYYY_MM, or YYYY_MM_dd. Defaults to YYYY.

Argument type: ReportObjectTypeStoragePattern

Positional arguments

reportObjectTypeName

Response

Returns a reportObjectType object.

===DSL Example of a report object type definition

reportObjectType 'cust_market_stats', {
  description = 'Application features delivered as part of a release'

  reportObjectAttribute 'featureName', {
   type = 'STRING'
   required = true
  }
  reportObjectAttribute 'issues', {
   type = 'NUMBER'
   required = true
  }
reportObjectAssociation 'release', {
   sourceFields = 'releaseName, releaseProjectName'
   targetFields = 'releaseName, releaseProjectName'
   required = true
  }

  reportObjectAssociation 'application', {
   sourceFields = 'applicationName, projectName'
   targetFields = 'applicationName, applicationProjectName'
  }
}

ec-perl

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

Example
$cmdr->createReportObjectType("feature", {colorCode => #ff0000});

ectool

syntax: ectool createReportObjectType <reportObjectTypeName> [<optionals>]

Example
ectool createReportObjectType "feature" --colorCode #ff0000

Back to top

deleteReportObjectType

Deletes the specified reportObjectType object.

ArgumentsDescriptions

reportObjectTypeName

The name of the reportObjectTypeName object to delete.

Argument Type: String

Positional arguments

reportObjectTypeName

Response

None or a status OK message.

ec-perl

syntax: $cmdr->deleteReportObjectType(<ReportObjectTypeName>);

Example
$cmdr->deleteReportObjectType("feature");

ectool

syntax: ectool deleteReportObjectType <ReportObjectTypeName>

Example
ectool deleteReportObjectType "feature"

Back to top

getReportObjectType

Retrieves the specified reportObjectType object.

ArgumentsDescriptions

reportObjectTypeName

The name of the reportObjectType object to retrieve.

Argument Type: String

includeDetails

(Optional) < Boolean flag — 0|1|true|false >

true to include details such as report object association details (default is false or 0 ).

Argument Type: Boolean

Positional arguments

reportObjectTypeName

Response

Returns the specified reportObjectType object.

ec-perl

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

Example
$cmdr->getReportObjectType("feature", {includeDetails => "true"});

ectool

syntax: ectool getReportObjectType <reportObjectTypeName> [<optionals>]

Example
ectool getReportObjectType "feature" --includeDetails "true"

Back to top

getReportObjectTypes

Retrieves all reportObjectType objects.

ArgumentsDescriptions

includeDetails

(Optional) < Boolean flag — 0|1|true|false >

true to include details such as report object association details (default is false or 0 ).

Argument Type: Boolean

Positional arguments

None

Response

Returns zero or more reportObjectType objects.

ec-perl

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

Example
$cmdr->getReportObjectTypes({includeDetails => "true"});

ectool

syntax: ectool getReportObjectTypes [<optionals>]

Example
ectool getReportObjectTypes --includeDetails "true"

Back to top

modifyReportObjectType

Modifies the specified reportObjectType object.

You must specify reportObjectTypeName.

ArgumentsDescriptions

reportObjectTypeName

Name of the report object type. No special characters or uppercase characters are allowed. Valid characters include [a-z][0-9][-].

Argument Type: String

colorCode

(Optional) Color associated with the report object type in hex code format \#rrggbb.

Argument Type: String

description

(Optional) Comment text describing this object; not interpreted at all by CloudBees CD/RO .

Argument Type: String

displayName

(Optional) Display name of report object type.

Argument Type: String

newName

(Optional) New name for the object.

Argument Type: String

sourceType

(Optional) Category of the third-party tool from which data for the given report object type is obtained.

Argument Type: String

sourceTypeDescription

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

Argument Type: String

storagePattern

(Optional) Time-based storage pattern used for storing the report object type data. This field, if set, is used by ElasticSearch as the index name pattern.

The valid values are NONE, YYYY, YYYY_MM, or YYYY_MM_dd. Defaults to YYYY.

Argument type: ReportObjectTypeStoragePattern

Positional arguments

ReportObjectTypeName

Response

Returns an updated reportObjectType object.

ec-perl

syntax: $cmdr->modifyReportObjectType(<ReportObjectTypeName>, {<optionals>});

Example
$cmdr->modifyReportObjectType("feature", {newName => "newfeature", colorCode => "#ff0000"});

ectool

syntax: ectool modifyReportObjectType <ReportObjectTypeName> [<optionals>]

Example
ectool modifyReportObjectType "feature" --newName "newfeature" --colorCode "#ff0000"

Back to top

ReportObjectAssociation Commands

createReportObjectAssociation

Creates a new reportObjectAssociation object.

ArgumentsDescriptions

reportObjectTypeName

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

Argument Type: String

associatedType

Object type that is the target of this association.

Argument Type: String

description

A user-defined description of this object.

Argument Type: String

required

(Optional) < Boolean flag — 0|1|true|false >

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

When this argument is set to true or 1, the association must be present.

Default is false or 0.

Argument Type: Boolean

sourceFields

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.

Argument Type: String

targetFields

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.

Argument Type: String

Positional arguments

reportObjectTypeName, associatedType

Response

Returns a reportObjectAssociation object.

ec-perl

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

Example
$cmdr->createReportObjectAssociation("feature", "MyAssocType");

ectool

syntax: ectool createReportObjectAssociation <reportObjectTypeName> <associatedType> [<optionals>]

Example
ectool createReportObjectAssociation "feature" "MyAssocType"

Back to top

deleteReportObjectAssociation

Deletes the specified reportObjectAssociation object.

ArgumentsDescriptions

reportObjectTypeName

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

Argument Type: String

associatedType

Object type that is the target of this association.

Argument Type: String

Positional arguments

reportObjectTypeName, associatedType

Response

None or a status OK message.

ec-perl

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

Example
$cmdr->deleteReportObjectAssociation("feature", "MyAssocType");

ectool

syntax: ectool deleteReportObjectAssociation <reportObjectTypeName> <associatedType>

Example
ectool deleteReportObjectAssociation "feature" "MyAssocType"

Back to top

getReportObjectAssociation

Retrieves the specified reportObjectAssociation object.

ArgumentsDescriptions

reportObjectTypeName

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

Argument Type: String

associatedType

Object type that is the target of this association.

Argument Type: String

Positional arguments

reportObjectTypeName, associatedType

Response

Returns the specified reportObjectAssociation object.

ec-perl

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

Example
$cmdr->getReportObjectAssociation("feature", "MyAssocType");

ectool

syntax: ectool getReportObjectAssociation <reportObjectTypeName> <associatedType>

Example
ectool getReportObjectAssociation "feature" "MyAssocType"

Back to top

getReportObjectAssociations

Retrieves the associations for the specified reportObjectTypeName object.

ArgumentsDescriptions

reportObjectTypeName

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

Argument Type: String

Positional arguments

reportObjectTypeName

Response

Returns zero or more reportObjectAssociation objects.

ec-perl

syntax: $cmdr->getReportObjectAssociations(<reportObjectTypeName>);

Example
$cmdr->getReportObjectAssociations("feature");

ectool

syntax: ectool getReportObjectAssociations <reportObjectTypeName>

Example
ectool getReportObjectAssociations "feature"

Back to top

modifyReportObjectAssociation

Modifies the specified reportObjectAssociation object.

ArgumentsDescriptions

reportObjectTypeName

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

Argument Type: String

associatedType

Object type that is the target of this association.

Argument Type: String

description

A user-defined description of this object.

Argument Type: String

newName

(Optional) Used to rename this attribute.

Argument Type: String

required

(Optional) < Boolean flag — 0|1|true|false >

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

When this argument is set to true or 1, the association must be present.

Default is false or 0.

Argument Type: Boolean

sourceFields

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.

Argument Type: String

targetFields

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.

Argument Type: String

Positional arguments

reportObjectTypeName, associatedType

Response

Returns a reportObjectAssociation object.

ec-perl

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

Example
$cmdr->createReportObjectAssociation("feature", "MyAssocType", newName => "AssocType2");

ectool

syntax: ectool createReportObjectAssociation <reportObjectTypeName associatedType> [<optionals>]

Example
ectool createReportObjectAssociation feature MyAssocType --newName AssocType2

Back to top

ReportObjectAttribute Commands

createReportObjectAttribute

Creates a new reportObjectAttribute object.

ArgumentsDescriptions

reportObjectAttributeName

The name of the report object attribute. No special characters are allowed in the report object type name. Valid characters include [a-z][0-9][-].

Argument Type: String

reportObjectTypeName

The name of the report object type to which this attribute belongs.

Argument Type: String

description

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

Argument Type: String

displayName

Display name of report object attribute.

Argument Type: String

enumerationValues

Enumeration values of report object attribute.

Argument Type: String

required

(Optional) < Boolean flag — 0|1|true|false >

When this argument is set to true or 1, this attribute muse be set for the report object type record.

Argument type: Boolean

type

(Optional) The attribute type.

Argument type: ReportObjectAttributeType. Possible values:

  • STRING

  • DATE yyyy-MM-dd This is a special enum value and expects the attribute to be a string formatted using the ISO date format 'yyyy-MM-dd')

  • DATETIME

  • NUMBER

  • DURATION

  • PERCENT

  • CONSTANT * This is a special enum value not used as attribute type but in a widget definition.

Positional arguments

reportObjectAttributeName, reportObjectTypeName

Response

Returns a reportObjectAttribute object.

ec-perl

syntax: $cmdr->createReportObjectAttribute(<reportObjectAttributeName>, <reportObjectTypeName>{<optionals>});

Example
$cmdr->createReportObjectAttribute("MyReportType", "feature");

ectool

syntax: ectool createReportObjectAttribute <reportObjectAttributeName> <reportObjectTypeName> [<optionals>]

Example
ectool createReportObjectAttribute MyReportType feature

Back to top

deleteReportObjectAttribute

Deletes the specified reportObjectAttribute object.

ArgumentsDescriptions

reportObjectAttributeName

The name of the report object attribute to delete.

Argument Type: String

reportObjectTypeName

The name of the report object type to which this attribute belongs.

Argument Type: String

Positional arguments

reportObjectAttributeName, reportObjectTypeName

Response

None or a status OK message.

ec-perl

syntax: $cmdr->deleteReportObjectAttribute(<ReportObjectAttributeName>, <reportObjectTypeName>);

Example
$cmdr->deleteReportObjectAttribute("Release Manager West", "feature");

ectool

syntax: ectool deleteReportObjectAttribute <ReportObjectAttributeName> <reportObjectTypeName>

Example
ectool deleteReportObjectAttribute "Release Manager West" "feature"

Back to top

getReportObjectAttribute

Retrieves the specified reportObjectAttribute object.

ArgumentsDescriptions

reportObjectTypeName

The name of the report object type to which this attribute belongs.

Argument Type: String

reportObjectAttributeName

The name of the reportObjectAttribute object to retrieve.

Argument Type: String

Positional arguments

reportObjectTypeName and reportAttributeName

Response

ec-perl

syntax: $cmdr->getReportObjectAttribute(<reportObjectTypeName>, <reportObjectAttributeName>);

Example
$cmdr->getReportObjectAttribute("deployment", "modifiedOn");

ectool

syntax: ectool getReportObjectAttribute <reportObjectTypeName> <reportObjectAttributeName>

Example
ectool getReportObjectAttribute "deployment" "modifiedOn"

Back to top

getReportObjectAttributeValues

Retrieves possible values for the specified reportObjectAttributeName object. Contents of the result set varies based on the type of reportObjectAttributeName :

  • For enumerated types, all possible types are returned.

  • For string types, all values in the CloudBees Analytics server are returned.

  • For Boolean types, the Boolean values in the CloudBees Analytics server are returned.

ArgumentsDescriptions

reportObjectTypeName

The name of the report object type to which this attribute belongs.

Argument Type: String

reportObjectAttributeName

The name of the reportObjectAttribute object from which to retrieve values. Specify a String- or Boolean-type name.

Argument Type: String

fromIndex

The index of the first value to be retrieved, numbered from 0.

Argument type: Number

maxValues

The maximum number of values to return at a time. If not specified, 20 is used.

Argument type: Number

valueStartsWith

String with which values begin.

Argument Type: String

Positional arguments

reportObjectTypeName, reportObjectAttributeName

Response

total

The total number of items returned in the values list.

values

The list of value elements.

value…​

The values, one element per value.

ec-perl

syntax: $cmdr->getReportObjectAttributeValues(<reportObjectTypeName>, <reportObjectAttributeName>);

Example
$cmdr->getReportObjectAttributeValues("feature", "featureName");

ectool

syntax: ectool getReportObjectAttributeValues <reportObjectTypeName, reportObjectAttributeName>

Example
ectool getReportObjectAttributeValues feature featureName

Back to top

getReportObjectAttributes

Retrieves the specified reportObjectAttribute objects.

ArgumentsDescriptions

reportObjectTypeName

The name of the report object type to which the attributes belong.

Argument type: string

Positional arguments

reportObjectTypeName

Response

ec-perl

syntax: $cmdr->getReportObjectAttributes(<reportObjectTypeName>);

Example
$cmdr->getReportObjectAttributes("deploy");

ectool

syntax: ectool getReportObjectAttributes <reportObjectTypeName>

Example
ectool getReportObjectAttributes "incident"

Back to top

modifyReportObjectAttribute

Modifies the specified reportObjectAttribute object.

ArgumentsDescriptions

reportObjectTypeName

The name of the report object type to which this attribute belongs.

Argument Type: String

reportObjectAttributeName

The name of the report object attribute. No special characters are allowed in the report object type name. Valid characters include [a-z][0-9][-].

Argument Type: String

description

(Optional) Comment text describing this object; not interpreted at all by CloudBees CD/RO .

Argument Type: String

displayName

(Optional) Display name of report object attribute.

Argument Type: String

enumerationValues

(Optional) Enumeration values of report object attribute.

Argument Type: String

newName

(Optional) Used to rename this attribute.

Argument Type: String

required

(Optional) < Boolean flag — 0|1|true|false >

When this argument is set to true or 1, this attribute must be set for the report object type record.

Argument Type: Boolean

type

(Optional) The attribute type.

Argument type: ReportObjectAttributeType. Possible values:

  • STRING

  • DATE yyyy-MM-dd This is a special enum value and expects the attribute to be a string formatted using the ISO date format 'yyyy-MM-dd')

  • DATETIME

  • NUMBER

  • DURATION

  • PERCENT

  • CONSTANT * This is a special enum value not used as attribute type but in a widget definition.

Positional arguments

reportObjectTypeName and ReportObjectAttributeName

Response

Returns a reportObjectAttribute object.

ec-perl

syntax: $cmdr->modifyReportObjectAttribute(<ReportObjectTypeName>, <ReportObjectAttributeName>, {<optionals>});

Example
$cmdr->modifyReportObjectAttribute("code_commit", "Test", {newName => "NewTest"});

ectool

syntax: ectool modifyReportObjectAttribute <ReportObjectTypeName> <ReportObjectAttributeName> [<optionals>]

Example
ectool modifyReportObjectAttribute "code_commit" "Test" --newName "NewTest"

Back to top

Widget Commands

createWidget

Creates a new widget for the specified dashboard and project .

You must specify projectName, dashboardName, widgetName, and reportName.

ArgumentsDescriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

dashboardName

Unique name of the dashboard within the project. Specify user-defined dashboards, only. Creating widgets on a system-generated dashboard is not allowed.

Argument Type: String

widgetName

The name of the dashboard widget.

Argument Type: String

reportName

Name of an existing report backing the widget.

Argument Type: String

actualParameters

(Optional) Actual parameter values for the parameters defined on the widget’s report.

Argument Type: Map

clearAttributeDataTypes

(Optional) Whether or not to clear attribute data types for the widget

Argument Type: String

clearAttributePaths

(Optional) Whether or not to clear attribute paths for the widget.

Argument Type: String

clearLinkParameters

(Optional) Whether or not to clear link parameters for the widget.

Argument Type: String

clearVisualizationProperties

(Optional) Whether or not to clear visualization properties for the widget.

Argument Type: String

column

(Optional) The column in a COMMAND_CENTER dashboard that the widget belongs to. Required for a COMMAND_CENTER dashboard widget unless the widget section is 'SUMMARY' in which case it is not applicable.

Argument Type: String

description

(Optional) Comment text describing this object; not interpreted at all by CloudBees CD/RO .

Argument Type: String

linkParameters

(Optional) Widget parameters used by UI to construct the drill-down link for the widget. (Alternate argument name 'linkParameter'.

Argument Type: Map

linkTarget

(Optional) Determines the page to navigate to when the user drills down through the dashboard widget.

Argument Type: String

newName

(Optional) New name for an existing object that is being renamed.

Argument Type: String

phase

(Optional) The phase in a COMMAND_CENTER dashboard that the widget belongs to. Required for a COMMAND_CENTER dashboard widget unless the widget section is 'SUMMARY' in which case it is not applicable.

This argument is deprecated and is replaced by column.

Argument Type: String

reportProjectName

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

Argument Type: String

section

(Optional) The section of a COMMAND_CENTER dashboard to display the widget in. Required for a COMMANDER_CENTER dashboard widget.

Argument Type: WidgetSection

visualizationProperties

(Optional) Properties or settings used by the widget’s visualization type.

Argument Type: Map

Widget visualization information

visualization

(Optional) Type of visualization data in the widget. Types include: AREA_CHART, CUSTOM_CHART, DONUT_CHART, GROUPED_HORIZONTAL_BAR_CHART, GROUPED_VERTICAL_BAR_CHART, HORIZONTAL_BAR_CHART, LINE_CHART, METRIC, STACKED_AREA_CHART, STACKED_HORIZONTAL_BAR_CHART, STACKED_VERTICAL_BAR_CHART, TABLE, VERTICAL_BAR_CHART.

Argument Type: WidgetVisualization

attributeDataTypes

(Optional) List of attributes with their expected paths in the result payload, optionally with their data type. Each visualization recognizes a specific set of attributes.

Argument Type: Map

attributePaths

(Optional) Widget parameters used by UI to control paths of attributes.

Argument Type: Map

colors

(Optional) Color map used when rendering the widget. The usage of the color map depends on the widget’s visualization type.

Argument Type: Map

clearColors

(Optional) Whether or not to clear color for the widget.

Argument Type: String

colorRanges

(Optional) The JSON with color ranges definition for the widget.

Argument Type: String

iconUrl

(Optional) The icon to display for the widget.

Argument Type: String

orderIndex

(Optional) The relative order of the widget in the dashboard.

Argument Type: Integer

title

(Optional) The title to display for the widget. If not set, use the report title.

Argument Type: String

Positional arguments

projectName, dashboardName, widgetName, reportName

Response

Returns a widget object.

ec-perl

syntax: $<object>->createWidget(<projectName>, <dashboardName>, <widgetName>, <reportName>,< {<optionals>});

Example
$ec->createWidget("Default", "Weekly Overview", "Pipeline Runs" {title => "Pipeline Runs"});

ectool

syntax: ectool createWidget <projectName> <dashboardName> <widgetName> [optionals]

Example
ectool createWidget Default "Weekly Overview" "Pipeline Runs" --title "Pipeline Runs"

Back to top

deleteWidget

Delete the specified widget.

You must specify the projectName, dashboardName, and widgetName

ArgumentsDescriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

dashboardName

Unique name of the dashboard within the project.

Argument Type: String

widgetName

The name of the dashboard widget.

Argument Type: String

Positional arguments

projectName, dashboardname, widgetName

Response

None.

ec-perl

syntax: $<object>->deleteWidget(<projectName>, <dashboardName>, <widgetName);

Example
$ec->deleteWidget("Default", "Weekly Overview", "All Pipeline Runs");

ectool

syntax: ectool deleteWidget <projectName> <reportName> <widgetName]

Example
ectool deleteWidget Default "Weekly Overview" "All Pipeline Runs"

Back to top

getWidget

Get the specified widget.

You must specify projectName, dashboardName, and widgetName.

ArgumentsDescriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

dashboardName

Unique name of the dashboard within the project.

Argument Type: String

widgetName

The name of the dashboard widget.

Argument Type: String

Positional arguments

projectName, dashboardname, widgetName

Response

Returns a widget object.

ec-perl

syntax: $<object>->getWidget(<projectName>, <dashboardName>, <widgetName);

Example
$ec->getWidget("Default", "Weekly Overview", "All Pipeline Runs");

ectool

syntax: ectool getWidget <projectName> <reportName> <widgetName]

Example
ectool getWidget Default "Weekly Overview" "All Pipeline Runs"

Back to top

getWidgets

Get all widgets for the specified project and dashboard

You must specify projectName, and dashboardName.

ArgumentsDescriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

dashboardName

Unique name of the dashboard within the project.

Argument Type: String

Positional arguments

projectName, dashboardname

Response

Returns all widget objects for the specified project and dashboard.

ec-perl

syntax: $<object>->getWidgets(<projectName>, <dashboardName>);

Example
$ec->getWidgets("Default", "Weekly Overview");

ectool

syntax: ectool getWidgets <projectName> <reportName>]

Example
ectool getWidget Default "Weekly Overview"

Back to top

modifyWidget

Modify an existing widget for the specified dashboard.

You must specify the projectName, dashboardName, and widgetName.

ArgumentsDescriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

dashboardName

Unique name of the dashboard within the project.

Argument Type: String

widgetName

The name of the dashboard widget.

Argument Type: String

actualParameters

(Optional) Actual parameter values for the parameters defined on the widget’s report.

Argument Type: Map

attributeDataTypes

(Optional) Widget parameters used by UI to control data types of attributes.

Argument Type: Map

attributePaths

(Optional) Widget parameters used by UI to control paths of attributes.

Argument Type: Map

clearAttributeDataTypes

(Optional) < Boolean flag — 0|1|true|false >. Whether or not to clear attribute data types for the widget.

Argument Type: Boolean

clearAttributePaths

(Optional) < Boolean flag — 0|1|true|false >. Whether or not to clear attribute paths for the widget.

Argument Type: String

clearColors

(Optional) < Boolean flag — 0|1|true|false >. Whether or not to clear color for the widget.

Argument Type: String

clearLinkParameters

(Optional) < Boolean flag — 0|1|true|false >. Whether or not to clear link parameters for the widget.

Argument Type: String

clearVisualizationProperties

(Optional) < Boolean flag — 0|1|true|false >. Whether or not to clear visualization properties for the widget.

Argument Type: String

colorRanges

(Optional) The JSON with color ranges definition for the widget.

Argument Type: String

colors

(Optional) Color map used when rendering the widget. The usage of the color map depends on the widget’s visualization type. (Alternate argument name 'color'.

Argument Type: Map

column

(Optional) The column in a COMMAND_CENTER dashboard that the widget belongs to. Required for a COMMAND_CENTER dashboard widget unless the widget section is 'SUMMARY' in which case it is not applicable.

Argument Type: String

description

(Optional) Comment text describing this object; not interpreted at all by CloudBees CD/RO .

Argument Type: String

iconUrl

(Optional) The icon to display for the widget.

Argument Type: String

linkParameters

(Optional) Widget parameters used by UI to construct the drill-down link for the widget. (Alternate argument name 'linkParameter'.

Argument Type: Map

linkTarget

(Optional) Determines the page to navigate to when the user drills down through the dashboard widget.

Argument Type: String

newName

(Optional) New name for an existing object that is being renamed.

Argument Type: String

orderIndex

(Optional) CloudBees CD/RO order that the widget is on.

Argument Type: Integer

phase

(Optional) The phase in a COMMAND_CENTER dashboard that the widget belongs to. Required for a COMMAND_CENTER dashboard widget unless the widget section is 'SUMMARY' in which case it is not applicable.

This argument is deprecated and is replaced by column.

Argument Type: String

reportName

(Optional) Name of an existing report backing the widget.

Argument Type: String

reportProjectName

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

Argument Type: String

section

(Optional) The section of a COMMAND_CENTER dashboard to display the widget in. Required for a COMMANDER_CENTER dashboard widget.

Argument Type: WidgetSection

title

(Optional) The title to display for the widget. If not set, use the report title.

Argument Type: String

visualization

(Optional) Type of visualization data in the widget.

Argument Type: WidgetVisualization

visualizationProperties

(Optional) Properties or settings used by the widget’s visualization type. (Alternate argument name 'visualizationProperty'.

Argument Type: Map

Positional arguments

projectName, dashboardName, widgetName

Response

Returns a widget object.

ec-perl

syntax: $<object>->modifyWidget(<projectName>, <dashboardName>, <widgetName>, <reportName>,< {<optionals>});

Example
$ec->modifyWidget("Default", "Weekly Overview", "Pipeline Runs" {title => "Pipeline Runs"}

ectool

syntax: ectool modifyWidget <projectName> <dashboardName> <widgetName> [optionals]

Example
ectool modifyWidget Default "Weekly Overview" "Pipeline Runs" --title "Pipeline Runs"

Back to top

moveWidget

Moves a widget within a dashboard.

You must specify the projectName, dashboardName, and widgetName.

ArgumentsDescriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

dashboardName

Unique name of the dashboard within the project.

Argument Type: String

widgetName

Name of the dashboard widget.

Argument Type: String

beforeWidget

(Optional) Name of the widget before which the specified widget should be placed. Leave this blank to move the widget to the last position in the specified section or column.

If you specify beforeWidget and the dashboard is of type COMMAND_CENTER :

  • If the widget identified by beforeWidget is in the summary section (the section at the top of a dashboard), the specified widget is moved before it.

  • If the widget identified by beforeWidget is in a column, the specified widget is moved before it.

  • If you also specify section, it must match the section of the widget specified by beforeWidget.

  • If you also specify a column, it must match the column of the widget specified by beforeWidget.

If you do not specify beforeWidget and the dashboard is of type COMMAND_CENTER :

  • If you do not also specify column, then you must also specify section (and section must be set to SUMMARY ).

  • If you also specify the column argument:

    • Make sure that the column exists in the dashboard.

    • Do not specify the section argument as well.

    • The widget is moved to the last position in the column, and COLUMN is set to the specified column value.

Argument Type: String

column

(Optional) Column to which to move the widget. Applicable only for a Command Center type of dashboard. The column must already exist.

Argument Type: String

section

(Optional) Section in which to display the widget. Applicable only for a Command Center type of dashboard.

Required if column is not set. The possible values are:

  • SUMMARY —the summary section at the top of a dashboard

  • PHASE_DETAIL —the section for the remainder of the dashboard below the summary section

Do not specify the column argument if you specify the section argument.

Argument Type: WidgetSection

Positional arguments

projectName, dashboardName, and widgetName

Response

Returns an updated widget position.

ec-perl

syntax: $<object>->moveWidget(<projectName>, <dashboardName>, <widgetName>, {<optionals>});

Example
$ec->moveWidget("Default", "Command Center Test", "Stories Resolved" {beforeWidget => "Dev Complete"}

ectool

syntax: ectool moveWidget <projectName> <dashboardName> <widgetName> [optionals]

Example
ectool moveWidget "Default" "Command Center Test" "Stories Resolved" --beforeWidget "Dev Complete"

Back to top

WidgetFilterOverride Commands

createWidgetFilterOverride

Creates a new widgetFilterOverride object.

ArgumentsDescriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

dashboardName

Name of the dashboard to which this filter belongs.

Argument Type: String

widgetName

Name of the widget within the dashboard

Argument Type: String

dashboardFilterName

Name of the dashboard filter being overridden at the widget level.

Argument Type: String

description

(Optional) A user-defined description of this object.

Argument Type: String

ignoreFilter

(Optional) < Boolean flag — 0|1|true|false >

Whether to ignore the dashboard filter and not apply it to the report. All other arguments are ignored if this argument is set to true or 1.

Default is false or 0.

Argument Type: Boolean

parameterName

(Optional) Parameter name to use when applying the filter to the report instead of the parameter name specified in the dashboard filter.

Argument Type: String

Positional arguments

projectName, dashboardName, widgetName, dashboardFilterName

Response

Returns a widgetFilterOverride object.

ec-perl

syntax: $cmdr->createWidgetFilterOverride(<projectName>, <dashboardName> , <widgetName>, <dashboardFilterName>, {<optionals>});

Example
$cmdr->createWidgetFilterOverride("Default", "ExecDashboard", "MyWidget" "AprilReleases");

ectool

syntax: ectool createWidgetFilterOverride <projectName dashboardName widgetName dashboardFilterName> [<optionals>]

Example
ectool createWidgetFilterOverride Default ExecDashboard MyWidget AprilReleases

Back to top

deleteWidgetFilterOverride

Deletes the specified reportWidgetFilterOverride object.

ArgumentsDescriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

dashboardName

Name of the dashboard to which this filter belongs.

Argument Type: String

widgetName

Name of the widget within the dashboard.

Argument Type: String

dashboardFilterName

Name of the dashboard filter being overridden at the widget level.

Argument Type: String

Positional arguments

projectName, dashboardName, widgetName, dashboardFilterName

Response

None or a status OK message.

ec-perl

syntax: $cmdr->deleteWidgetFilterOverride(<projectName>, <dashboardName> , <widgetName>, <dashboardFilterName>);

Example
$cmdr->deleteWidgetFilterOverride("Default", "ExecDashboard", "MyWidget" "AprilReleases");

ectool

syntax: ectool deleteWidgetFilterOverride <projectName dashboardName widgetName dashboardFilterName> <associatedType>

Example
ectool deleteWidgetFilterOverride Default ExecDashboard MyWidget AprilReleases

Back to top

getWidgetFilterOverride

Retrieves the specified widgetFilterOverride object.

ArgumentsDescriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

dashboardName

Name of the dashboard to which this filter belongs.

Argument Type: String

widgetName

Name of the widget within the dashboard.

Argument Type: String

dashboardFilterName

Name of the dashboard filter being overridden at the widget level.

Argument Type: String

Positional arguments

projectName, dashboardName, widgetName, dashboardFilterName

Response

Returns the specified widgetFilterOverride object.

ec-perl

syntax: $cmdr->getWidgetFilterOverride(<projectName>, <dashboardName> , <widgetName>, <dashboardFilterName>, {<optionals>});

Example
$cmdr->getWidgetFilterOverride("Default", "ExecDashboard", "MyWidget" "AprilReleases");

ectool

syntax: ectool getWidgetFilterOverride <projectName dashboardName widgetName dashboardFilterName> [<optionals>]

Example
ectool getWidgetFilterOverride Default ExecDashboard MyWidget AprilReleases

Back to top

getWidgetFilterOverrides

Retrieves the specified widgetFilterOverride objects.

ArgumentsDescriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

dashboardName

Name of the dashboard to which this filter belongs.

Argument Type: String

widgetName

(Optional) Name of the widget within the dashboard, if the reporting filter belongs to a widget.

Argument Type: String

Positional arguments

projectName, dashboardName, widgetName

Response

Returns zero or more widgetFilterOverride objects.

ec-perl

syntax: $cmdr->getWidgetFilterOverrides(<projectName>, <dashboardName>, <widgetName>);

Example
$cmdr->getWidgetFilterOverrides("Default", "ExecDashboard", "MyWidget");

ectool

syntax: ectool getWidgetFilterOverrides <projectName dashboardName widgetName>

Example
ectool getWidgetFilterOverrides Default ExecDashboard MyWidget

Back to top

modifyWidgetFilterOverride

Modifies the specified widgetFilterOverride object.

ArgumentsDescriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

dashboardName

Name of the dashboard to which this filter belongs.

Argument Type: String

widgetName

Name of the widget within the dashboard

Argument Type: String

dashboardFilterName

Name of the dashboard filter being overridden at the widget level.

Argument Type: String

description

(Optional) A user-defined description of this object.

Argument Type: String

newName

(Optional) Used to rename this attribute.

Argument Type: String

ignoreFilter

(Optional) < Boolean flag — 0|1|true|false >

Whether to ignore the dashboard filter and not apply it to the report. All other arguments are ignored if this argument is set to true or 1.

Default is false or 0.

Argument Type: Boolean

parameterName

(Optional) Parameter name to use when applying the filter to the report instead of the parameter name specified in the dashboard filter.

Argument Type: String

Positional arguments

projectName, dashboardName, widgetName, dashboardFilterName

Response

Returns a widgetFilterOverride object.

ec-perl

syntax: $cmdr->modifyWidgetFilterOverride((<projectName>, <dashboardName> , <widgetName>, <dashboardFilterName>, {<optionals>});

Example
$cmdr->modifyWidgetFilterOverride("Default", "ExecDashboard", "MyWidget" "AprilReleases", newName => "AprilRollup");

ectool

syntax: ectool modifyWidgetFilterOverride <projectName dashboardName widgetName dashboardFilterName> [<optionals>]

Example
ectool modifyWidgetFilterOverride Default ExecDashboard MyWidget AprilReleases --newName AprilRollup

Back to top

Data retention
Directory provider management