Index
aclaclEntryactualParameteraddCredentialapplicationapplicationDependencyapplicationTierarchiveConnectorartifactartifactVersioncatalogcatalogItemciConfigurationclustercomplianceConfigurationcomponentcredentialcredentialProviderdashboarddataRetentionPolicydeployerApplicationdeployerConfigurationdevOpsInsightDataSourcedevOpsInsightServerConfigurationdirectoryProvideremailConfigemailNotifierenvironmentenvironmentTemplateenvironmentTemplateTierenvironmentTemplateTierMapenvironmentTemplateTierMappingenvironmentTierformalOutputParameterformalParametergategatewaygrouphookjobjobSteplicensemicroservicemicroserviceMappingnoteopenIDConnectConfigurationpersonapersonaCategorypersonaPagepipelinepluginpluginConfigurationprocedureprocessprocessDependencyprocessStepprojectpropertyreleasereportreportingFilterreportObjectAssociationreportObjectAttributereportObjectTyperepositoryreservationresourceresourcePoolresourceTemplaterollingDeployPhasesamlIdentityProvidersamlServiceProviderschedulescmSyncsearchFilterserviceAccountsnapshotstagestateDefinitionsteptagtasktierMaptierMappingtransitionDefinitiontriggeruseruserEmailutilityResourcewaitDependencywidgetwidgetFilterOverrideworkflowDefinitionworkspacezone

widget

On this page
Back to index

Summary

Dashboard widget.
dashboardName
Stringrequired
Unique name of the dashboard within the project.
projectName
Stringrequired
The name for the project that must be unique among all projects.
widgetName
Stringrequired
The name of the dashboard widget.
actualParameters
Stringoptional
Actual parameter values for the parameters defined on the widget's report. (Alternate argument name actualParameter.)
afterWidget
Stringoptional
The name of the widget after which this widget should be placed.
attributeDataTypes
Stringoptional
Widget parameters used by UI to control data types of attributes. (Alternate argument name attributeDataType.)
attributePaths
Stringoptional
Widget parameters used by UI to control paths of attributes. (Alternate argument name attributePath.)
beforeWidget
Stringoptional
The name of the widget before which this widget should be placed.
clearAttributeDataTypes
Stringoptional
Whether or not to clear attribute data types for the widget.
clearAttributePaths
Stringoptional
Whether or not to clear attribute paths for the widget.
clearColors
Stringoptional
Whether or not to clear color for the widget.
clearLinkParameters
Stringoptional
Whether or not to clear link parameters for the widget.
clearVisualizationProperties
Stringoptional
Whether or not to clear visualization properties for the widget.
colorRanges
Stringoptional
The JSON with color ranges definition for the widget.
colors
Stringoptional
Color map used when rendering the widget. The usage of the color map depends on the widget's visualization type. (Alternate argument name color.)
column
Stringoptional
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.
description
Stringoptional
Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
iconUrl
Stringoptional
The icon to display for the widget. Enclose the IPV6 address in square brackets. Example: [<IPv6-ADDRESS>].
linkParameters
Stringoptional
Widget parameters used by UI to construct the drill-down link for the widget. (Alternate argument name linkParameter.)
linkTarget
Stringoptional
Determines the page to navigate to when the user drills down through the dashboard widget.
newName
Stringoptional
The new name for an existing object that is being renamed.
orderIndex
Stringoptional
Specifies the relative display order for the widget.
reportName
Stringoptional
Name of an existing report backing the widget.
reportProjectName
Stringoptional
Set if the report is in a different project than the dashboard.
section
Stringoptional
The section of a COMMAND_CENTER dashboard to display the widget in. Applicable for a COMMAND_CENTER dashboard widget.
title
Stringoptional
The title to display for the widget. If not set, use the report title.
visualization
Stringoptional
Type of visualization data in the widget.
visualizationProperties
Stringoptional
Properties or settings used by the widget's visualization type. (Alternate argument name visualizationProperty.)

Usage

There are no usage examples available for widget.