Dashboard Commands
createDashboard
Creates a new dashboard for the specified project.
You must specify projectName
and dashboardName
.
Arguments | Descriptions | ||
---|---|---|---|
projectName |
Name of the project. This name must be unique among all projects. Argument Type: String |
||
dashboardName |
Unique name of the dashboard within the Argument Type: String |
||
columns |
(Optional) List of the columns to display for the dashboard of type 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 Argument Type: DashboardLayout |
||
phases |
(Optional) List of the phases to display for the dashboard of type
Argument Type: String |
||
type |
(Optional) Type of dashboard. Allowed types: Argument Type: DashboardType |
Response
Returns a dashboard object.
createDashboardColumn
Creates a dashboard column in a Command Center type of dashboard.
You must specify projectName
, dashboardName
, and column
.
Arguments | Descriptions |
---|---|
projectName |
Name of the project. This name must be unique among all projects. Argument Type: String |
dashboardName |
Unique name of the dashboard within the 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 Argument Type: String |
beforeColumn |
(Optional) Name of the column before which the column should be placed. If neither Argument Type: String |
Response
Returns a dashboard column object.
ec-perl
syntax: $<object>->createDashboardColumn(<projectName>, <dashboardName>, <column>, {<optionals>});
deleteDashboard
Delete the specified dashboard.
You must specify projectName
and dashboardName
.
Arguments | Descriptions |
---|---|
projectName |
Name of the project. This name must be unique among all projects. Argument Type: String |
dashboardName |
Unique name of the dashboard within the Argument Type: String |
deleteDashboardColumn
Deletes a dashboard column from a Command Center type of dashboard.
You must specify projectName
, dashboardName
, column
, and deleteWidgets
.
Arguments | Descriptions |
---|---|
projectName |
Name of the project. This name must be unique among all projects. Argument Type: String |
dashboardName |
Unique name of the dashboard within the 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 Argument Type: Boolean |
addToColumn |
(Optional) Column to which the widgets associated with the column being deleted should be added. Required if Argument Type: String |
ec-perl
syntax: $<object>->deleteDashboardColumn(<projectName>, <dashboardName>, <columnName>, {deleteWidgets ⇒ <0|1|true|false>, addToColumn ⇒ <column>});
ectool
syntax: ectool deleteDashboardColumn <projectName> <dashboardName> <columnName> --deleteWidgets <0|1|true|false> [--addToColumn <column>]
getDashboard
Get the specified dashboard.
You must specify the projectName
and dashboardName
.
Arguments | Descriptions |
---|---|
projectName |
Name of the project. This name must be unique among all projects. Argument Type: String |
dashboardName |
Unique name of the dashboard within the Argument Type: String |
includeDetails |
(Optional) < Boolean flag — When this argument is set to Argument Type: Boolean |
Response
Returns a dashboard object.
ec-perl
syntax: $<object>->getDashboard(<projectName>, <dashboardName>, {includeDetails ⇒ <0|1|true|false>]});
getDashboards
Get all dashboards or (optionally) dashboards for the specified project.
Arguments | Descriptions |
---|---|
projectName |
Name of the project. This name must be unique among all projects. Argument Type: String |
Response
Returns one or more dashboard objects.
modifyDashboard
Modifies an existing dashboard for the specified project.
You must specify the projectName
and dashboardName
.
Arguments | Descriptions | ||
---|---|---|---|
projectName |
Name of the project. This name must be unique among all projects. Argument Type: String |
||
dashboardName |
Unique name of the dashboard within the Argument Type: String |
||
clearColumns |
(Optional) < Boolean flag — When this argument is set to Argument Type: Boolean |
||
clearPhases |
(Optional) < Boolean flag —
When this argument is set to Argument Type: Boolean |
||
columns |
(Optional) List of the columns to display for the dashboard. Applies only to a Argument Type: Collection |
||
customize |
(Optional) < Boolean flag — Set to 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 Argument Type: DashboardLayout |
||
newName |
(Optional) New dashboard name. Argument Type: String |
||
phases |
(Optional) List of the phases to display for a dashboard of type
Argument Type: String |
||
type |
(Optional) Type of dashboard. Allowed types: 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).
|
Response
Returns an updated dashboard object.
modifyDashboardColumn
Modifies a dashboard column in a Command Center type of dashboard.
You must specify projectName
, dashboardName
, and column
.
Arguments | Descriptions |
---|---|
projectName |
Name of the project. This name must be unique among all projects. Argument Type: String |
dashboardName |
Unique name of the dashboard within the 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 Argument Type: String |
beforeColumn |
(Optional) Name of the column before which the column should be placed. If neither Argument Type: String |
Response
Returns an updated dashboard column object.
ec-perl
syntax: $<object>->modifyDashboardColumn(<projectName>, <dashboardName>, <column>, {<optionals>});
createDevOpsInsightDataSource
Creates a new data source for the specified project.
You must specify projectName
, releaseName
, and devOpsInsightDataSourceName
.
Arguments | Descriptions |
---|---|
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, 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 |
ec-perl
syntax: $<object>->createDevOpsInsightDataSource(<projectName>, <releaseName>, <devOpsInsightDataSourceName>, {<optionals>});
deleteDevOpsInsightDataSource
Delete the specified data source.
You must specify projectName
, releaseName
, and devOpsInsightDataSourceName
.
Arguments | Descriptions |
---|---|
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 |
ec-perl
syntax: $<object>->deleteDevOpsInsightDataSource(<projectName>, <releaseName>, <devOpsInsightDataSourceName>);
getDevOpsInsightDataSource
Get the specified data source.
You must specify projectName
, releaseName
, and devOpsInsightDataSourceName
.
Arguments | Descriptions |
---|---|
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 |
ec-perl
syntax: $<object>->getDevOpsInsightDataSource(<projectName>, <releaseName>, <devOpsInsightDataSourceName>, {includeDetails ⇒ <0|1|true|false>]});
getDevOpsInsightDataSources
Get all data sources or, optionally, data sources for the specified project.
You must specify projectName
and releaseName
.
Arguments | Descriptions |
---|---|
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 |
modifyDevOpsInsightDataSource
Modifies an existing data source for the specified project.
You must specify projectName
, releaseName
, and devOpsInsightDataSourceName
.
Arguments | Descriptions |
---|---|
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 |
ec-perl
syntax: $<object>->modifyDevOpsInsightDataSource(<projectName>, <releaseName>, <devOpsInsightDataSourceNameName>, {<optionals>});
createReport
Creates a new report for the specified project.
You must specify projectName
and reportName
.
Arguments | Descriptions |
---|---|
projectName |
Name of the project. This name must be unique among all projects. Argument Type: String |
reportName |
Unique name of the report within the 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, 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, 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 |
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"}' }, { }] ... }
deleteReport
Delete the specified report.
You must specify the projectName
and reportName
.
Arguments | Descriptions |
---|---|
projectName |
Name of the project. This name must be unique among all projects. Argument Type: String |
reportName |
Unique name of the report within the Argument Type: String |
getReport
Get the specified report.
You must specify projectName
and reportName
.
Arguments | Descriptions |
---|---|
projectName |
Name of the project. This name must be unique among all projects. Argument Type: String |
reportName |
Unique name of the report within the Argument Type: String |
Response
Returns a report object.
getReports
Get all reports from the specified project.
You must specify the projectName
.
Arguments | Descriptions |
---|---|
projectName |
Name of the project. This name must be unique among all projects. Argument Type: String |
Response
Returns all report objects for the specified project.
modifyReport
Creates a new report for the specified project.
You must specify the projectName
and reportName
.
Arguments | Descriptions |
---|---|
projectName |
Name of the project. This name must be unique among all projects. Argument Type: String |
reportName |
Unique name of the report within the 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, 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, 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, Argument Type: String |
Response
Returns a report object.
runReport
Run the specified report.
You must specify the projectName
and reportName
.
Arguments | Descriptions |
---|---|
projectName |
Name of the project. This name must be unique among all projects. Argument Type: String |
reportName |
Unique name of the report within the 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_ — When this argument is set to 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 |
Response
Returns a report object.
sendReportingData
Sends data to the CloudBees Analytics server.
You must specify reportObjectTypeName
and payload
.
Arguments | Descriptions |
---|---|
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 Default is Argument Type: Boolean |
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.
createReportingFilter
Creates a new reportingFilter
object.
Arguments | Descriptions |
---|---|
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:
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 Argument Type: String |
reportObjectTypeName |
(Optional) The name of the report object type. Argument Type: String |
required |
(Optional) < Boolean flag — Whether the filter is required and should be enforced on the client side UI. When this argument is set to Default is Argument Type: Boolean |
type |
(Optional) The attribute type. Possible values:
Attribute Type: String |
widgetName |
(Optional) Name of the widget within the dashboard, if the reporting filter belongs to a widget. Argument Type: String |
Response
Returns a reportingFilter object.
ec-perl
syntax: $cmdr->createReportingFilter(<projectName>, <dashboardName>, <reportingFilterName>, {<optionals>});
deleteReportingFilter
Deletes the specified reportReportingFilter
object.
Arguments | Descriptions |
---|---|
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 |
ec-perl
syntax: $cmdr->deleteReportingFilter(<projectName>, <dashboardName> , <reportingFilterName>);
getReportingFilter
Retrieves the specified reportingFilter
object.
Arguments | Descriptions |
---|---|
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 |
Response
Returns the specified reportingFilter object.
getReportingFilters
Retrieves the specified reportingFilter
objects.
Arguments | Descriptions |
---|---|
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 |
Response
Returns zero or more reportReportingFilter objects.
modifyReportingFilter
Modifies the specified reportReportingFilter
object.
Arguments | Descriptions |
---|---|
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:
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 Argument Type: String |
reportObjectTypeName |
(Optional) The name of the report object type. Argument Type: String |
type |
(Optional) The attribute type. Possible values:
Attribute Type: String |
required |
(Optional) < Boolean flag — Whether the filter is required and should be enforced on the client side UI. When this argument is set to Default is Argument Type: Boolean |
widgetName |
(Optional) Name of the widget within the dashboard, if the reporting filter belongs to a widget. Argument Type: String |
Response
Returns a reportingFilter object.
ec-perl
syntax: $cmdr->modifyReportingFilter(<projectName>, <dashboardName>, <reportingFilterName>, {<optionals>});
createReportObjectType
Creates a new reportObjectType
object.
You must specify reportObjectTypeName
.
Arguments | Descriptions |
---|---|
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 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 Argument type: ReportObjectTypeStoragePattern |
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' } }
deleteReportObjectType
Deletes the specified reportObjectType object.
Arguments | Descriptions |
---|---|
reportObjectTypeName |
The name of the reportObjectTypeName object to delete. Argument Type: String |
getReportObjectType
Retrieves the specified reportObjectType
object.
Arguments | Descriptions |
---|---|
reportObjectTypeName |
The name of the Argument Type: String |
includeDetails |
(Optional) < Boolean flag —
Argument Type: Boolean |
Response
Returns the specified reportObjectType object.
getReportObjectTypes
Retrieves all reportObjectType
objects.
Arguments | Descriptions |
---|---|
includeDetails |
(Optional) < Boolean flag —
Argument Type: Boolean |
Response
Returns zero or more reportObjectType objects.
modifyReportObjectType
Modifies the specified reportObjectType
object.
You must specify reportObjectTypeName
.
Arguments | Descriptions |
---|---|
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 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 Argument type: ReportObjectTypeStoragePattern |
Response
Returns an updated reportObjectType object.
createReportObjectAssociation
Creates a new reportObjectAssociation
object.
Arguments | Descriptions |
---|---|
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 — Whether the association between the report object type and associated type is always present. When this argument is set to Default is 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 |
Response
Returns a reportObjectAssociation object.
ec-perl
syntax: $cmdr->createReportObjectAssociation(<reportObjectTypeName>, <associatedType>, {<optionals>});
deleteReportObjectAssociation
Deletes the specified reportObjectAssociation
object.
Arguments | Descriptions |
---|---|
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 |
getReportObjectAssociation
Retrieves the specified reportObjectAssociation
object.
Arguments | Descriptions |
---|---|
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 |
Response
Returns the specified reportObjectAssociation object.
getReportObjectAssociations
Retrieves the associations for the specified reportObjectTypeName
object.
Arguments | Descriptions |
---|---|
reportObjectTypeName |
Report object type for which this association is defined. The association is owned by the specified report object type. Argument Type: String |
Response
Returns zero or more reportObjectAssociation objects.
modifyReportObjectAssociation
Modifies the specified reportObjectAssociation
object.
Arguments | Descriptions |
---|---|
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 — Whether the association between the report object type and associated type is always present. When this argument is set to Default is 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 |
Response
Returns a reportObjectAssociation object.
ec-perl
syntax: $cmdr->createReportObjectAssociation(<reportObjectTypeName>, <associatedType>, {<optionals>});
createReportObjectAttribute
Creates a new reportObjectAttribute
object.
Arguments | Descriptions |
---|---|
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 — When this argument is set to Argument type: Boolean |
type |
(Optional) The attribute type. Argument type: ReportObjectAttributeType. Possible values:
|
Response
Returns a reportObjectAttribute object.
ec-perl
syntax: $cmdr->createReportObjectAttribute(<reportObjectAttributeName>, <reportObjectTypeName>{<optionals>});
deleteReportObjectAttribute
Deletes the specified reportObjectAttribute
object.
Arguments | Descriptions |
---|---|
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 |
ec-perl
syntax: $cmdr->deleteReportObjectAttribute(<ReportObjectAttributeName>, <reportObjectTypeName>);
getReportObjectAttribute
Retrieves the specified reportObjectAttribute
object.
Arguments | Descriptions |
---|---|
reportObjectTypeName |
The name of the report object type to which this attribute belongs. Argument Type: String |
reportObjectAttributeName |
The name of the Argument Type: String |
ec-perl
syntax: $cmdr->getReportObjectAttribute(<reportObjectTypeName>, <reportObjectAttributeName>);
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.
Arguments | Descriptions |
---|---|
reportObjectTypeName |
The name of the report object type to which this attribute belongs. Argument Type: String |
reportObjectAttributeName |
The name of the Argument Type: String |
fromIndex |
The index of the first value to be retrieved, numbered from Argument type: Number |
maxValues |
The maximum number of values to return at a time. If not specified, Argument type: Number |
valueStartsWith |
String with which values begin. Argument Type: String |
Response
total |
The total number of items returned in the |
|
values |
The list of |
|
|
The values, one element per value. |
ec-perl
syntax: $cmdr->getReportObjectAttributeValues(<reportObjectTypeName>, <reportObjectAttributeName>);
getReportObjectAttributes
Retrieves the specified reportObjectAttribute
objects.
Arguments | Descriptions |
---|---|
reportObjectTypeName |
The name of the report object type to which the attributes belong. Argument type: string |
modifyReportObjectAttribute
Modifies the specified reportObjectAttribute
object.
Arguments | Descriptions |
---|---|
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 — When this argument is set to Argument Type: Boolean |
type |
(Optional) The attribute type. Argument type: ReportObjectAttributeType. Possible values:
|
Response
Returns a reportObjectAttribute object.
ec-perl
syntax: $cmdr->modifyReportObjectAttribute(<ReportObjectTypeName>, <ReportObjectAttributeName>, {<optionals>});
createWidget
Creates a new widget for the specified dashboard and project .
You must specify projectName
, dashboardName
, widgetName
, and reportName
.
Arguments | Descriptions | ||
---|---|---|---|
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 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
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 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: 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 |
Response
Returns a widget object.
ec-perl
syntax: $<object>->createWidget(<projectName>, <dashboardName>, <widgetName>, <reportName>,< {<optionals>});
deleteWidget
Delete the specified widget.
You must specify the projectName
, dashboardName
, and widgetName
Arguments | Descriptions |
---|---|
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 |
getWidget
Get the specified widget.
You must specify projectName
, dashboardName
, and widgetName.
Arguments | Descriptions |
---|---|
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 |
Response
Returns a widget object.
getWidgets
Get all widgets for the specified project and dashboard
You must specify projectName
, and dashboardName
.
Arguments | Descriptions |
---|---|
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 |
Response
Returns all widget objects for the specified project and dashboard.
modifyWidget
Modify an existing widget for the specified dashboard.
You must specify the projectName
, dashboardName
, and widgetName
.
Arguments | Descriptions | ||
---|---|---|---|
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 — Argument Type: Boolean |
||
clearAttributePaths |
(Optional) < Boolean flag — Argument Type: String |
||
clearColors |
(Optional) < Boolean flag — Argument Type: String |
||
clearLinkParameters |
(Optional) < Boolean flag — Argument Type: String |
||
clearVisualizationProperties |
(Optional) < Boolean flag — 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 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
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 |
Response
Returns a widget object.
ec-perl
syntax: $<object>->modifyWidget(<projectName>, <dashboardName>, <widgetName>, <reportName>,< {<optionals>});
moveWidget
Moves a widget within a dashboard.
You must specify the projectName
, dashboardName
, and widgetName
.
Arguments | Descriptions |
---|---|
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
If you do not specify
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
Do not specify the Argument Type: WidgetSection |
createWidgetFilterOverride
Creates a new widgetFilterOverride
object.
Arguments | Descriptions |
---|---|
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 — Whether to ignore the dashboard filter and not apply it to the report. All other arguments are ignored if this argument is set to Default is 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 |
Response
Returns a widgetFilterOverride object.
ec-perl
syntax: $cmdr->createWidgetFilterOverride(<projectName>, <dashboardName> , <widgetName>, <dashboardFilterName>, {<optionals>});
deleteWidgetFilterOverride
Deletes the specified reportWidgetFilterOverride
object.
Arguments | Descriptions |
---|---|
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 |
ec-perl
syntax: $cmdr->deleteWidgetFilterOverride(<projectName>, <dashboardName> , <widgetName>, <dashboardFilterName>);
getWidgetFilterOverride
Retrieves the specified widgetFilterOverride
object.
Arguments | Descriptions |
---|---|
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 |
Response
Returns the specified widgetFilterOverride object.
ec-perl
syntax: $cmdr->getWidgetFilterOverride(<projectName>, <dashboardName> , <widgetName>, <dashboardFilterName>, {<optionals>});
getWidgetFilterOverrides
Retrieves the specified widgetFilterOverride
objects.
Arguments | Descriptions |
---|---|
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 |
Response
Returns zero or more widgetFilterOverride objects.
modifyWidgetFilterOverride
Modifies the specified widgetFilterOverride
object.
Arguments | Descriptions |
---|---|
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 — Whether to ignore the dashboard filter and not apply it to the report. All other arguments are ignored if this argument is set to Default is 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 |
Response
Returns a widgetFilterOverride object.
ec-perl
syntax: $cmdr->modifyWidgetFilterOverride((<projectName>, <dashboardName> , <widgetName>, <dashboardFilterName>, {<optionals>});