This page contains the reference for the DashboardStateInputRepresentation resource and
all the representations that make up the dashboard state for API POST and PATCH requests. The
following representation details are not REST API endpoints on their own, but describe object
representations used in REST API request bodies.
DashboardStateInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| dataSourceLinks | DashboardDataSourceLinkInputRepresentation[] | The list of datasource links used as part of the dashboard. | Optional | DEPRECATED 39.0-56.0 |
| dataSourceLinksInfo | DashboardDataSourceLinksInfoInputRepresentation[] | The list of datasource links information used as part of the dashboard. | Optional | 57.0 |
| filters | FilterItemInputRepresentation[] | The list of datasource filters applied in the dashboard. | Optional | 41.0 |
| gridLayouts | GridLayoutInputRepresentation[] | The list of GridLayoutInputRepresentation objects used as part of this dashboard. If present, layouts must not be set. | Optional | 36.0 |
| layouts | LayoutInputRepresentation[] | The list of LayoutInputRepresentation objects used as part of this dashboard. | Optional | 36.0 |
| parameters | ParameterItemInputRepresentation[] | The list of parameters created for this dashboard. | Optional | 58.0 |
| steps | Map<String, StepInputRepresentation> | The map of all the steps used to create this dashboard keyed with the
step names. Valid step types are:
|
Optional | 36.0 |
| widgetStyle | GridLayoutWidgetStyleInputRepresentation | The default styling for widgets in this dashboard. | Optional | 37.0 |
| widgets | Map<String, DashboardWidgetInputRepresentation> | The map of all the DashboardWidgetInputRepresentation objects used to create this dashboard keyed with their names. | Optional | 36.0 |
DashboardDataSourceLinkInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| fields | DashboardDataSourceFieldInputRepresentation[] | The list of fields connected in the datasource link. | Required | 39.0 |
| label | String | The label of the datasource link. | Required | 39.0 |
| name | String | The name of the datasource link. | Required | 39.0 |
DashboardDataSourceLinksInfoInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| enableAutomaticLinking | Boolean | Indicates whether automatic linking is enabled for the dashboard (true) or not (false). | Optional | 57.0 |
| excludeRelationships | DashboardDataSourceRelationshipInputRepresentation[] | The list of data source exclude relationships from faceting in the dashboard. | Optional | 57.0 |
| links | DashboardDataSourceLinkInputRepresentation[] | The list of data source links for the dashboard. | Required | 57.0 |
DashboardDataSourceRelationshipInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| fromDataSource | String | The fully qualified name of the "from" data source. | Required | 57.0 |
| fromDataSourceType | ConnectWaveDataSourceTypeEnum | The type of the "from" data source. Valid values are:
|
Required | 57.0 |
| toDataSource | String | The fully qualified name of the "to" data source. | Required | 57.0 |
| toDataSourceType | ConnectWaveDataSourceTypeEnum | The type of the "to" data source. Valid values are:
|
Required | 57.0 |
DashboardDataSourceFieldInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| dataSourceName | String | The developer name of the data source. | Required | 39.0 |
| dataSourceNamespace | String | The namespace that qualifies the dataset asset name. | Optional | 39.0 |
| dataSourceType | ConnectWaveDataSourceTypeEnum | The type of datasource. Valid values are:
|
Required | 39.0 |
| dataspace | String | The name of datasapce that the Data 360 object is assigned to. | Optional | 62.0 |
| fieldName | String | The name of the field in data source. | Required | 39.0 |
ParameterItemInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| defaultValue | Object | The default value of the parameter. | Required | 58.0 |
| description | String | The description of the parameter. | Optional | 58.0 |
| label | String | The label of the parameter. | Optional | 58.0 |
| name | String | The name of the parameter. | Required | 58.0 |
FilterItemInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| cdpObject | String | The Data 360 datasource the filter applies to. | Required | 55.0 |
| dataset | AssetReferenceInputRepresentation | The datasource the filter applies to. | Required | 41.0 |
| dependent | Boolean | Indicates whether the filter item is dependent (true) or not (false). | Optional | 45.0 |
| fields | String[] | The list of fields in filter. | Optional | 41.0 |
| hidden | Boolean | Indicates whether the filter is hidden in view mode (true) or not (false). | Optional | 41.0 |
| label | String | The label of the filter. | Optional | 41.0 |
| locked | Boolean | Indicates whether the filter is locked (true) or not (false). | Optional | 41.0 |
| operator | String | The operator for the filter. | Required | 41.0 |
| sObject | String | The sObject datasource the filter applies to. | Required | 55.0 |
| value | String | The value for the filter. | Required | 41.0 |
GridLayoutStyleInputRepresentation
GridLayoutStyleInputRepresentation inherits properties from the abstract ImageParametersInputRepresentation. These base properties appear in GridLayoutStyleInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| backgroundColor | String | Background color for the layout. | 37.0 | |
| cellSpacingX | Integer | Horizontal spacing between grid cells. | 37.0 | |
| cellSpacingY | Integer | Vertical spacing between grid cells. | 37.0 | |
| gutterColor | String | Gutter color of the layout. | 39.0 | |
| widgetStyle | GridLayoutWidgetStyleInputRepresentation | Default styling for widgets across all layouts. | Optional | 36.0 |
AggregateFlexQueryStepInputRepresentation
AggregateFlexQueryStepInputRepresentation inherits properties from the abstract LegacyStepWithQueryInputRepresentation. These base properties appear in AggregateFlexQueryStepInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| broadcastFacet | Boolean | Indicates whether the steps broadcasts facets (true) or not (false). | Optional | 41.0 |
| cdpObject | String | The name of the Data 360 object used for the query. | Optional | 54.0-57.0 |
| cdpObjects | String | A list of the Data 360 object names used for the query. | Optional | 58.0 |
| connectionName | String | The name of the connection used for querying external data. | Optional | 48.0 |
| dataspace | String | The dataspace name for Data 360 objects. | Optional | 61.0 |
| receiveFacetSource | ReceiveFacetSourceInputRepresentation | The receive facet source configuration for the step. | Optional | 36.0 |
| sobject | String | The name of the sObject used for the SOQL query. | Required | 47.0 |
| values | Map<String, DynamicValueInputRepresentation> | A map of dynamic data values. | Optional | 57.0 |
AggregateStepInputRepresentation
AggregateStepInputRepresentation inherits properties from the abstract LegacyStepWithQueryInputRepresentation. These base properties appear in AggregateStepInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| isFacet | Boolean | Indicates whether the step is faceted (true) or not (false). | Required | 36.0 |
ApexStepInputRepresentation
ApexStepInputRepresentation inherits properties from the abstract StepInputRepresentation. These base properties appear in ApexStepInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| query | ApexStepQueryInputRepresentation | The query for the step | Required | 41.0 |
ApexStepQueryInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| body | Object | The body for the Apex request. | Required | 41.0 |
| path | String | The path to the Apex controller. | Required | 41.0 |
CdpStepInputRepresentation
CdpStepInputRepresentation inherits properties from the abstract FlexMetadataWithSimpleQueryStepInputRepresentation. These base properties appear in CdpStepInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| broadcastFacet | Boolean | Indicates whether the step broadcasts faceting (true) or not (false). | Optional | 54.0 |
| dataspace | String | The dataspace name for Data 360 objects. | Optional | 61.0 |
| receiveFacetSource | ReceiveFacetSourceInputRepresentation | The receive facet source configuration | Required | 54.0 |
| useLegacyCdpQueryApi | Boolean | Indicates whether this step uses the legacy Data 360 Query API (true) or not (false). | Optional | 65.0 |
| values | Map<String, DynamicValueRepresentation> | A map of dynamic data values. | Required | 59.0 |
DirectReportStepInputRepresentation
DirectReportStepInputRepresentation inherits properties from the abstract StepInputRepresentation. These base properties appear in DirectReportStepInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| broadcastFacet | Boolean | Indicates whether this step broadcasts faceting filters to other steps on the dashboard (true) or not (false). | Optional | 56.0 |
| query | DirectReportStepQueryInputRepresentation | The query to run for this step. | Required | 53.0 |
| receiveFacetSource | ReceiveFacetSourceInputRepresentation | The receive facet configuration. | Optional | 56.0 |
ForecastingStepInputRepresentation
ForecastingStepInputRepresentation inherits properties from the abstract StepInputRepresentation. These base properties appear in ForecastingStepInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| query | ForecastingStepQueryInputRepresentation | The query to run for this step. | Required | 59.0 |
GrainStepInputRepresentation
GrainStepInputRepresentation inherits properties from the abstract LegacyStepWithQueryInputRepresentation. These base properties appear in GrainStepInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| isFacet | Boolean | Indicates whether the step is faceted (true) or not (false). | Required | 36.0 |
HierarchyStepInputRepresentation
HierarchyStepInputRepresentation inherits properties from the abstract StepInputRepresentation. These base properties appear in HierarchyStepInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| filterField | String | The filter field to pass to the role hierarchy evaluation. | Required | 55.0 |
| hierarchyType | HierarchyTypeEnum | The type of hierarchy used to facet. Valid values are:
|
Required | 55.0 |
| query | HierarchyStepQueryRepresentation | The query parameters to pass to the role hierarchy evaluation. | Required | 55.0 |
HierarchyStepQueryInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| limit | Integer | The maximum amount of results to return for this step. | Required | 55.0 |
InputStepInputRepresentation
InputStepInputRepresentation inherits properties from the abstract StepInputRepresentation. These base properties appear in InputStepInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| start | String | The start value for the step. | Required | 56.0 |
| valueType | ConnectWaveInputWidgetValueFormatEnum | The value type of the step. Valid values are:
|
Required | 56.0 |
| values | InputStepValuesInputRepresentation[] | The list of values for the step. | Required | 56.0 |
InputStepValuesInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| max | String | The max column in values. | Required | 56.0 |
| min | String | The min column in values. | Required | 56.0 |
LensStepInputRepresentation
LensStepInputRepresentation inherits properties from the abstract StepInputRepresentation. These base properties appear in LensStepInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| source | AssetReferenceInputRepresentation | The lens source for this step. | Required | 50.0 |
MultiStepInputRepresentation
MultiStepInputRepresentation inherits properties from the abstract LegacyStepInputRepresentation. These base properties appear in MultiStepInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| columns | ColumnInputRepresentation[] | The list of columns of the comparison table. | Optional | 36.0 |
| globalQuery | QueryInput | The SAQL used to create the step. | Optional | 36.0 |
| isFacet | Boolean | Indicates whether the step is faceted (true) or not (false). | Optional | 36.0 |
SqlStepInputRepresentation
SqlStepInputRepresentation inherits properties from the abstract FlexMetadataWithSimpleQueryStepInputRepresentation. These base properties appear in SqlStepInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| broadcastFacet | Boolean | Indicates whether the step broadcasts faceting (true) or not (false). | Optional | 51.0 |
| connectionName | String | The name of the connection used for querying external data | Required | 51.0 |
| receiveFacetSource | ReceiveFacetSourceInputRepresentation | The receive facet configuration. | Optional | 52.0 |
SaqlStepInputRepresentation
SaqlStepInputRepresentation inherits properties from the abstract FlexMetadataWithSimpleQueryStepInputRepresentation. These base properties appear in SaqlStepInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| broadcastFacet | Boolean | Indicates whether the step broadcasts faceting (true) or not (false). | Optional | 41.0 |
| receiveFacetSource | ReceiveFacetSourceInputRepresentation | The receive facet source configuration | Required | 48.0 |
| values | Map<String, ReceiveFacetSourceInputRepresentation> | A map of dynamic data values. | Required | 57.0 |
SoqlStepInputRepresentation
SoqlStepInputRepresentation inherits properties from the abstract FlexMetadataWithSimpleQueryStepInputRepresentation.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| broadcastFacet | Boolean | Indicates whether the step broadcasts faceting (true) or not (false). | Optional | 55.0 |
| receiveFacetSource | ReceiveFacetSourceInputRepresentation | The receive facet source configuration. | Optional | 55.0 |
StaticFlexStepInputRepresentation
StaticFlexStepInputRepresentation inherits properties from the abstract FlexMetadataStepInputRepresentation. These base properties appear in StaticFlexStepInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| broadcastFacet | Boolean | Indicates whether the step broadcasts faceting (true) or not (false). | Optional | 41.0 |
| columns | Map<String, StaticFlexStepColumnInputRepresentation> | A map of metadata values for the columns. | Optional | 41.0 |
| datasets | AssetReferenceInputRepresentation[] | DEPRECATED The list of all the datasets used for the step. | Optional | 36.0-40.0 |
| dimensions | String[] | DEPRECATED The list of the dimensions for the step. | Optional | 36.0-40.0 |
| isFacet | Boolean | DEPRECATED Indicates whether the step is faceted (true) or not (false). | Optional | 36.0-40.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). | Optional | 38.0 |
| values | String[] | The list of values of this step. | Optional | 36.0 |
StaticStepInputRepresentation
StaticStepInputRepresentation inherits properties from the abstract LegacyStepInputRepresentation. These base properties appear in StaticStepInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| dimensions | String[] | The list of dimensions of the static step. | Optional | 36.0 |
| isFacet | Boolean | Indicates whether the step is faceted (true) or not (false). | Optional | 36.0 |
| values | String[] | The list of values for the step. | Optional | 36.0 |
| visualizationParameters | StepVisualizationParametersInputRepresentation | The visualization parameters for the dashboard step. | Optional | 36.0 |
FlexMetadataWithSimpleQueryStepInputRepresentation
FlexMetadataWithSimpleQueryStepInputRepresentation inherits properties from the abstract FlexMetadataStepInputRepresentation. These base properties appear in FlexMetadataWithSimpleQueryStepInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| query | String | The query for the step. | Optional | 39.0 |
FlexMetadataStepInputRepresentation
FlexMetadataStepInputRepresentation inherits properties from the abstract StepInputRepresentation. These base properties appear in FlexMetadataStepInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| groups | Object | The subset of columns that define a semantic for the step. | Optional | 39.0 |
| numbers | Object | The number-based columns for the step. | Optional | 39.0 |
| strings | Object | The string-based columns for the step. | Optional | 39.0 |
LegacyStepWithQueryInputRepresentation
LegacyStepWithQueryInputRepresentation inherits properties from the abstract LegacyStepInputRepresentation. These base properties appear in LegacyStepWithQueryInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| query | String |
QueryInput[] The query for the step. |
Required | 39.0 |
LegacyStepInputRepresentation
LegacyStepInputRepresentation inherits properties from the abstract StepInputRepresentation. These base properties appear in LegacyStepInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| datasets | String |
AssetReferenceInputRepresentation[] The list of datasets used by the step. |
Required | 39.0 |
| isGlobal | Boolean | Indicates whether the step is a global filter which can be faceted to other steps or widgets in the dashboard (true) or not (false). | Optional | 36.0 |
StepInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| label | String | The display label of the step. | Optional | 39.0 |
| selectMode | ConnectWaveSelectModeEnum | The select mode types. Valid values are:
|
Optional | 36.0 |
| sortable | Boolean | Indicates whether this step supports quick sorting in preview mode (true) or not (false). | Optional | 64.0 |
| start | String | The start value of the step. | Optional | 36.0 |
| useExternalFilters | Boolean | Indicates whether this step uses external filters (true) or not (false). | Optional | 64.0 |
| useGlobal | Boolean | Indicates whether the step is tied to the global step (true) or not (false). | Optional | 36.0 |
| visualizationParameters | StepVisualizationParametersInputRepresentation | The visualization parameters for the step. | Optional | 36.0 |
DirectReportStepQueryInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| metadata | Object | The metadata for the query. | Required | 53.0 |
| mode | DirectReportModeEnum | The query mode. Valid values are:
|
Required | 53.0 |
| reportId | String | The ID for the query report. | Required | 53.0 |
ForecastingStepQueryInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| forecastTypeId | String | The forecast type for the query. | Required | 59.0 |
| startDate | Object | The start date for the query. | Required | 59.0 |
| territoryId | String | The territory ID for the query. | Required | 59.0 |
| userId | String | The user ID for the query. | Required | 59.0 |
StaticFlexStepColumnInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| aggregateFunction | String | The aggregate function for the step. | Optional | 47.0 |
| dataset | AssetReferenceInputRepresentation | The dataset for the step. | Required | 47.0 |
| field | String | The aggregate field for the step. | Required | 47.0 |
| type | ConnectWaveDashboardStaticStepColumnTypeEnum | The column type. Valid values are
|
Required | 47.0 |
ColumnInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| format | ConnectWaveColumnFormatEnum | The column format value. Valid
values are:
|
Optional | 36.0 |
| header | String | The header text of this column. | Optional | 36.0 |
| hidden | Boolean | Indicates whether the column is hidden (true) or not (false). | Optional | 36.0 |
| query | QueryInput | The SAQL used to create the comparison table. | Optional | 36.0 |
| showBars | Boolean | Indicates whether to show bars for the column (true) or not (false). | Optional | 36.0 |
| sort | ConnectWaveColumnSortEnum | The column sort order. Valid values
are:
|
Optional | 36.0 |
ReceiveFacetSourceInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| mode | ConnectWaveDashboardStepReceiveFacetModeTypeEnum | The type of receive facet mode. Valid values are:
|
Required | 48.0 |
| steps | String[] | A list of steps that the current step receives or omits faceting from. | Required | 48.0 |
StepVisualizationParametersInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| options | LensVisualizationOptionsInput | The visualization option associated with this step. | Optional | 36.0 |
| parameters | Object | The valid widget parameters based on its type. | Optional | 40.0 |
| type | ConnectWaveWidgetTypeEnum | The type of the widget. Valid values are:
|
40.0 | |
| visualizationType | ConnectWaveVisualizationTypeEnum | The type of visualization. Valid values are:
|
Optional | 36.0 |
GridLayoutInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| maxWidth | Integer | The maximum width that the dashboard flexes to. | Optional | 38.0 |
| name | String | Name of this layout. | Required | 36.0 |
| numColumns | Integer | The number of columns for a customizable dashboard grid layout. | Optional | 38.0 |
| pages | GridLayoutPageInputRepresentation[] | The list of pages of widgets within the layout. | Optional | 36.0 |
| rowHeight | ConnectWaveRowHeightEnum | Specifies the grid cell row height. Valid values are:
|
Optional | 39.0 |
| selectors | String[] | The list of selectors the layout applies to. | Optional | 36.0 |
| style | GridLayoutStyleInputRepresentation | The styling for the layout. | Optional | 37.0 |
| version | Double | Version of this layout. | Required | 36.0 |
| widgetStyle | GridLayoutWidgetStyleInputRepresentation | DEPRECATED Default styling for widgets within the layout. | Optional | 36.0-37.0 |
GridLayoutPageInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| label | String | The display label for the page. | Optional | 41.0 |
| name | String | The unique id for a page within a layout. | Required | 41.0 |
| navigationHidden | Boolean | Indicates whether the page is hidden in the navigation widget (true) or not (false). | Optional | 44.0 |
| widgets | GridLayoutWidgetInputRepresentation[] | The list of widgets within the page. | Required | 36.0 |
GridLayoutWidgetInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| backgroundImage | String | The background image for the widget. | Optional | 36.0 |
| colspan | Integer | The number of grid layout columns this widget spans. | Required | 36.0 |
| column | Integer | The column where this widget is located. | Required | 36.0 |
| name | String | The name of the widget. | Required | 36.0 |
| row | Integer | The row where this widget is located. | Required | 36.0 |
| rowspan | Integer | The number of grid layout rows this widget spans. | Required | 36.0 |
| widgetStyle | GridLayoutWidgetStyleInputRepresentation | The style of the widget. | Required | 36.0 |
GridLayoutWidgetStyleInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| backgroundColor | String | The background color for the widget. This is a 6 character hex string. For example: #012345. | Required | 36.0 |
| borderColor | String | The color of the widget border. This is a 6 character hex string. For example: #012345. | Required | 36.0 |
| borderEdges | ConnectWaveBorderEdgeTypeEnum[] | The edges of the border to be drawn. Valid values are:
|
Required | 36.0 |
| borderRadius | Integer | The border radius of the widget. | Optional | 36.0 |
| borderWidth | Integer | The width of the widget's border. | Required | 36.0 |
| bottomPadding | Integer | The amount of padding on the bottom of the widget when rendered on mobile clients. | Optional | 36.0 |
| leftPadding | Integer | The amount of padding on the left of the widget when rendered on mobile clients. | Optional | 36.0 |
| rightPadding | Integer | The amount of padding on the right of the widget when rendered on mobile clients. | Optional | 36.0 |
| tooltipStyle | TooltipStyleInputRepresentation | The style for the dashboard tooltips. | Optional | 63.0 |
| topPadding | Integer | The amount of padding on the top of the widget when rendered on mobile clients. | Optional | 36.0 |
LayoutInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| device | ConnectWaveLayoutDeviceTypeEnum | The device rendering this dashboard. Valid values are:
|
Optional | 36.0 |
| orientation | ConnectWaveLayoutOrientationTypeEnum | The layout orientation of this dashboard. Valid values are:
|
Optional | 36.0 |
| pages | LayoutPageInputRepresentation[] | The list of LayoutPageInputRepresentation objects available for the dashboard. | Optional | 36.0 |
| version | Double | The version of the layout representation for the dashboard. | Optional | 36.0 |
LayoutPageInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| rows | String[] | The rows associated with the layout page. | Optional | 36.0 |
DashboardWidgetInputRepresentation
BoxWidgetParametersInputRepresentation
BoxWidgetParametersInputRepresentation inherits properties from the abstract WidgetParametersInputRepresentation. These base properties appear in BoxWidgetParametersInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| backgroundColor | String | The background color to be used for the widget. | Optional | 36.0 |
| borderColor | String | The border color to be used for the widget. | Optional | 36.0 |
| imageUrl | String | The documentId of the image to be used for the widget. | Optional | 36.0 |
| stretch | Boolean | Indicates whether to stretch the widget (true) or not (false). | Optional | 36.0 |
CompareTableWidgetParametersInputRepresentation
CompareTableWidgetParametersInputRepresentation inherits properties from the abstract WidgetParametersInputRepresentation. These base properties appear in CompareTableWidgetParametersInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| exploreLink | Boolean | Indicates whether to display the explore link (true) or not (false). | Optional | 36.0 |
| maxColumnWidth | Integer | The maximum width of the header column. | Optional | 36.0 |
| minColumnWidth | Integer | The minimum width of the header column. | Optional | 36.0 |
| step | String | The step name for the widget. | Optional | 36.0 |
| totals | Boolean | Indicates whether the totals column is displayed (true) or not (false). | Optional | 36.0 |
ComponentWidgetParametersInputRepresentation
ComponentWidgetParametersInputRepresentation inherits properties from the abstract WidgetParametersInputRepresentation. These base properties appear in ComponentWidgetParametersInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| attributes | Object<String, Object> | The map of this component's attribute values. | Required | 51.0 |
| dynamicAttributes | Object<String, Object> | The map of this component's dynamic attribute values. | Optional | 59.0 |
| pageName | String | The default page of this widget. | Required | 50.0 |
| shareState | Boolean | Indicates whether this component widget shares state with the parent dashboard (true) or not (false). | Required | 51.0 |
| source | TypedAssetReferenceInputRepresentation | The source asset for the component widget. | Required | 46.0 |
| step | String | The attached step for this component widget. | Required | 51.0 |
ContainerWidgetParametersInputRepresentation
ContainerWidgetParametersInputRepresentation inherits properties from the ImageWidgetParametersInputRepresentation.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| interactions | InteractionInputRepresentation[] | A list of the interaction parameters for the widget. | Optional | 58.0 |
DateSelectorWidgetParametersInputRepresentation
DateSelectorWidgetParametersInputRepresentation inherits properties from the abstract SelectorWidgetParametersInputRepresentation. These base properties appear in DateSelectorWidgetParametersInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| absoluteModeEnabled | Boolean | Indicates whether absolute mode is enabled (true) or not (false). | Optional | 43.0 |
| calendarTypeSwitchingAllowed | Boolean | Indicates whether the widget can switch calendar types (true) or not (false). | Optional | 39.0 |
| customFilterPresets[] | CustomFilterPresetTypeEnum | The list of custom preset filters.
Valid values are:
|
Optional | 54.0 |
| defaultAbsoluteMode | Boolean | DEPRECATED Indicates whether default date mode is absolute (true) or not (false). | Optional | 39.0-42.0 |
| defaultFiscalMode | Boolean | Indicates whether the fiscal mode is default (true) or not (false). | Optional | 39.0 |
| displayMode | ConnectWaveSelectorDisplayModeEnum | The display mode type.
Valid values are:
|
Optional | 54.0 |
| expanded | Boolean | Indicates whether the date selector is expanded (true) or not (false) | Optional | 36.0 |
| presetsEnabled | Boolean | Indicates whether presets are expanded (true) or not (false). | Optional | 43.0 |
| modeSwitchingAllowed | Boolean | DEPRECATED Indicates whether the widget can switch between two date modes (true) or not (false). | 39.0-42.0 | |
| relativeModeEnabled | Boolean | Indicates whether relative mode is enabled (true) or not (false). | 43.0 |
FilterPanelWidgetParametersInputRepresentation
FilterPanelWidgetParametersInputRepresentation inherits properties from the abstract WidgetParametersInputRepresentation. These base properties appear in FilterPanelWidgetParametersInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| filterItemOptions | FilterItemOptionsInputRepresentation | The filter item options. | Optional | 41.0 |
| filters | FilterItemReferenceInputRepresentation | The list of filter references mapped to filters section. | Required | 41.0 |
| itemsPerRow | Integer | The number of filter items per row in the filter panel. | Optional | 41.0 |
| showAllFilters | Boolean | Indicates whether all filters are displayed (true) or just one (false). | Optional | 41.0 |
| showInViewMode | Boolean | Indicates whether the filter panel is displayed in view mode (true) or not (false). | Optional | 41.0 |
| title | FilterItemTitleInputRepresentation | Indicates whether the filter panel is displayed in view mode (true) or not (false). | Optional | 41.0 |
GlobalFiltersWidgetParametersInputRepresentation
GlobalFiltersWidgetParametersInputRepresentation inherits properties from the abstract WidgetParametersInputRepresentation. These base properties appear in GlobalFiltersWidgetParametersInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| step | String | The step name tied to the widget. | Optional | 36.0 |
ImageWidgetParametersInputRepresentation
ImageWidgetParametersInputRepresentation inherits properties from the abstract WidgetParametersInputRepresentation. These base properties appear in ImageWidgetParametersInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| alignmentX | ConnectWaveHorizontalAlignmentEnum | The alignment of the text. Valid values are:
|
Optional | 37.0 |
| alignmentY | ConnectWaveVerticalAlignmentEnum | The vertical alignment types. Valid values are:
|
Optional | 37.0 |
| documentId | String | The document ID of the image. | Required | 37.0 |
| fit | ConnectWaveImageFitTypeEnum | The image alignment types. Valid values are:
|
37.0 | |
| image | AssetReferenceInputRepresentation | Image representation containing the name and namespace | 39.0 | |
| interactions | InteractionInputRepresentation[] | A list of the interaction parameters for the widget. | Optional | 58.0 |
| tooltip | String | The tooltip the image. | Optional | 42.0 |
InheritWidgetParametersInputRepresentation
InheritWidgetParametersInputRepresentation inherits properties from the abstract WidgetParametersInputRepresentation. These base properties appear in InheritWidgetParametersInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| step | String | The step name for this widget. | Required | 50.0 |
InputWidgetParametersInputRepresentation
InputWidgetParametersInputRepresentation inherits properties from the abstract WidgetParametersInputRepresentation. These base properties appear in InputWidgetParametersInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| activeValueColor | String | The active color value for this widget. | Required | 56.0 |
| currentValueColor | String | The current color value for this widget. | Required | 56.0 |
| displayFormat | ConnectWaveInputWidgetDisplayFormatEnum | The display format of the input value. Valid values are:
|
Required | 56.0 |
| handleColor | String | The handle color for this widget. | Required | 56.0 |
| increments | Object | The increments for this widget. | Required | 56.0 |
| inputBackgroundColor | String | The background color for this widget. | Required | 56.0 |
| inputBorderColor | String | The border color for this widget. | Required | 56.0 |
| inputType | ConnectWaveInputWidgetInputTypeEnum | The input type of the widget. Valid values are:
|
Required | 56.0 |
| showCurrentValue | Boolean | Indicates whether to show the current value of the widget (true) or not (false). | Required | 56.0 |
| showValuesRange | Boolean | Indicates whether to show the value range of the widget (true) or not (false). | Required | 56.0 |
| step | String | The step name for this widget. | Required | 56.0 |
| title | String | The title for this widget. | Required | 56.0 |
| titleAlignment | ConnectWaveHorizontalAlignmentEnum | The title alignment of the widget. Valid values are:
|
Required | 56.0 |
| titleColor | String | The title color for this widget. | Required | 56.0 |
| titleFontSize | Object | The title font size for this widget. | Required | 56.0 |
| trackColor | String | The track color for this widget. | Required | 56.0 |
| valuesRangeColor | String | The value range color for this widget. | Required | 56.0 |
LinkWidgetParametersInputRepresentation
LinkWidgetParametersInputRepresentation inherits properties from the abstract WidgetParametersInputRepresentation. These base properties appear in LinkWidgetParametersInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| destination | String | The destination of the link. | Optional | 36.0 |
| destinationLink | Object | The destination of the link. | Required | 39.0 |
| destinationType | ConnectWaveLinkWidgetDestTypeEnum | The type of asset the link refers to. Values are:
|
Required | 36.0 |
| fontSize | Integer | The font size to be used for the widget. | Optional | 36.0 |
| includeState | Boolean | Indicates whether the state is included (true) or not (false). | Optional | 36.0 |
| text | String | The value of the text for the widget. | Optional | 36.0 |
| textAlignment | ConnectWaveHorizontalAlignmentEnum | The alignment of the text. Valid values are:
|
Optional | 39.0 |
| textColor | String | The color of the text for the widget. | Optional | 36.0 |
| visualizationType | ConnectWaveVisualizationTypeEnum | The visualization type used for this widget. Valid values are:
|
Optional | 36.0 |
ListSelectorWidgetParametersInputRepresentation
ListSelectorWidgetParametersInputRepresentation inherits properties from the abstract SelectorWidgetParametersInputRepresentation. These base properties appear in ListSelectorWidgetParametersInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| compact | Boolean | Indicates whether the list selector is compact (true) or not (false). | Optional | 36.0 |
| displayTemplate | String | The display template for widget level projection. | Optional | 39.0 |
| expanded | Boolean | Value indicating whether the list selector is expanded (true) or not (false). | Optional | 36.0 |
| exploreLink | Boolean | Indicates whether the list selector has an explore link (true) or not (false). | Optional | 36.0 |
| interactions | InteractionInputRepresentation[] | A list of interactions for the widget. | Optional | 64.0 |
| measureField | String | The measure field this widget is applied on. | Optional | 36.0 |
NumberWidgetParametersInputRepresentation
NumberWidgetParametersInputRepresentation inherits properties from the abstract WidgetParametersInputRepresentation. These base properties appear in NumberWidgetParametersInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| compact | Boolean | Indicates whether the widget is compact (true) or not (false). | Optional | 36.0 |
| destinationLink | Object | The destination link for the widget. | Optional | 47.0 |
| exploreLink | Boolean | Indicates whether the widget has an explore link (true) or not (false). | Optional | 36.0 |
| fontSize | Object | The font size of the text. | Optional | 36.0 |
| interactions | InteractionInputRepresentation[] | A list of the interaction parameters for the widget. | Optional | 58.0 |
| measureField | String | The measure field this number is calculated upon. | Optional | 36.0 |
| noResultsLabel | String | The text to display when no results are found. | Optional | 45.0 |
| numberBold | Object | The font weight of the number. | Optional | 62.0 |
| numberColor | String | The color of the number inside the widget. | Optional | 36.0 |
| numberItalic | Object | The font style of the number. | Optional | 62.0 |
| numberSize | Object | The size of the number. | Optional | 36.0 |
| persistActionMenu | Boolean | Indicates whether to persist the actions menu (true) or not (false). | Optional | 66.0 |
| step | String | The step name tied to the widget. | Optional | 36.0 |
| textAlignment | ConnectWaveHorizontalAlignmentEnum | The alignment of the text. Valid values are:
|
Optional | 36.0 |
| textColor | String | The color of the text inside the widget. | Optional | 36.0 |
| title | String | The title of the widget. | Optional | 36.0 |
| titleBold | Object | The font weight of the title. | Optional | 62.0 |
| titleColor | String | The color of the title for the widget. | Optional | 36.0 |
| titleItalic | Object | The font style of the title. | Optional | 62.0 |
| titleSize | Object | The size of the title text. | Optional | 36.0 |
| tooltip | TooltipInputRepresentation | The tooltip for the widget. | Optional | 51.0 |
PillBoxWidgetParametersInputRepresentation
PillBoxWidgetParametersInputRepresentation inherits properties from the abstract WidgetParametersInputRepresentation. These base properties appear in PillBoxWidgetParametersInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| compact | Boolean | Indicates whether the widget is compact (true) or not (false). | Optional | 36.0 |
| displayTemplate | String | The display template for widget level projection. | Optional | 39.0 |
| exploreLink | Boolean | Indicates whether the widget has an explore link (true) or not (false). | Optional | 36.0 |
| interactions | InteractionInputRepresentation[] | A list of interactions for the widget. | Optional | 64.0 |
| measureField | String | The measure field the widget is constructed upon. | Optional | 36.0 |
| persistActionMenu | Boolean | Indicates whether to persist the actions menu (true) or not (false). | Optional | 66.0 |
| step | String | The step name tied to the widget. | Optional | 36.0 |
| title | String | The title of the widget. | Optional | 36.0 |
RangeSelectorWidgetParametersInputRepresentation
RangeSelectorWidgetParametersInputRepresentation inherits properties from the SelectorWidgetParametersInputRepresentation.
RepeaterWidgetParametersInputRepresentation
RepeaterWidgetParametersInputRepresentation inherits properties from the abstract WidgetParametersInputRepresentation. These base properties appear in RepeaterWidgetParametersInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| cardProperties | RepeaterWidgetCardPropertiesInputRepresentation | The properties for a card for the widget. | Required | 53.0 |
| cellProperties | Map<String, RepeaterWidgetCellPropertiesInputRepresentation> | A map of repeater cell properties for the widget. | Required | 53.0 |
| exploreLink | Boolean | Indicates whether to display the explorer link (true) or not (false). | Optional | 54.0 |
| cellProperties | Map<String, RepeaterWidgetCellPropertiesInputRepresentation> | A map of repeater header cell properties for the widget. | Optional | 64.0 |
| interactions | InteractionInputRepresentation[] | A list of the interaction parameters for the widget. | Optional | 57.0 |
| itemsPerRow | Object | The number of cards per row of the widget. | Required | 53.0 |
| persistActionMenu | Boolean | Indicates whether to persist the actions menu (true) or not (false). | Optional | 66.0 |
| showHeader | Boolean | Indicates whether to display the header (true) or not (false). | Optional | 64.0 |
| sortableColumns | Object | The sortable columns for the widget. | Optional | 59.0 |
| step | String | The step name associated to the widget. | Required | 53.0 |
TableWidgetParametersInputRepresentation
TableWidgetParametersInputRepresentation inherits properties from the abstract WidgetParametersInputRepresentation. These base properties appear in TableWidgetParametersInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| assistiveText | String | The assistive text for the widget. | Optional | 64.0 |
| borderColor | String | The outer border color for the widget. | Optional | 41.0 |
| borderWidth | Integer | The outer border width for the widget. | Optional | 41.0 |
| cell | TableWidgetCellParametersInputRepresentation | The cell properties for the widget. | Optional | 41.0 |
| collapsible | Boolean | Indicates whether the table is collapsible (true) or not (false). | Optional | 50.0 |
| columnProperties | Map<String, ColumnPropertiesInputsRepresentation> | The column properties for the widget. | Optional | 42.0 |
| columnTotals | Boolean | Indicates whether to display column totals in the table (true) or not (false). | Optional | 55.0 |
| columnSubtotals | Boolean | Indicates whether to display column subtotals in the table (true) or not (false). | Optional | 56.0 |
| columns | Object | The list of columns for the widget. | Required | 41.0 |
| customBulkActions | CustomBulkActionInputRepresentation[] | The list of custom bulk actions for the widget. | Optional | 42.0 |
| enableAllDataFetch | Boolean | Indicates whether all data is loaded (true) or data loading is paginated (false). | Optional | 59.0 |
| evenRowColor | String | The even row color for the widget. | Optional | 41.0 |
| exploreLink | Boolean | Indicates whether the widget has an explore link (true) or not (false). | Optional | 38.0 |
| fixedColumnWidth | Integer | The fixed column width for the widget. | Optional | 40.0 |
| header | TableWidgetCellParametersInputRepresentation | The header properties for the widget. | Required | 41.0 |
| headerProperties | HeaderPropertiesInputRepresentation | The header properties for the table columns in the widget. | Small, 64.0 | 64.0 |
| innerMajorBorderColor | String | The inner major border color for the widget. | Optional | 41.0 |
| innerMinorBorderColor | String | The inner minor border color for the widget. | Optional | 41.0 |
| interactions | InteractionInputRepresentation[] | A list of the interaction parameters for the widget. | Optional | 57.0 |
| maxColumnWidth | Integer | The maximum column width for the widget. | Optional | 40.0 |
| minColumnWidth | Integer | The minimum column width for the widget. | Optional | 40.0 |
| mode | ConnectWaveTableModeEnum | The table mode for the widget. Valid values are:
|
Optional | 40.0 |
| numberOfFrozenColumns | Integer | The number of frozen columns for the widget. | Optional | 50.0 |
| numberOfLines | Integer | The number of lines of text per row for the widget. | Optional | 41.0 |
| oddRowColor | String | The odd row color for the widget. | Optional | 41.0 |
| persistActionMenu | Boolean | Indicates whether to persist the actions menu (true) or not (false). | Optional | 66.0 |
| pivoted | Boolean | Indicates whether to display the widget as pivot (true) or not (false). | Optional | 39.0 |
| repeatGroupingRowValues | Boolean | Indicates whether to repeat row values (true) or not (false). | Optional | 66.0 |
| rowTotals | Boolean | Indicates whether to display row totals in the table (true) or not (false). | Optional | 55.0 |
| showRowIndexColumn | Boolean | Indicates whether to show the row index column for the widget (true) or not (false). | Optional | 41.0 |
| step | String | The step name associated to the widget. | Required | 38.0 |
| subtotals | Boolean | Indicates whether to show the subtotals row for the widget (true) or not (false). | Optional | 47.0 |
| totals | Boolean | Indicates whether to show the totals row for the widget (true) or not (false). | Optional | 40.0 |
| verticalPadding | Integer | The cell vertical padding value for the widget. | Optional | 41.0 |
TextWidgetParametersInputRepresentation
TextWidgetParametersInputRepresentation inherits properties from the abstract WidgetParametersInputRepresentation. These base properties appear in TextWidgetParametersInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| conditionalFormattingSource | TextWidgetConditionalFormattingSourceInputRepresentation | The conditional formatting source for the widget. | Optional | 57.0 |
| content | DynamicDataInputRepresentation | The dynamic value of the text in the widget. | Required | 49.0 |
| fontSize | Object | The font size of the text. | Optional | 36.0 |
| interactions | InteractionInputRepresentation[] | A list of the interaction parameters for the widget. | Optional | 57.0 |
| persistActionMenu | Boolean | Indicates whether to persist the actions menu (true) or not (false). | Optional | 66.0 |
| text | String | DEPRECATED The text for the widget. | Optional | 36.0-48.0 |
| textAlignment | ConnectWaveHorizontalAlignmentEnum | The alignment of the text. Valid values are:
|
Optional | 36.0 |
| textColor | String | The color of the text. | Optional | 36.0 |
| textOverflow | ConnectWaveTextOverflowEnum | The overflow of the text. Valid values are:
|
Optional | 60.0 |
| tooltip | String | The tooltip for the widget. | Optional | 42.0 |
UrlWidgetParametersInputRepresentation
UrlWidgetParametersInputRepresentation inherits properties from the abstract WidgetParametersInputRepresentation. These base properties appear in UrlWidgetParametersInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| type | ConnectWaveUrlWidgetType | The type of URL for the widget. Valid values are:
|
Optional | 36.0 |
| url | String | The connect URL for the widget. | Optional | 36.0 |
| videoSize | String | The size of the video at which this URL points. | Optional | 36.0 |
ValuesTableWidgetParametersInputRepresentation
ValuesTableWidgetParametersInputRepresentation inherits properties from the abstract WidgetParametersInputRepresentation. These base properties appear in ValuesTableWidgetParametersInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| exploreLink | Boolean | Indicates whether the widget has an explore link (true) or not (false). | Optional | 36.0 |
| hideHeaderColumn | Boolean | Indicating whether the header column is visible for the widget (true) or not (false). | Optional | 36.0 |
| maxColumnWidth | Integer | The maximum width of the header column. | Optional | 36.0 |
| minColumnWidth | Integer | The minimum width of the header column. | Optional | 36.0 |
| step | String | The step name tied to the widget. | Optional | 36.0 |
| totals | Boolean | Indicates whether the totals column is displayed (true) or not (false). | Optional | 36.0 |
ImageParametersInputRepresentation
ImageParametersInputRepresentation inherits properties from the abstract WidgetParametersInputRepresentation. These base properties appear in ImageParametersInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| alignmentX | ConnectWaveHorizontalAlignmentEnum | The alignment of the text. Valid values are:
|
Optional | 37.0 |
| alignmentY | ConnectWaveVerticalAlignmentEnum | The vertical alignment types. Valid values are:
|
Optional | 37.0 |
| altText | String | The alternate text for the image. | Optional | 55.0 |
| documentId | String | The document id of the image. | Optional | 37.0 |
| fit | ConnectWaveImageFitTypeEnum | The image alignment types. Valid values are: Valid values are:
|
Optional | 37.0 |
| image | AssetReferenceInputRepresentation | The image representation containing the name and the namespace. | Required | 39.0 |
| tooltip | String | The tooltip for the image. | Optional | 42.0 |
SelectorWidgetParametersInputRepresentation
SelectorWidgetParametersInputRepresentation inherits properties from the abstract WidgetParametersInputRepresentation. These base properties appear in SelectorWidgetParametersInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| displayMode | ConnectWaveSelectorDisplayModeEnum | The display mode for dashboard selector widgets. Valid values are:
|
Required | 46.0 |
| filterStyle | FilterStyleInputRepresentation | The styling properties for filter widgets. | Optional | 46.0 |
| instant | Boolean | Indicates whether the list selector is instant (true) or not (false). | Optional | 36.0 |
| persistActionMenu | Boolean | Indicates whether to persist the actions menu (true) or not (false). | Optional | 66.0 |
| step | String | The step name associated to the widget. | Required | 36.0 |
| title | String | The title of the widget. | Optional | 36.0 |
WidgetParametersInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| onboarding | WidgetOnboardingInputRepresentation | The list of onboarding content for the widget. | Optional | 46.0 |
| selectModeOverride | ConnectWaveSelectModeEnum | The select mode types. Valid values are:
|
Optional | 36.0 |
| showActionMenu | Boolean | Indicates whether to display the widget action menu (true) or not (false). | Optional | 44.0 |
WidgetOnboardingInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| title | String | The title of the onboarding content. | Optional | 46.0 |
| url | String | The URL of the onboarding content. | Required | 46.0 |
WidgetPositionInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| h | String | The height of the widget. | Optional | 36.0 |
| w | String | The width of the widget. | Optional | 36.0 |
| x | Integer | The X index of widget. | Optional for PATCH, required for POST | 36.0 |
| y | Integer | The Y index of widget. | Optional for PATCH, required for POST | 36.0 |
| zIndex | Integer | The Z index of widget. | Optional | 36.0 |
InteractionRepresentationInput
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| actions | InteractionActionInputRepresentation[] | A list of the actions for the interaction. Valid actions types are: | Required | 57.0 |
| event | ConnectWaveInteractionEventType | The event type for the interaction. Valid values are:
|
Required | 57.0 |
InteractionActionInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| type | ConnectWaveInteractionActionTypeEnum | The action type for the interaction. Valid values are:
|
Required | 60.0 |
InteractionClearActionInputRepresentation
InteractionClearActionInputRepresentation inherits properties from the abstract InteractionActionInputRepresentation. These base properties appear in InteractionClearActionInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| clearType | ConnectWaveInteractionClearTypeEnum | The clear type for the interaction. Valid values are:
|
Required | 59.0 |
| lensIds | String[] | A list of lens IDs for the interaction. | Required | 59.0 |
InteractionFlowActionInputRepresentation
InteractionFlowActionInputRepresentation inherits properties from the abstract InteractionActionInputRepresentation. These base properties appear in InteractionFlowActionInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| attributes | Map<Object,Object> | A map of interaction attributes. | Required | 58.0 |
| name | String | The API name of the action. | Required | 58.0 |
InteractionResetActionInputRepresentation
InteractionResetActionInputRepresentation inherits properties from the abstract InteractionActionInputRepresentation. These base properties appear in InteractionResetActionInputRepresentation alongside the properties defined explicitly in the following table.
| Property Name | Type | Description | Required | Available Version |
|---|---|---|---|---|
| resetType | ConnectWaveInteractionResetTypeEnum | The reset type for the action. Valid values are:
|
Required | 58.0 |
TextWidgetConditionalFormattingSourceInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| field | String | The field used to retrieve the conditional formatting for the widget. | Required | 57.0 |
| scope | String | The scope of the conditional formatting rules for the widget | Required | 57.0 |
| step | String | The step used to retrieve the conditional formatting rules for the widget | Required | 57.0 |
FilterItemOptionsInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| backgroundColor | String | The background color of the filter items. | Optional | 41.0 |
| borderColor | String | The border color of the filter items. | Optional | 41.0 |
| borderRadius | Integer | The border radius of the filter items. | Optional | 41.0 |
| borderWidth | Integer | The border width of the filter items. | Optional | 41.0 |
| propertyColor | String | The property color of the filter items. | Optional | 41.0 |
| valueColor | String | The value color of the filter items. | Optional | 41.0 |
FilterItemReferenceInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| cdpObject | String | The Data 360 datasource in the filters section. | Required | 55.0 |
| dataset | AssetReferenceInputRepresentation[] | The dataset in the filters section. | Required | 46.0 |
| dataspace | String | The name of datasapce for the Data 360 datasource in the filters section. | Optional | 62.0 |
| field | String | The field in the filters section. | Required | 46.0 |
| sObject | String | The sObject in the filters section. | Required | 55.0 |
FilterPanelTitleInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| separatorColor | String | The filter panel's title separator color. | Optional | 41.0 |
| text | TextInputRepresentation[] | The filter panel's title text. | Required | 41.0 |
| visible | Boolean | Indicates whether the filter panel's title is visible (true) or not (false). | Optional | 41.0 |
TextInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| align | ConnectWaveHorizontalAlignmentEnum | The alignment of the text. Valid values are:
|
Optional | 41.0 |
| color | String | The color of the text. | Optional | 41.0 |
| fontSize | Integer | The font size of the text. | Optional | 41.0 |
| label | String | The label for the text. | Required | 41.0 |
FilterStyleInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| titleColor | String | The color of the displayed title. | Required | 46.0 |
| valueColor | String | The color for the displayed value. | Required | 46.0 |
TabStyleParametersInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| backgroundColor | String | The background color for the tab. | Optional | 43.0 |
| borderColor | String | The border color for the tab. | Optional | 43.0 |
| borderEdges | ConnectWaveBorderEdgeTypeEnum | The edges of the border to be drawn. Valid values are:
|
Optional | 43.0 |
| borderWidth | Integer | The border width for the tab. | Optional | 43.0 |
| textColor | String | The text color for the selected tab. | Optional | 43.0 |
TooltipInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| content | TooltipContentInputRepresentation | The content for the tooltip. | Required | 51.0 |
| customizeTooltip | Boolean | Indicates whether the tooltip is customized (true) or not (false). | Required | 51.0 |
| showTooltipTitle | Boolean | Indicates whether the tooltip title is visible (true) or not (false). | Optional | 62.0 |
RepeaterWidgetCardPropertiesInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| cellSpacingX | Integer | The horizontal spacing between grid cells. | Required | 53.0 |
| cellSpacingY | Integer | The vertical spacing between grid cells. | Required | 53.0 |
| numColumns | Integer | The number of columns for a repeater grid. | Required | 53.0 |
| rowHeight | ConnectWaveRowHeightEnum | Specifies the grid cell row height. Valid values are:
|
Required | 53.0 |
| selectedStyles | CardSelectionStyleParametersInputRepresentation | The styling for the selected repeater card of the widget | Required | 54.0 |
| styles | GridLayoutWidgetStyleInputRepresentation | The styling for the card of the widget | Required | 53.0 |
CardSelectionStyleParametersInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| backgroundColor | String | The background color of selected card. Must be a 6 digit hex string. | Optional | 54.0 |
| borderColor | String | The border color of selected card. Must be a 6 digit hex string. | Optional | 54.0 |
| borderEdges | ConnectWaveBorderEdgeTypeEnum[] | The edges of the border to be drawn.
Valid values are:
|
Required | 54.0 |
| borderRadius | Integer | The border radius of selected card. | Optional | 54.0 |
| borderWidth | Integer | The border width of selected card. | Optional | 54.0 |
RepeaterWidgetCellPropertiesInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| parameters | Object | The parameters of the cell, based on it's type. | Required | 53.0 |
| position | GridLayoutWidgetInputRepresentation | The cell position, dimension, and styles. | Required | 53.0 |
| type | ConnectWaveRepeaterCellTypeEnum | The cell type. Valid values are: | Required | 53.0 |
CellPropertiesImageParametersInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| alignmentX | ConnectWaveHorizontalAlignmentEnum | The horizontal alignment for the image. Valid values are:
|
Required | 54.0 |
| alignmentY | ConnectWaveVerticalAlignmentEnum | The vertical alignment for the image. Valid values are:
|
Required | 54.0 |
| altText | String | The alternate text for the image. | Optional | 54.0 |
| fit | ConnectWaveImageFitTypeEnum | The fit type for the image. Valid values are:
|
Required | 54.0 |
| source | Object | The source URL for the image. | Optional | 54.0 |
CellPropertiesNumberParametersInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| compact | Boolean | Indicates whether compact form is on (true) or not (false). | Optional | 54.0 |
| measureField | String | The measure field this number is calculated from. | Required | 54.0 |
| noResultsLabel | String | The text to display when no results are found. | Optional | 54.0 |
| numberBold | Object | The font weight of the number. | Optional | 62.0 |
| numberColor | String | The color of the number. | Optional | 54.0 |
| numberItalic | Object | The font style of the number. | Optional | 62.0 |
| numberSize | Object | The size of the number. | Optional | 54.0 |
| textAlignment | ConnectWaveHorizontalAlignmentEnum | The alignment for the text. Valid values are:
|
Required | 54.0 |
| title | String | The title of the widget. | Optional | 54.0 |
| titleBold | String | The font weight of the title. | Optional | 62.0 |
| titleColor | String | The color of the title. | Optional | 54.0 |
| titleSize | String | The size of the title. | Optional | 54.0 |
CellPropertiesTextParametersInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| conditionalFormattingSource | TextWidgetConditionalFormattingSourceInputRepresentation | The conditional formatting source for the text. | Optional | 57.0 |
| content | DynamicDataInputRepresentation | The dynamic value of the text. | Required | 54.0 |
| interactions | InteractionInputRepresentation[] | A list of interactions for the text. | Optional | 64.0 |
| tooltip | TooltipInputRepresentation | The tooltip for the text. | Optional | 57.0 |
TableWidgetCellParametersInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| alignment | ConnectWaveHorizontalAlignmentEnum | The horizontal alignment for the table cell. Valid values are:
|
Optional | 62.0 |
| backgroundColor | String | The background color of the cell. | Optional | 41.0 |
| fontColor | String | The color for the cell text font. | Optional | 41.0 |
| fontSize | Integer | The size for the cell text font. | Optional | 41.0 |
| italic | Boolean | Indicates whether the cell font style is italic (true) or not (false). | Optional | 62.0 |
| textWrap | Boolean | Indicates whether text wrapping is allowed (true) or not (false). | Optional | 54.0 |
| underline | Boolean | Indicates whether the cell font style is underlined (true) or not (false). | Optional | 62.0 |
ColumnPropertiesInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| parameters | Object | The valid column parameters based on its type. | Required | 42.0 |
| type | ConnectWaveColumnRenderTypeEnum | The render types of a column. Valid values are: | Required | 41.0 |
ColumnParametersBarInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| hideTotals | Object | The hide totals for the column. | Optional | 67.0 |
| width | Integer | The width for the column. | Required | 54.0 |
ColumnParametersImageInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| alignment | ConnectWaveHorizontalAlignmentEnum | The horizontal alignment for the image. Valid values are:
|
Required | 54.0 |
| height | Integer | The image height for the image. | Required | 54.0 |
| width | Integer | The width for the column. | Required | 54.0 |
ColumnParametersTextInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| alignment | ConnectWaveHorizontalAlignmentEnum | The horizontal alignment for the column. Valid values are:
|
Required | 54.0 |
| hideTotals | Object | The hide totals for the column. | Optional | 67.0 |
| styles | TextStyleInputRepresentation | The text style for the column. | Required | 54.0 |
| width | Integer | The width for the column. | Required | 54.0 |
TextStyleInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| bold | Boolean | Indicates whether the text is bold (true) or not (false). | Optional | 54.0 |
| linkColor | String | The text color when the text is a link. | Optional | 54.0 |
CustomBulkActionInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| label | String | Label for the custom action | 39.0 | |
| visualforce | AssetReferenceInputRepresentation | Visualforce page to invoke for the custom action | 39.0 |
DynamicDataInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| displayTemplate | String | The dynamic expression to resolve. | Required | 49.0 |
| richTextContent | Map<String, RichTextContentBlockInputRepresentation[] | List of rich text content blocks. | Required | 52.0 |
| values | Map<String, DynamicValueInputRepresentation> | Map to contain the data for the dynamic values. | Required | 49.0 |
RichTextContentBlockInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| attributes | Map<String, Object> | Map of text attribute names and values. | Required | 52.0 |
| insert | String | The text block content | Required | 52.0 |
DynamicValueInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| compact | Boolean | Indicates whether the resolved value is compact (true) or not (false). | Required | 55.0 |
| field | String | The column used to resolve the value. | Required | 49.0 |
| noResultsLabel | String | The text to display when no results are found. | Required | 55.0 |
| sourceType | ConnectWaveDynamicDataSourceType | The interaction type for the value. Valid values are:
|
Required | 49.0 |
| step | String | The step id for the value. | Required | 49.0 |
TooltipContentInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| body | TooltipVisualizationInputRepresentation | The visualization for the tooltip. | Required | 51.0-52.0 |
| description | DynamicDataInputRepresentation | The text content for the tooltip. | Required | 51.0 |
| widget | TooltipWidgetInputRepresentation | The widget displayed in the tooltip. | Required | 53.0 |
TooltipWidgetInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| height | Object | The height of the widget in the tooltip. | Required | 53.0 |
| name | String | The name of the widget in the tooltip. | Required | 53.0 |
| width | Object | The width of the widget in the tooltip. | Required | 53.0 |
TooltipVisualizationInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| height | Object | The height for the tooltip. | Required | 51.0 |
| source | TypedAssetReferenceInputRepresentation | The source for the tooltip visualization. | Required | 51.0 |
| width | Object | The width for the tooltip. | Required | 51.0 |
TooltipSourceInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| name | String | The name of the tooltip source. | Required | 51.0 |
| namespace | String | The namespace of the tooltip source. | Optional | 51.0 |
| type | String | The type of the tooltip source. | Required | 51.0 |
TooltipStyleInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| backgroundColor | String | The background color of the tooltip. | Optional | 63.0 |
| labelColor | String | The label color of the tooltip. | Optional | 63.0 |
| valueColor | String | The value color of the tooltip. | Optional | 63.0 |
HeaderPropertiesInputRepresentation
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| tooltip | TableColumnHeaderTooltipInputRepresentation | The tooltip for the table column header. | Required | 64.0 |