CRM Analytics REST API Developer Guide
jNewer Version Available
Dashboard State Representation
This page contains the reference for the DashboardStateRepresentation resource and all
the representations that make up the dashboard state for API responses. The following
representation details are not REST API endpoints on their own, but describe object
representations used in REST API response bodies.
DashboardStateRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| dataSourceLinks | DashboardDataSourceLinkRepresentation[] | The list of all datasource links in a dashboard. | Small, 39.0 | DEPRECATED 39.0-56.0 |
| dataSourceLinksInfo | DashboardDataSourceLinksInfoRepresentation[] | The list of datasource links information used as part of the dashboard. | Small, 57.0 | 57.0 |
| filters | FilterItemRepresentation[] | The list of datasource filters applied in this dashboard. | Small, 41.0 | 41.0 |
| gridLayouts | GridLayoutRepresentation[] | The list of all grid layouts for this dashboard. This property replaces the 'layouts' property and the two are mutually exclusive. | Small, 36.0 | 36.0 |
| layouts | LayoutRepresentation[] | DEPRECATED The list of layouts for this dashboard. The gridLayouts parameter replaces this list. | Small, 36.0 | 36.0 |
| parameters | ParameterItemRepresentation[] | The list of parameters created for this dashboard. | Small, 58.0 | 58.0 |
| steps | Map<String, StepRepresentation> | The map of steps used to create this dashboard. The key string is the step name.
Valid step types are:
|
Small, 36.0 | 36.0 |
| widgetStyle | GridLayoutWidgetStyleRepresentation | Default styling for widgets in this dashboard. | Small, 37.0 | 37.0 |
| widgets | Map<String, DashboardWidgetRepresentation | The map of widgets used to create this dashboard. The key string is the widget name. | Small, 36.0 | 36.0 |
DashboardDataSourceLinkRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| fields | DashboardDataSourceFieldRepresentation[] | The list of fields connected in the data source link. | Small, 39.0 | 39.0 |
| label | String | The label of the data source link. | Small, 39.0 | 39.0 |
| name | String | The name of the data source link. | Small, 39.0 | 39.0 |
DashboardDataSourceLinksInfoRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| enableAutomaticLinking | Boolean | Indicates whether automatic linking is enabled for the dashboard (true) or not (false). | Small, 57.0 | 57.0 |
| excludeRelationships | DashboardDataSourceRelationshipRepresentation[] | The list of data source exclude relationships from faceting in the dashboard. | Small, 57.0 | 57.0 |
| links | DashboardDataSourceLinkRepresentation[] | The list of data source links for the dashboard. | Small, 57.0 | 57.0 |
DashboardDataSourceRelationshipRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| fromDataSource | String | The fully qualified name of the "from" data source. | Small, 57.0 | 57.0 |
| fromDataSourceType | ConnectWaveDataSourceTypeEnum | The type of the "from" data source. Valid values are:
|
Small, 57.0 | 57.0 |
| toDataSource | String | The fully qualified name of the "to" data source. | Small, 57.0 | 57.0 |
| toDataSourceType | ConnectWaveDataSourceTypeEnum | The type of the "to" data source. Valid values are:
|
Small, 57.0 | 57.0 |
DashboardDataSourceFieldRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| dataSourceName | String | The datasource developer name. | Small, 39.0 | 39.0 |
| dataSourceNamespace | String | The namespace that qualifies the dataset name | Small, 39.0 | 39.0 |
| dataSourceType | ConnectWaveDataSourceTypeEnum | The type of datasource. Valid values are:
|
Small, 39.0 | 39.0 |
| fieldName | String | The name of field in the datasource | Small, 39.0 | 39.0 |
FilterItemRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| cdpObject | String | The cdp datasource the filter applies to. | Small, 55.0 | 55.0 |
| dataset | AssetReferenceRepresentation | The datasource to apply the filter to. | Small, 41.0 | 41.0 |
| fields | String[] | The list of fields in filter. | Small, 41.0 | 41.0 |
| hidden | Boolean | Indicates whether the filter is hidden in view mode (true) or not (false). | Small, 41.0 | 41.0 |
| label | String | The label of the filter. | Small, 41.0 | 41.0 |
| locked | Boolean | Indicates whether the filter is locked (true) or not (false). | Small, 41.0 | 41.0 |
| operator | String | The operator for the filter. | Small, 41.0 | 41.0 |
| sObject | String | The sObject datasource the filter applies to. | Small, 55.0 | 55.0 |
| value | String | The value for the filter. | Small, 41.0 | 41.0 |
GridLayoutWidgetStyleRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| backgroundColor | String | The background color for the widget. This is a 6 character hex string. For example: #012345. | Small, 36.0 | 36.0 |
| borderColor | String | The color of the widget's border. This is a 6 character hex string. For example: #012345. | Small, 36.0 | 36.0 |
| borderEdges | ConnectWaveBorderEdgeTypeEnum[] | The edges of the border to be drawn.
Valid values are:
|
Small, 36.0 | 36.0 |
| borderRadius | Object | The border radius of the widget. | Small, 36.0 | 36.0 |
| borderWidth | Object | The width of the widget's border. | Small, 36.0 | 36.0 |
| bottomPadding | Integer | The amount of padding on the bottom of the widget when rendered on mobile clients. | Small, 36.0 | 36.0 |
| leftPadding | Integer | The amount of padding on the left of the widget when rendered on mobile clients. | Small, 36.0 | 36.0 |
| rightPadding | Integer | The amount of padding on the right of the widget when rendered on mobile clients. | Small, 36.0 | 36.0 |
| topPadding | Integer | The amount of padding on the top of the widget when rendered on mobile clients. | Small, 36.0 | 36.0 |
GridLayoutRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| maxWidth | Integer | Add the ability for users to specify the maximum width that their dashboard can flex to. | Small, 38.0 | 38.0 |
| name | String | The name of this layout. | Small, 36.0 | 36.0 |
| numColumns | Integer | Add the number of columns for a dashboard grid layout that is customizable. | Small, 38.0 | 38.0 |
| pages | GridLayoutPageRepresentation[] | The list of pages of widgets within the layout. | Small, 36.0 | 36.0 |
| rowHeight | ConnectWaveRowHeightEnum | Specifies the grid cell row height. Valid
values are:
|
Small, 39.0 | 39.0 |
| selectors | String[] | The list of selectors this layout applies to. | Small, 36.0 | 36.0 |
| style | GridLayoutStyleRepresentation | The styling for the layout. | Small, 37.0 | 37.0 |
| version | Double | Version of this layout. | Small, 36.0 | 36.0 |
| widgetStyle | GridLayoutWidgetStyleRepresentation | DEPRECATED The default styling for widgets within the layout. | Small, 36.0 | 36.0���37.0 |
GridLayoutPageRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| label | String | The display label for the page. | Small, 41.0 | 41.0 |
| name | String | The unique id for a page within a layout. | Small, 41.0 | 41.0 |
| navigationHidden | Boolean | Indicates whether the page is hidden in the navigation widget (true) or not (false). | Small, 44.0 | 44.0 |
| widgets | GridLayoutWidgetRepresentation[] | Widgets within the page. | Small, 36.0 | 36.0 |
GridLayoutWidgetRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| backgroundImage | String | The background image for the widget. | Small, 36.0 | 36.0 |
| colspan | Integer | The number of grid layout columns this widget spans. | Small, 36.0 | 36.0 |
| column | Integer | The column where this widget is located. | Small, 36.0 | 36.0 |
| name | String | The name of the widget. | Small, 36.0 | 36.0 |
| parameterOverrides | Object | The overrides for the widget parameters. | Small, 59.0 | 59.0 |
| row | Integer | The row where this widget is located. | Small, 36.0 | 36.0 |
| rowspan | Integer | The number of grid layout rows this widget spans. | Small, 36.0 | 36.0 |
| type | ConnectWaveWidgetTypeEnum | The widget type. Valid values are:
|
Small, 59.0 | 59.0 |
| widgetStyle | GridLayoutWidgetStyleRepresentation | The style of the widget. | Small, 36.0 | 36.0 |
GridLayoutStyleRepresentation
GridLayoutStyleRepresentation inherits properties from the abstract ImageParametersRepresentation. These base properties appear in GridLayoutStyleRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| backgroundColor | String | The background color for the layout. | Small, 36.0 | 36.0 |
| cellSpacingX | Integer | The horizontal spacing between grid cells. | Small, 36.0 | 36.0 |
| cellSpacingY | Integer | The vertical spacing between grid cells. | Small, 36.0 | 36.0 |
| gutterColor | String | The gutter color for the layout. | Small, 36.0 | 36.0 |
ParameterItemRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| defaultValue | Object | The default value of the parameter. | Small, 58.0 | 58.0 |
| description | String | The description of the parameter. | Small, 58.0 | 58.0 |
| label | String | The label of the parameter. | Small, 58.0 | 58.0 |
| name | String | The name of the parameter. | Small, 58.0 | 58.0 |
ImageParametersRepresentation
ImageParametersRepresentation inherits properties from the abstract WidgetParametersRepresentation. These base properties appear in ImageParametersRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| alignmentX | ConnectWaveHorizontalAlignmentEnum | The alignment of the text. Valid values are:
|
Small, 37.0 | 37.0 |
| alignmentY | ConnectWaveVerticalAlignmentEnum | The vertical alignment types.Valid values are:
|
Small, 37.0 | 37.0 |
| documentId | String | The document id of the image. | Small, 37.0 | 37.0 |
| fit | ConnectWaveImageFitTypeEnum | The image alignment types. Valid values are:
|
Small, 37.0 | 37.0 |
| image | AssetReferenceRepresentation | The image representation containing the name and the namespace. | Small, v39.0 | 39.0 |
LayoutRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| device | ConnectWaveLayoutDeviceTypeEnum | The device rendering this dashboard. Valid values are:
|
Small, 36.0 | 36.0 |
| orientation | ConnectWaveLayoutOrientationTypeEnum | The layout orientation of this dashboard. Valid values are:
|
Small, 36.0 | 36.0 |
| pages | LayoutPageRepresentation[] | The list of layout pages available for the dashboard. | Small, 36.0 | 36.0 |
| version | Double | The version of the layout for the dashboard. | Small, 36.0 | 36.0 |
LayoutPageRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| rows | String[] | The rows associated with a layout page. | Small, 36.0 | 36.0 |
AggregateStepRepresentation
AggregateStepRepresentation inherits properties from the abstract QueryStepRepresentation. These base properties appear in AggregateStepRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| isFacet | Boolean | Indicates whether this step is a global filter which can be faceted to other steps or widgets in the dashboard (true) or not (false). | Small, 36.0 | 36.0 |
AggregateFlexStepRepresentation
AggregateFlexStepRepresentation inherits properties from the abstract QueryStepRepresentation. These base properties appear in AggregateFlexStepRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| broadcastFacet | Boolean | Indicates whether this step broadcasts faceting filters to other steps on the dashboard (true) or not (false). | Small, 41.0 | 41.0 |
| cdpObject | String | The name of the CDP object used for the query. | Small, 54.0 | 54.0-57.0 |
| cdpObjects | String[] | A list of the CDP object names used for the query. | Small, 58.0 | 58.0 |
| connectionName | String | The name of the connection used for steps powered by external data. | Small, 48.0 | 48.0 |
| dataspace | String | The dataspace name for CDP objects. | Small, 61.0 | 61.0 |
| receiveFacetSource | ReceiveFacetSourceRepresentation | The receive facet configurations. | Small, 41.0 | 41.0-47.0 |
| sobject | String | The name of the sObject used for a SOQL query. | Small, 47.0 | 47.0 |
| values | Map<String, DynamicValueRepresentation> | A map of dynamic data values. | Small, 57.0 | 57.0 |
ApexStepRepresentation
ApexStepRepresentation inherits properties from the abstract StepRepresentation. These base properties appear in ApexStepRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| query | ApexStepQueryRepresentation | The queries to run for this step. | Small, 41.0 | 41.0 |
CdpStepRepresentation
CdpStepRepresentation inherits properties from the abstract FlexMetadataStepRepresentation. These base properties appear in CdpStepRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| broadcastFacet | Boolean | Indicates whether this step broadcasts faceting filters to other steps on the dashboard (true) or not (false). | Small, 54.0 | 54.0 |
| dataspace | String | The dataspace name for CDP objects. | Small, 61.0 | 61.0 |
| query | String | The query for the step. | Small, 54.0 | 54.0 |
| receiveFacetSource | ReceiveFacetSourceRepresentation | The receive facet source configuration | Small, 54.0 | 54.0 |
| start | String | The start value for the step. | Small, 54.0 | 54.0 |
| useGlobal | Boolean | Indicates whether this step is faceted to the global step. | Small, 54.0 | 54.0 |
| values | Map<String, DynamicValueRepresentation> | A map of dynamic data values. | Small, 59.0 | 59.0 |
| visualizationParameters | StepVisualizationParametersRepresentation | The parameters for the step visualization. | Small, 54.0 | 54.0 |
DirectReportStepRepresentation
DirectReportStepRepresentation inherits properties from the abstract StepRepresentation. These base properties appear in DirectReportStepRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| broadcastFacet | Boolean | Indicates whether this step broadcasts faceting filters to other steps on the dashboard (true) or not (false). | Small, 56.0 | 56.0 |
| query | DirectReportStepQueryRepresentation | The query to run for this step. | Small, 53.0 | 53.0 |
| receiveFacetSource | ReceiveFacetSourceRepresentation | The receive facet configuration. | Small, 56.0 | 56.0 |
| start | String | The start value for the step. | Small, 56.0 | 56.0 |
| useGlobal | Boolean | Indicates whether this step gets tied to the global step (true) or not (false). | Small, 56.0 | 56.0 |
| visualizationParameters | StepVisualizationParametersRepresentation | The parameters for the step visualization. | Small, 56.0 | 5.0 |
ForecastingStepRepresentation
ForecastingStepRepresentation inherits properties from the abstract StepRepresentation. These base properties appear in ForecastingStepRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| query | ForecastingStepQueryRepresentation | The query to run for this step. | Small, 59.0 | 59.0 |
GrainStepRepresentation
GrainStepRepresentation inherits properties from the abstract QueryStepRepresentation. These base properties appear in GrainStepRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| isFacet | Boolean | Indicates whether this step is a global filter which can be faceted to other steps or widgets in the dashboard (true) or not (false). | Small, 41.0 | 41.0 |
| query | ApexStepQueryRepresentation | The queries to run for this step. | Small, 41.0 | 41.0 |
HierarchyStepRepresentation
HierarchyStepRepresentation inherits properties from the abstract StepRepresentation. These base properties appear in HierarchyStepRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| filterField | String | The filter field to pass to the role hierarchy evaluation. | Small, 55.0 | 55.0 |
| hierarchyType | HierarchyTypeEnum | The type of hierarchy used to facet. Valid values are:
|
Small, 55.0 | 55.0 |
| query | HierarchyStepQueryRepresentation | The query parameters to pass to the role hierarchy evaluation. | Small, 55.0 | 55.0 |
HierarchyStepQueryRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| limit | Integer | The maximum amount of results to return for this step. | Small, 55.0 | 55.0 |
InputStepRepresentation
InputStepRepresentation inherits properties from the abstract StepRepresentation. These base properties appear in InputStepRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| start | String | The start value for the step. | Small, 56.0 | 56.0 |
| valueType | ConnectWaveInputWidgetValueFormatEnum | The value type of the step. Valid values are:
|
Small, 56.0 | 56.0 |
| values | InputStepValuesRepresentation[] | The list of values for the step. | Small, 56.0 | 56.0 |
InputStepValuesRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| max | String | The max column in values. | Small, 56.0 | 56.0 |
| min | String | The min column in values. | Small, 56.0 | 56.0 |
LensStepRepresentation
LensStepRepresentation inherits properties from the abstract StepRepresentation. These base properties appear in LensStepRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| source | AssetReferenceRepresentation | The lens source for this step. | Small, 50.0 | 50.0 |
MultiQueryStepRepresentation
MultiQueryStepRepresentation inherits properties from the abstract StepRepresentation. These base properties appear in MultiQueryStepRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| columns | ColumnRepresentation[] | The list of queries to run for this step. | Small, 36.0 | 36.0 |
| datasets | AssetReferenceRepresentation[] | The list of datasets used by this step. | Small, 36.0 | 36.0 |
| globalQuery | Query[] | The query override for all columns. | Small, 41.0 | 41.0 |
| isFacet | Boolean | Indicates whether this step is a global filter which can be faceted to other steps or widgets in the dashboard (true) or not (false). | Small, 41.0 | 41.0 |
| isGlobal | Boolean | Indicates whether this step is a global filter which can be faced to other steps or widgets in the dashboard (true) or not (false). | Small, 36.0 | 36.0 |
| start | String | The start value for the step. | Small, 36.0 | 36.0 |
| useGlobal | Boolean | Indicates whether this step gets tied to the global step (true) or not (false). | Small, 36.0 | 36.0 |
| visualizationParameters | StepVisualizationParametersRepresentation | The parameters for the step visualization. | Small, 36.0 | 36.0 |
SqlStepRepresentation
SqlStepRepresentation inherits properties from the abstract FlexMetadataStepRepresentation. These base properties appear in SqlStepRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| broadcastFacet | Boolean | Indicates whether this step broadcasts faceting filters to other steps on the dashboard (true) or not (false). | Small, 51.0 | 51.0 |
| connectionName | String | The name of the connection for the step. | Small, 51.0 | 51.0 |
| query | String | The query for the step. | Small, 51.0 | 51.0 |
| receiveFacetSource | ReceiveFacetSourceRepresentation | The receive facet configuration. | Small, 52.0 | 52.0 |
| start | String | The start value for the step. | Small, 51.0 | 51.0 |
| useGlobal | Boolean | Indicates whether this step is tied to the global step (true) or not (false). | Small, 53.0 | 53.0 |
| visualizationParameters | StepVisualizationParametersRepresentation | The parameters for the step visualization. | Small, 51.0 | 51.0 |
SaqlStepRepresentation
SaqlStepRepresentation inherits properties from the abstract FlexMetadataStepRepresentation. These base properties appear in SaqlStepRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| broadcastFacet | Boolean | Indicates whether this step broadcasts faceting filters to other steps on the dashboard (true) or not (false). | Small, 41.0 | 41.0 |
| query | String | The SAQL query for the step. | Small, 39.0 | 39.0 |
| receiveFacetSource | ReceiveFacetSourceRepresentation | The receive facet source configuration | Small, 48.0 | 48.0 |
| start | String | The start value for the step. | Small, 39.0 | 39.0 |
| useGlobal | Boolean | Indicates whether this step is faceted to the global step. | Small, 39.0 | 39.0 |
| values | Map<String, ReceiveFacetSourceRepresentation> | A map of dynamic data values. | Small, 57.0 | 57.0 |
| visualizationParameters | StepVisualizationParametersRepresentation | The parameters for the step visualization. | Small, 40.0 | 40.0 |
SoqlStepRepresentation
SoqlStepRepresentation inherits properties from the abstract FlexMetadataStepRepresentation. These base properties appear in SoqlStepRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| broadcastFacet | Boolean | Indicates whether the step broadcasts faceting (true) or not (false). | Small, 55.0 | 55.0 |
| isFacet | Boolean | Indicates whether this step is faceted to other steps on the dashboard (true) or not (false). | Small, 39.0 | 39.0 |
| query | String | The query for the step. | Small, 39.0 | 39.0 |
| receiveFacetSource | ReceiveFacetSourceRepresentation | The receive facet source configuration. | Small, 55.0 | 55.0 |
| start | String | The start value for the step. | Small, 39.0 | 39.0 |
| useGlobal | Boolean | Indicates whether this step gets tied to the global step (true) or not (false). | Small, 39.0 | 39.0 |
| visualizationParameters | StepVisualizationParametersRepresentation | The parameters for step visualization. | Small, 55.0 | 55.0 |
StaticStepRepresentation
StaticStepRepresentation inherits properties from the abstract StepRepresentation. These base properties appear in StaticStepRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| datasets | AssetReferenceRepresentation[] | The list of datasets used by this step. | Small, 36.0 | 36.0 |
| dimensions | String[] | A list of dimensions for the step. | Small, 36.0 | 36.0 |
| isFacet | Boolean | Indicates whether this step is faceted to other steps on the dashboard (true) or not (false). | Small, 36.0 | 36.0 |
| isGlobal | Boolean | Indicates whether this step is a global filter which can be faceted to other steps or widgets in the dashboard (true) or not (false). | Small, 36.0 | 36.0 |
| start | String | The start value for the step. | Small, 36.0 | 36.0 |
| useGlobal | Boolean | Indicates whether this step gets tied to the global step (true) or not (false). | Small, 36.0 | 36.0 |
| visualizationParameters | StepVisualizationParametersRepresentation | The parameters for the step visualization. | Small, 36.0 | 36.0 |
StaticFlexStepRepresentation
StaticFlexStepRepresentation inherits properties from the abstract FlexMetadataStepRepresentation. These base properties appear in StaticFlexStepRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| broadcastFacet | Boolean | Indicates whether this step broadcasts faceting filters to other steps on the dashboard (true) or not (false). | Small, 41.0 | 41.0 |
| columns | StaticFlexStepColumnRepresentation | The metadata about the columns used in values. | Small, 47.0 | 47.0 |
| isGlobal | Boolean | Indicates whether this step is a global filter which can be faced to other steps or widgets in the dashboard (true) or not (false). | Small, 36.0 | 36.0 |
| start | String | The start value for the step. | Small, 39.0 | 39.0 |
| useGlobal | Boolean | Indicates whether this step gets tied to the global step (true) or not (false). | Small, 39.0 | 39.0 |
| visualizationParameters | StepVisualizationParametersRepresentation | The parameters for the step visualization. | Small, 40.0 | 40.0 |
QueryStepRepresentation
QueryStepRepresentation inherits properties from the abstract StepRepresentation. These base properties appear in QueryStepRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| datasets | AssetReferenceRepresentation[] | The list of datasets used by this step. | Small, 36.0 | 36.0 |
| isGlobal | Boolean | Indicates whether this step is a global filter which can be faced to other steps or widgets in the dashboard (true) or not (false). | Small, 36.0 | 36.0 |
| query | Query | The query to run for this step. | Small, 36.0 | 36.0 |
| start | String | The start value for the step. | Small, 36.0 | 36.0 |
| useGlobal | Boolean | Indicates whether this step gets tied to the global step (true) or not (false). | Small, 36.0 | 36.0 |
| visualizationParameters | StepVisualizationParametersRepresentation | The parameters for the step visualization. | Small, 36.0 | 36.0 |
FlexMetadataStepRepresentation
FlexMetadataStepRepresentation inherits properties from the abstract StepRepresentation. These base properties appear in FlexMetadataStepRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| groups | Object | The columns that are also groups. | Small, 39.0 | 39.0 |
| numbers | Object | The number columns. | Small, 39.0 | 39.0 |
| strings | Object | The string columns. | Small, 39.0 | 39.0 |
StepRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| label | String | The display label for the step. | Small, 36.0 | 36.0 |
| selectMode | ConnectWaveSelectModeEnum | The select mode types. Valid values are:
|
Small, 36.0 | 36.0 |
| type | ConnectWaveDashboardStepTypeEnum | The type of dashboard step. Valid values are:
|
Small, 36.0 | 36.0 |
ApexStepQueryRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| body | Object | The body for the Apex request. | Small, 41.0 | 41.0 |
| path | String | The path to the Apex controller. | Small, 41.0 | 41.0 |
DirectReportStepQueryRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| metadata | Object | The metadata for the query. | Small, 53.0 | 53.0 |
| mode | DirectReportModeEnum | The query mode. Valid values are:
|
Small, 53.0 | 53.0 |
| reportId | String | The ID for the query report. | Small, 53.0 | 53.0 |
ForecastingStepQueryRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| forecastTypeId | String | The forecast type for the query. | Small, 59.0 | 59.0 |
| startDate | Object | The start date for the query. | Small, 59.0 | 59.0 |
| territoryId | String | The territory ID for the query. | Small, 59.0 | 59.0 |
| userId | String | The user ID for the query. | Small, 59.0 | 59.0 |
StaticFlexStepColumnRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| aggregateFunction | String | The aggregate function for the column. | Small, 47.0 | 47.0 |
| dataset | AssetReferenceRepresentation | The dataset used in the column. | Small, 47.0 | 47.0 |
| field | String | The aggregate field for the column. | Small, 47.0 | 47.0 |
| type | ConnectWaveDashboardStaticStepColumnTypeEnum | The column type. Valid values are
|
Small, 47.0 | 47.0 |
StepVisualizationParametersRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| options | LensVisualizationOptions | The configuration options for different lens visualizations. Valid values
are:
|
Small, 36.0 | 36.0 |
| parameters | Object | Valid widget parameters based on its type. | Small, 40.0 | 40.0 |
| type | ConnectWaveWidgetTypeEnum | The type of the widget. Valid values are:
|
Small, 40.0 | 40.0 |
| visualizationType | String | The type of visualization. Valid values are:
|
Small, 36.0 | 36.0 |
ReceiveFacetSourceRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| mode | ConnectWaveDashboardStepReceiveFacetModeTypeEnum | The type of receive facet mode. Valid values are:
|
Small, 48.0 | 48.0 |
| steps | String[] | A list of steps that the current step receives or omits faceting from. | Small, 48.0 | 48.0 |
DashboardWidgetRepresentation
BoxWidgetParametersRepresentation
BoxWidgetParametersRepresentation inherits properties from the abstract WidgetParametersRepresentation. These base properties appear in BoxWidgetParametersRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| backgroundColor | String | The background color of the widget. | Small, 36.0 | 36.0 |
| borderColor | String | The border color of the widget. | Small, 36.0 | 36.0 |
| imageUrl | String | A 15-character or 18-character Salesforce document ID. | Small, 36.0 | 36.0 |
| stretch | Boolean | Indicates whether to stretch the widget. | Small, 36.0 | 36.0 |
CompareTableWidgetParametersRepresentation
CompareTableWidgetParametersRepresentation inherits properties from the abstract WidgetParametersRepresentation. These base properties appear in CompareTableWidgetParametersRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| exploreLink | Boolean | Indicates whether exploreLink is on (true) or not (false). | Small, 36.0 | 36.0 |
| maxColumnWidth | Integer | The maximum width of the header column. | Small, 36.0 | 36.0 |
| minColumnWidth | Integer | The minimum width of the header column. | Small, 36.0 | 36.0 |
| step | String | The step name tied to this widget. | Small, 36.0 | 36.0 |
| totals | Boolean | Indicates whether to use totals. | Small, 36.0 | 36.0 |
ComponentWidgetParametersRepresentation
ComponentWidgetParametersRepresentation inherits properties from the abstract WidgetParametersRepresentation. These base properties appear in ComponentWidgetParametersRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| attributes | Object<String, Object> | The map of this component's attribute values. | Small, 51.0 | 51.0 |
| dynamicAttributes | Object<String, Object> | The map of this component's dynamic attribute values. | Small, 59.0 | 59.0 |
| pageName | String | The default page of this widget. | Small, 50.0 | 50.0 |
| shareState | Boolean | Indicates whether this component widget shares state with the parent dashboard (true) or not (false). | Small, 51.0 | 51.0 |
| source | TypedAssetReferenceRepresentation[] | The component definition for this component widget. | Small, 46.0 | 46.0 |
| step | String | The attached step for this component widget. | Small, 51.0 | 51.0 |
ContainerWidgetParametersRepresentation
ContainerWidgetParametersRepresentation inherits properties from the abstract ImageParametersRepresentation.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| interactions | InteractionRepresentation[] | A list of the interaction parameters for the widget. | Small, 58.0 | 58.0 |
DateSelectorWidgetParametersRepresentation
DateSelectorWidgetParametersRepresentation inherits properties from the abstract SelectorWidgetParametersRepresentation. These base properties appear in DateSelectorWidgetParametersRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| absoluteModeEnabled | Boolean | Indicates whether the widget has absolute mode enabled (true) or not (false). | Small, 43.0 | 43.0 |
| calendarTypeSwitchingAllowed | Boolean | Indicates whether widget can switch calendar types (true) or not (false). | Small, 39.0 | 39.0 |
| customFilterPresets[] | CustomFilterPresetTypeEnum | The list of custom preset filters.
Valid values are:
|
Small, 54.0 | 54.0 |
| defaultFiscalMode | Boolean | Indicates whether there is a default calendar type (true) or not (false). | Small, 39.0 | 39.0 |
| displayMode | ConnectWaveSelectorDisplayModeEnum | The display mode for dashboard
selector widgets. Valid values are:
|
Small, 46.0 | 46.0 |
| expanded | Boolean | Indicates whether the selector widget is expanded (true) or not (false). | Small, 36.0 | 36.0 |
| presetsEnabled | Boolean | Indicates whether the widget has presets enabled (true) or not (false). | Small, 43.0 | 43.0 |
| relativeModeEnabled | Boolean | Indicates whether the widget has relative mode enabled (true) or not (false). | Small, 43.0 | 43.0 |
FilterPanelWidgetParametersRepresentation
FilterPanelWidgetParametersRepresentation inherits properties from the abstract WidgetParametersRepresentation. These base properties appear in FilterPanelWidgetParametersRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| filterItemOptions | FilterItemOptionsRepresentation | The filter items options. | Small, 41.0 | 41.0 |
| filters | FilterItemReferenceRepresentation | The list of filter references mapped to the filters section. | Small, 46.0 | 46.0 |
| itemsPerRow | Integer | The number of filter items per row in a filter panel. | Small, 41.0 | 41.0 |
| showAllFilters | Integer | Indicates whether to display all the filters or just one filter. | Small, 46.0 | 46.0 |
| showInViewMode | Boolean | Indicates whether the filter panel is displayed in view mode (true) or not (false). | Small, 41.0 | 41.0 |
| title | FilterPanelTitleRepresentation | The filter panel title text. | Small, 41.0 | 41.0 |
GlobaFiltersWidgetParametersRepresentation
GlobalFiltersWidgetParametersRepresentation inherits properties from the abstract WidgetParametersRepresentation. These base properties appear in GlobalFiltersWidgetParametersRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| step | String | The step name tied to this widget. | Small, 36.0 | 36.0 |
ImageWidgetParametersRepresentation
ImageWidgetParametersRepresentation inherits properties from the abstract WidgetParametersRepresentation. These base properties appear in ImageWidgetParametersRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| altText | String | The alternate text for the image. | Samll, 55.0 | 55.0 |
| interactions | InteractionRepresentation[] | A list of the interaction parameters for the widget. | Small, 57.0 | 57.0 |
| tooltip | String | The tooltip for the image widget. | Small, 42.0 | 42.0 |
InheritWidgetParametersRepresentation
InheritWidgetParametersRepresentation inherits properties from the abstract WidgetParametersRepresentation. These base properties appear in InheritWidgetParametersRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| step | String | The step name for this widget. | Small, 50.0 | 50.0 |
InputWidgetParametersRepresentation
InputWidgetParametersRepresentation inherits properties from the abstract WidgetParametersRepresentation. These base properties appear in InputWidgetParametersRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| activeValueColor | String | The active color value for this widget. | Small, 56.0 | 56.0 |
| currentValueColor | String | The current color value for this widget. | Small, 56.0 | 56.0 |
| displayFormat | ConnectWaveInputWidgetDisplayFormatEnum | The display format of the input value. Valid values are:
|
Small, 56.0 | 56.0 |
| handleColor | String | The handle color for this widget. | Small, 56.0 | 56.0 |
| increments | Object | The increments for this widget. | Small, 56.0 | 56.0 |
| inputBackgroundColor | String | The background color for this widget. | Small, 56.0 | 56.0 |
| inputBorderColor | String | The border color for this widget. | Small, 56.0 | 56.0 |
| inputType | ConnectWaveInputWidgetInputTypeEnum | The input type of the widget. Valid values are:
|
Small, 56.0 | 56.0 |
| showCurrentValue | Boolean | Indicates whether to show the current value of the widget (true) or not (false). | Small, 56.0 | 56.0 |
| showValuesRange | Boolean | Indicates whether to show the value range of the widget (true) or not (false). | Small, 56.0 | 56.0 |
| step | String | The step name for this widget. | Small, 56.0 | 56.0 |
| title | String | The title for this widget. | Small, 56.0 | 56.0 |
| titleAlignment | ConnectWaveHorizontalAlignmentEnum | The title alignment of the widget. Valid values are:
|
Small, 56.0 | 56.0 |
| titleColor | String | The title color for this widget. | Small, 56.0 | 56.0 |
| titleFontSize | Object | The title font size for this widget. | Small, 56.0 | 56.0 |
| trackColor | String | The track color for this widget. | Small, 56.0 | 56.0 |
| valuesRangeColor | String | The value range color for this widget. | Small, 56.0 | 56.0 |
LinkWidgetParametersRepresentation
LinkWidgetParametersRepresentation inherits properties from the abstract WidgetParametersRepresentation. These base properties appear in LinkWidgetParametersRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| destination | String | The destination of the link. | Small, 36.0 | 36.0 |
| destinationLink | LinkDestinationRepresentation | The destination reference of this link. Valid values are: | Small, 39.0 | 39.0 |
| destinationType | ConnectWaveLinkWidgetDestTypeEnum | The type of asset the link refers to. Values are:
|
Small, 36.0 | 36.0 |
| fontSize | Integer | The font size for the widget. | Small, 36.0 | 36.0 |
| includeState | Boolean | Indicates whether to include the state. | Small, 36.0 | 36.0 |
| text | String | The text value for the link. | Small, 36.0 | 36.0 |
| textAlignment | ConnectWaveHorizontalAlignmentEnum | The alignment of the text. Valid values are:
|
Small, 36.0 | 36.0 |
| textColor | String | The text color for the widget. | Small, 36.0 | 36.0 |
| visualizationType | String | The visualization type used for this widget. Valid values are:
|
Small, 36.0 | 36.0 |
ListSelectorWidgetParametersRepresentation
ListSelectorWidgetParametersRepresentation inherits properties from the abstract SelectorWidgetParametersRepresentation. These base properties appear in ListSelectorWidgetParametersRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| compact | Boolean | Indicates whether the list selector is compact (true) or not (false). | Small, 36.0 | 36.0 |
| displayMode | ConnectWaveSelectorDisplayModeEnum | The display mode for dashboard
selector widgets. Valid values are:
|
Small, 46.0 | 46.0 |
| displayTemplate | String | Display template for widget level projection. | Small, 39.0 | 39.0 |
| expanded | Boolean | Indicates whether the list selector is expanded (true) or not (false). | Small, 36.0 | 36.0 |
| exploreLink | Boolean | Indicates whether the list selector has an explore link (true) or not (false). | Small, 36.0 | 36.0 |
| measureField | String | The measure field associated with this widget. | Small, 36.0 | 36.0 |
NumberWidgetParametersRepresentation
NumberWidgetParametersRepresentation inherits properties from the abstract WidgetParametersRepresentation. These base properties appear in NumberWidgetParametersRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| compact | Boolean | Indicates whether the widget is compact (true) or not (false). | Small, 36.0 | 36.0 |
| destinationLink | LinkDestinationRepresentation | The destination reference of the link. | Small, 47.0 | 47.0 |
| exploreLink | Boolean | Indicates whether the widget has an explore link (true) or not (false). | Small, 36.0 | 36.0 |
| fontSize | String | The font size of the widget text. | Small, 36.0 | 36.0 |
| interactions | InteractionRepresentation[] | A list of the interaction parameters for the widget. | Small, 57.0 | 57.0 |
| measureField | String | The measure field associated with the widget. | Small, 36.0 | 36.0 |
| noResultsLabel | String | The text to display when no results are found. | Small, 45.0 | 45.0 |
| numberColor | String | The color of the number inside the widget. | Small, 36.0 | 36.0 |
| numberSize | Object | The size of the number inside the widget. | Small, 36.0 | 36.0 |
| step | String | The step name associated to the widget. | Small, 36.0 | 36.0 |
| textAlignment | ConnectWaveHorizontalAlignmentEnum | The alignment of the text. Valid values are:
|
Small, 36.0 | 36.0 |
| textColor | String | The color of the text inside the widget. | Small, 36.0 | 36.0 |
| title | String | The title of the widget. | Small, 36.0 | 36.0 |
| titleColor | String | The title color of the widget. | Small, 36.0 | 36.0 |
| titleSize | String | The title size of the widget. | Small, 36.0 | 36.0 |
| tooltip | TooltipRepresentation | The tooltip for the widget. | Small, 51.0 | 51.0 |
PillBoxWidgetParametersRepresentation
PillBoxWidgetParametersRepresentation inherits properties from the abstract WidgetParametersRepresentation. These base properties appear in PillBoxWidgetParametersRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| compact | Boolean | Indicates whether the widget is compact (true) or not (false). | Small, 36.0 | 36.0 |
| displayTemplate | String | The display template for widget level projection. | Small, 39.0 | 39.0 |
| exploreLink | Boolean | Indicates whether the widget has an explore link (true) or not (false). | Small, 36.0 | 36.0 |
| fontSize | String | The default font size for all items in the widget. | Small, 45.0 | 45.0 |
| measureField | String | The measure field associated with the widget. | Small, 36.0 | 36.0 |
| selectedTab | TabStyleParametersRepresentation | The selected tab styles for the widget. | Small, 45.0 | 45.0 |
| step | String | The step name associated to the widget. | Small, 36.0 | 36.0 |
| textColor | String | The color of the default text in the widget. | Small, 36.0 | 36.0 |
| title | String | The title of the widget. | Small, 36.0 | 36.0 |
RangeSelectorWidgetParametersRepresentation
RangeSelectorWidgetParametersRepresentation inherits properties from the abstract SelectorWidgetParametersRepresentation. These base properties appear in RangeSelectorWidgetParametersRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| displayMode | ConnectWaveSelectorDisplayModeEnum | The display mode for dashboard
selector widgets. Valid values are:
|
Small, 46.0 | 46.0 |
RepeaterWidgetParametersRepresentation
RepeaterWidgetParametersRepresentation inherits properties from the abstract WidgetParametersRepresentation. These base properties appear in RepeaterWidgetParametersRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| cardProperties | RepeaterWidgetCardPropertiesRepresentation | The properties for a card for the widget. | Small, 53.0 | 53.0 |
| cellProperties | Map<String, RepeaterWidgetCellPropertiesRepresentation> | A map of repeater cell properties for the widget. | Small, 53.0 | 53.0 |
| exploreLink | Boolean | Indicates whether to display the explorer link (true) or not (false). | Small, 54.0 | 54.0 |
| interactions | InteractionRepresentation[] | A list of the interaction parameters for the widget. | Small, 57.0 | 57.0 |
| itemsPerRow | Object | The number of cards per row of the widget. | Small, 53.0 | 53.0 |
| sortableColumns | Object | The sortable columns for the widget. | Small, 59.0 | 59.0 |
| step | String | The step name associated to the widget. | Small, 53.0 | 53.0 |
TableWidgetParametersRepresentation
TableWidgetParametersRepresentation inherits properties from the abstract WidgetParametersRepresentation. These base properties appear in TableWidgetParametersRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| borderColor | String | The outer border color for the widget. | Small, 41.0 | 41.0 |
| borderWidth | Integer | The outer border width for the widget. | Small, 41.0 | 41.0 |
| cell | TableWidgetCellParametersRepresentation | The cell properties for the widget. | Small, 41.0 | 41.0 |
| collapsible | Boolean | Indicates whether the table is collapsible (true) or not (false). | Small, 50.0 | 50.0 |
| columnProperties | ColumnPropertiesRepresentation | The column properties for the widget. | Small, 42.0 | 42.0 |
| columnSubtotals | Boolean | Indicates whether to display column subtotals in the table (true) or not (false). | Small, 56.0 | 56.0 |
| columnTotals | Boolean | Indicates whether to display column totals in the table (true) or not (false). | Small, 55.0 | 55.0 |
| columns | Object | The columns for the widget. | Small, 41.0 | 41.0 |
| customBulkActions | CustomBulkActionRepresentation | The custom bulk actions for the widget. | Small, 42.0 | 42.0 |
| enableAllDataFetch | Boolean | Indicates whether all data is loaded (true) or data loading is paginated (false). | Small, 59.0 | 59.0 |
| evenRowColor | String | The even row color for the widget. | Small, 41.0 | 41.0 |
| exploreLink | Boolean | Indicates whether the widget has an explore link (true) or not (false). | Small, 38.0 | 38.0 |
| fixedColumnWidth | Integer | The fixed column width for the widget. | Small, 40.0 | 40.0 |
| header | TableWidgetCellParametersRepresentation | The header properties for the widget. | Small, 41.0 | 41.0 |
| innerMajorBorderColor | String | The inner major border color for the widget. | Small, 41.0 | 41.0 |
| innerMinorBorderColor | String | The inner minor border color for the widget. | Small, 41.0 | 41.0 |
| interactions | InteractionRepresentation[] | A list of the interaction parameters for the widget. | Small, 57.0 | 57.0 |
| maxColumnWidth | Integer | The maximum column width for the widget. | Small, 40.0 | 40.0 |
| minColumnWidth | Integer | The minimum column width for the widget. | Small, 40.0 | 40.0 |
| mode | ConnectWaveTableModeEnum | The table mode for the widget. Valid values are:
|
Small, 40.0 | 40.0 |
| numberOfFrozenColumns | Integer | The number of frozen columns for the widget. | Small, 50.0 | 50.0 |
| numberOfLines | Integer | The number of lines of text per row for the widget. | Small, 41.0 | 41.0 |
| oddRowColor | String | The odd row color for the widget. | Small, 41.0 | 41.0 |
| pivoted | Boolean | Indicates whether to display the widget as pivot (true) or not (false). | Small, 39.0 | 39.0 |
| rowTotals | Boolean | Indicates whether to display row totals in the table (true) or not (false). | Small, 55.0 | 55.0 |
| showRowIndexColumn | Boolean | Indicates whether to show the row index column for the widget (true) or not (false). | Small, 41.0 | 41.0 |
| step | String | The step name associated to the widget. | Small, 38.0 | 38.0 |
| subtotals | Boolean | Indicates whether to show the subtotals row for the widget (true) or not (false). | Small, 47.0 | 47.0 |
| totals | Boolean | Indicates whether to show the totals row for the widget (true) or not (false). | Small, 40.0 | 40.0 |
| verticalPadding | Integer | The cell vertical padding value for the widget. | Small, 41.0 | 41.0 |
TextWidgetParametersRepresentation
TextWidgetParametersRepresentation inherits properties from the abstract WidgetParametersRepresentation. These base properties appear in TextWidgetParametersRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| conditionalFormattingSource | TextWidgetConditionalFormattingSourceRepresentation | The conditional formatting source for the widget. | Small, 57.0 | 57.0 |
| content | DynamicDataRepresentation | The dynamic value of the text in the widget. | Small, 49.0 | 49.0 |
| fontSize | Object | The font size of the text in the widget. | Small, 36.0 | 36.0 |
| interactions | InteractionRepresentation[] | A list of the interaction parameters for the widget. | Small, 57.0 | 57.0 |
| text | String | DEPRECATED The value of the text in the widget. | Small, 36.0 | 36.0-48.0 |
| textAlignment | ConnectWaveHorizontalAlignmentEnum | The alignment of the text. Valid values are:
|
Small, 36.0 | 36.0 |
| textColor | String | The color of the text in the widget. | Small, 36.0 | 36.0 |
| textOverflow | ConnectWaveTextOverflowEnum | The overflow of the text. Valid values are:
|
Small, 60.0 | 60.0 |
| tooltip | String | The tooltip for the widget. | Small, 42.0 | 42.0 |
UrlWidgetParametersRepresentation
UrlWidgetParametersRepresentation inherits properties from the abstract WidgetParametersRepresentation. These base properties appear in UrlWidgetParametersRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| type | ConnectWaveUrlWidgetType | The type of URL for the widget. Valid values
are:
|
Small, 36.0 | 36.0 |
| url | String | The URL for the widget. | Small, 36.0 | 36.0 |
| videoSize | String | The size of the video the URL loads for the widget. | Small, 36.0 | 36.0 |
ValueTableWidgetParametersRepresentation
ValueTablesWidgetParametersRepresentation inherits properties from the abstract WidgetParametersRepresentation. These base properties appear in ValueTablesWidgetParametersRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| exploreLink | Boolean | Indicates whether the widget has an explore link (true) or not (false). | Small, 36.0 | 36.0 |
| hideHeaderLink | Boolean | Indicates whether the header column is hidden for this widget (true) or not (false). | Small, 36.0 | 36.0 |
| maxColumnWidth | Integer | The maximum column width for the widget. | Small, 36.0 | 36.0 |
| minColumnWidth | Integer | The minimum column width for the widget. | Small, 36.0 | 36.0 |
| step | String | The step name associated to the widget. | Small, 36.0 | 36.0 |
| totals | Boolean | Indicates whether to show the totals row for the widget (true) or not (false). | Small, 36.0 | 36.0 |
WidgetParametersRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| onboarding | WidgetOnboardingRepresentation | The value to indicate the widget onboarding content. | Small, 46.0 | 46.0 |
| selectModeOverride | ConnectWaveSelectModeEnum | The select mode types. Valid values are:
|
Small, 36.0 | 36.0 |
| showActionMenu | Boolean | Indicates whether to display the widget action menu (true) or not (false). | Small, 44.0 | 44.0 |
WidgetOnboardingRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| title | String | The title of the onboarding content. | Small, 46.0 | 46.0 |
| url | String | The URL of the onboarding content. | Small, 46.0 | 46.0 |
SelectorWidgetParametersRepresentation
SelectorWidgetParametersRepresentation inherits properties from the abstract WidgetParametersRepresentation. These base properties appear in SelectorWidgetParametersRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| displayMode | ConnectWaveSelectorDisplayModeEnum | The display mode for dashboard
selector widgets. Valid values are:
|
Small, 46.0 | 46.0 |
| filterStyle | FilterStyleRepresentation | The styling properties for filter widgets. | Small, 46.0 | 46.0 |
| instant | Boolean | Indicates whether the list selector is instant (true) or not (false). | Small, 36.0 | 36.0 |
| step | String | The step name associated to the widget. | Small, 36.0 | 36.0 |
| title | String | The title of the widget. | Small, 36.0 | 36.0 |
WidgetPositionRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| h | String | The height of the widget. | Small, 36.0 | 36.0 |
| w | String | The width of the widget. | Small, 36.0 | 36.0 |
| x | Integer | The x-index of the widget. | Small, 36.0 | 36.0 |
| y | Integer | The y-index of the widget. | Small, 36.0 | 36.0 |
| zIndex | Integer | The z-index of the widget. | Small, 36.0 | 36.0 |
InteractionRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| actions | InteractionActionRepresentation[] | A list of the actions for the interaction. Valid actions types are: | Small, 57.0 | 57.0 |
| event | ConnectWaveInteractionEventType | The event type for the interaction. Valid values are:
|
Small, 57.0 | 57.0 |
InteractionActionRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| action | ConnectWaveInteractionActionTypeEnum | The action type for the interaction. Valid values are:
|
Small, 57.0 | 57.0-59.0 |
| type | ConnectWaveInteractionActionTypeEnum | The action type for the interaction. Valid values are:
|
Small, 60.0 | 60.0 |
InteractionClearActionRepresentation
InteractionClearActionRepresentation inherits properties from the abstract InteractionActionRepresentation. These base properties appear in InteractionClearActionRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| clearType | ConnectWaveInteractionClearTypeEnum | The clear type for the interaction. Valid values are:
|
Small, 59.0 | 59.0 |
| lensIds | String[] | A list of lens IDs for the interaction. | Small, 59.0 | 59.0 |
InteractionFlowActionRepresentation
InteractionFlowActionRepresentation inherits properties from the abstract InteractionActionRepresentation. These base properties appear in InteractionFlowActionRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| attributes | Map<Object,Object> | A map of interaction attributes. | Small, 58.0 | 58.0 |
| name | String | The API name of the action. | Small, 58.0 | 58.0 |
InteractionResetActionRepresentation
InteractionResetActionRepresentation inherits properties from the abstract InteractionActionRepresentation. These base properties appear in InteractionResetActionRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| resetType | ConnectWaveInteractionResetTypeEnum | The reset type for the action. Valid values are:
|
Small, 58.0 | 58.0 |
TextWidgetConditionalFormattingSourceRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| field | String | The field used to retrieve the conditional formatting for the widget. | Small, 57.0 | 57.0 |
| scope | String | The scope of the conditional formatting rules for the widget | Small, 57.0 | 57.0 |
| step | String | The step used to retrieve the conditional formatting rules for the widget | Small, 57.0 | 57.0 |
FilterItemOptionsRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| backgroundColor | String | The background color of the filter items. | Small, 41.0 | 41.0 |
| borderColor | String | The border color of the filter items. | Small, 41.0 | 41.0 |
| borderRadius | Integer | The border radius of the filter items. | Small, 41.0 | 41.0 |
| borderWidth | Integer | The border width of the filter items. | Small, 41.0 | 41.0 |
| propertyColor | String | The property color of the filter items. | Small, 41.0 | 41.0 |
| valueColor | String | The value color of the filter items. | Small, 41.0 | 41.0 |
FilterItemReferenceRepresentation
FilterItemReferenceRepresentation inherits properties from the abstract FilterRepresentation. These base properties appear in FilterItemReferenceRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| cdpObject | String | The cdp datasource in the filters section. | Small, v55 | 55.0 |
| dataset | AssetReferenceRepresentation[] | The dataset in the filters section. | Small, 46.0 | 46.0 |
| field | String | The field in the filters section. | Small, 46.0 | 46.0 |
| sObject | String | The sObject in the filters section. | Small, v55 | 55.0 |
FilterPanelTitleRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| separatorColor | String | The filter panel's title separator color. | Small, 41.0 | 41.0 |
| text | TextRepresentation[] | The filter panel's title text. | Small, 41.0 | 41.0 |
| visible | Boolean | Indicates whether the filter panel's title is visible (true) or not (false). | Small, 41.0 | 41.0 |
FilterRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| parameters | FilterParamRepresentation[] | The filter panel parameters. | Small, 41.0 | 41.0 |
FilterParamRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| filter | String | The filter expression that specifies which records to include. | Small, 41.0 | 41.0 |
| saqlFilter | String | The SAQL expression that specifies which records to include. | Small, 44.0 | 44.0 |
LinkAssetDestinationRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| name | String | The name of the asset referenced by the link. | Small, 45.0 | 45.0 |
| namespace | String | The namespace of the asset referenced by the link. | Small, 45.0 | 45.0 |
| pageName | String | The page name for the link. | Small, 45.0 | 45.0 |
| savedViewId | String | The dashboard saved view id for the link. | Small, 47.0 | 47.0 |
| widgetId | String | The dashboard widget id for the link. | Small, 47.0 | 47.0 |
LinkPageDestinationRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| name | String | The name of the page referenced by the link. | Small, 45.0 | 45.0 |
LinkUrlDestinationRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| tooltip | String | The tooltip for the link. | Small, 45.0 | 45.0 |
| url | String | The URL of the link. | Small, 45.0 | 45.0 |
TabStyleParametersRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| backgroundColor | String | The background color for the tab. | Small, 43.0 | 43.0 |
| borderColor | String | The border color for the tab. | Small, 43.0 | 43.0 |
| borderEdges | ConnectWaveBorderEdgeTypeEnum[] | The edges of the border to be drawn.
Valid values are:
|
Small, 43.0 | 43.0 |
| borderWidth | Integer | The border width for the tab. | Small, 43.0 | 43.0 |
| textColor | String | The text color for the selected tab. | Small, 43.0 | 43.0 |
LinkDestinationRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| tooltip | String | The tooltip for the link. | Small, 46.0 | 46.0 |
| url | String | The URL for the link. | Small, 43.0 | 43.0 |
LinkMassActionDestinationRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| actionName | String | The name of the action. | Small, 51.0 | 51.0 |
| field | String | The field name for the action. | Small, 51.0 | 51.0 |
| step | String | The step to invoke the action on. | Small, 51.0 | 51.0 |
TooltipRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| content | TooltipContentRepresentation | The content for the tooltip. | Small, 51.0 | 51.0 |
| customizeTooltip | Boolean | Indicates whether the tooltip is customized (true) or not (false). | Small, 51.0 | 51.0 |
FilterStyleRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| titleColor | String | The color of the displayed title. | Small, 46.0 | 46.0 |
| valueColor | String | The color for the displayed value. | Small, 46.0 | 46.0 |
RepeaterWidgetCardPropertiesRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| cellSpacingX | Integer | The horizontal spacing between grid cells. | Small, 53.0 | 53.0 |
| cellSpacingY | Integer | The vertical spacing between grid cells. | Small, 53.0 | 53.0 |
| numColumns | Integer | The number of columns for a repeater grid. | Small, 53.0 | 53.0 |
| rowHeight | ConnectWaveRowHeightEnum | Specifies the grid cell row height. Valid
values are:
|
Small, 53.0 | 53.0 |
| selectedStyles | CardSelectionStyleParametersRepresentation | The styling for the selected repeater card of the widget | Small, 54.0 | 54.0 |
| styles | GridLayoutWidgetStyleRepresentation | The styling for the repeater card of the widget | Small, 53.0 | 53.0 |
CardSelectionStyleParametersRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| backgroundColor | String | The background color of selected card. Must be a 6 digit hex string. | Small, 54.0 | 54.0 |
| borderColor | String | The border color of selected card. Must be a 6 digit hex string. | Small, 54.0 | 54.0 |
| borderEdges | ConnectWaveBorderEdgeTypeEnum[] | The edges of the border to be drawn.
Valid values are:
|
Small, 54.0 | 54.0 |
| borderRadius | Integer | The border radius of selected card. | Small, 54.0 | 54.0 |
| borderWidth | Integer | The border width of selected card. | Small, 54.0 | 54.0 |
RepeaterWidgetCellPropertiesRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| parameters | Object | The parameters of the cell, based on it's type. | Small, 53.0 | 53.0 |
| position | GridLayoutWidgetRepresentation | The cell position, dimension, and styles. | Small, 53.0 | 53.0 |
| type | ConnectWaveRepeaterCellTypeEnum | The cell type. Valid values are: | Small, 53.0 | 53.0 |
CellPropertiesImageParametersRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| alignmentX | ConnectWaveHorizontalAlignmentEnum | The horizontal alignment for the image. Valid values are:
|
Small, 54.0 | 54.0 |
| alignmentY | ConnectWaveVerticalAlignmentEnum | The vertical alignment for the image. Valid values are:
|
Small, 54.0 | 54.0 |
| altText | String | The alternate text for the image. | Small, 54.0 | 54.0 |
| fit | ConnectWaveImageFitTypeEnum | The fit type for the image. Valid values are:
|
Required | 54.0 |
| source | Object | The source URL for the image. | Small, 54.0 | 54.0 |
CellPropertiesNumberParametersRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| compact | Boolean | Indicates whether compact form is on (true) or not (false). | Small, 54.0 | 54.0 |
| measureField | String | The measure field this number is calculated from. | Small, 54.0 | 54.0 |
| noResultsLabel | String | The text to display when no results are found. | Small, 54.0 | 54.0 |
| numberColor | String | The color of the number. | Small, 54.0 | 54.0 |
| numberSize | Object | The size of the number. | Small, 54.0 | 54.0 |
| textAlignment | ConnectWaveHorizontalAlignmentEnum | The alignment for the text. Valid values are:
|
Small, 54.0 | 54.0 |
| title | String | The title of the widget. | Small, 54.0 | 54.0 |
| titleColor | String | The color of the title. | Small, 54.0 | 54.0 |
| titleSize | String | The size of the title. | Small, 54.0 | 54.0 |
CellPropertiesTextParametersRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| content | DynamicDataInputRepresentation | The dynamic value of the text. | Small, 54.0 | 54.0 |
TableWidgetCellParametersRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| backgroundColor | String | The background color of the cell. | Small, 41.0 | 41.0 |
| fontColor | String | The color for the cell text font. | Small, 41.0 | 41.0 |
| fontSize | Integer | The size for the cell text font. | Small, 41.0 | 41.0 |
| textWrap | Boolean | Indicates whether text wrapping is allowed (true) or not (false). | Small, 54.0 | 54.0 |
ColumnPropertiesRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| parameters | Object | The valid column parameters based on its type. | Small, 42.0 | 42.0 |
| type | ConnectWaveColumnRenderTypeEnum | The render types of a column. Valid values are: | Small, 41.0 | 41.0 |
ColumnParametersBarRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| width | Integer | The width for the column. | Small, 54.0 | 54.0 |
ColumnParametersImageRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| alignment | ConnectWaveHorizontalAlignmentEnum | The horizontal alignment for the image. Valid values are:
|
Small, 54.0 | 54.0 |
| height | Integer | The image height for the image. | Small, 54.0 | 54.0 |
| width | Integer | The width for the column. | Small, 54.0 | 54.0 |
ColumnParametersTextRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| alignment | ConnectWaveHorizontalAlignmentEnum | The horizontal alignment for the column. Valid values are:
|
Small, 54.0 | 54.0 |
| styles | TextStyleRepresentation | The text style for the column. | Small, 54.0 | 54.0 |
| width | Integer | The width for the column. | Small, 54.0 | 54.0 |
TextStyleRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| bold | Boolean | Indicates whether the text is bold (true) or not (false). | Small, 54.0 | 54.0 |
| linkColor | String | The text color when the text is a link. | Small, 54.0 | 54.0 |
CustomBulkActionRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| label | String | The label for the custom action. | Small, 39.0 | 39.0 |
| visualforce | AssetReferenceRepresentation | The VisualForce page to invoke for the custom action. | Small, 39.0 | 39.0 |
TextRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| align | ConnectWaveHorizontalAlignmentEnum | The alignment of the text. Valid values are:
|
Small, 41.0 | 41.0 |
| color | String | The color of the text. | Small, 41.0 | 41.0 |
| fontSize | Integer | The font size of the text. | Small, 41.0 | 41.0 |
| label | String | The label for the text. | Small, 41.0 | 41.0 |
ColumnRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| format | ConnectWaveColumnFormatEnum | The column format value. Valid
values are:
|
Small, 36.0 | 36.0 |
| header | String | The header text of this column. | Small, 36.0 | 36.0 |
| hidden | Boolean | Indicates whether the column is hidden (true) or not (false). | Small, 36.0 | 36.0 |
| query | Query | The SAQL used to create the comparison table. | Small, 36.0 | 36.0 |
| showBars | Boolean | Indicates whether to show bars for the column (true) or not (false). | Small, 36.0 | 36.0 |
| sort | ConnectWaveColumnSortEnum | The column sort order. Valid values
are:
|
Small, 36.0 | 36.0 |
DynamicDataRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| displayTemplate | String | The dynamic expression to resolve. | Small, 49.0 | 49.0 |
| richTextContent | Map<String, RichTextContentBlockRepresentation[] | List of rich text content blocks. | Small, 52.0 | 52.0 |
| values | Map<String, DynamicValueRepresentation> | Map to contain the data for the dynamic values. | Small, 49.0 | 49.0 |
RichTextContentBlockRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| attributes | Map<String, Object> | Map of text attribute names and values. | Small, 52.0 | 52.0 |
| insert | String | The text block content | Small, 52.0 | 52.0 |
DynamicValueRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| compact | Boolean | Indicates whether the resolved value is compact (true) or not (false). | Small, 55.0 | 55.0 |
| field | String | The column used to resolve the value. | Small, 49.0 | 49.0 |
| noResultsLabel | String | The text to display when no results are found. | Small, 55.0 | 55.0 |
| sourcecType | ConnectWaveDynamicDataSourceType | The interaction type for the value.
Valid values are:
|
Small, 49.0 | 49.0 |
| step | String | The step id for the value. | Small, 49.0 | 49.0 |
TooltipContentRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| body | TooltipVisualizationRepresentation | The visualization for the tooltip. | Small, 51.0 | 51.0-52.0 |
| description | DynamicDataRepresentation | The text content for the tooltip. | Small, 51.0 | 51.0 |
| widget | TooltipWidgetRepresentation | The widget displayed in the tooltip. | Small, 53.0 | 53.0 |
TooltipWidgetRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| height | Object | The height of the widget in the tooltip. | Small, 53.0 | 53.0 |
| name | String | The name of the widget in the tooltip. | Small, 53.0 | 53.0 |
| width | Object | The width of the widget in the tooltip. | Small, 53.0 | 53.0 |
TooltipVisualizationRepresentation
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| height | Object | The height for the tooltip. | Small, 51.0 | 51.0 |
| source | TypedAssetReferenceRepresentation | The source for the tooltip visualization. | Small, 51.0 | 51.0 |
| width | Object | The width for the tooltip. | Small, 51.0 | 51.0 |