Tableau CRM REST API Developer Guide
jNewer Version Available
Dashboard Resource
- Resource URL
-
1/wave/dashboards/<dashboardIdOrApiName> - Formats
- JSON
- Available Version
- 36.0
- Available Components
- HTTP Methods
- GET DELETE PATCH
- GET Response Body (DashboardRepresentation)
-
DashboardRepresentation inherits properties from the abstract BaseTemplatedAssetRepresentation. These base properties appear in DashboardRepresentation alongside the properties defined explicitly in the following table.
Property Name Type Description Filter Group and Version Available Version allowPreview Boolean Indicates whether this dashboard is available for preview. Small, 36.0 36.0 currentHistoryId String The current saved history to display for the dashboard. If null, the latest dashboard is displayed Small, 44.0 44.0 datasets AssetReferenceRepresentation[] The list of datasets used to create this dashboard. Small, 36.0 36.0 dateVersion Integer The version of dates used by the dashboard. Valid values are: - 1
- 2
Small, 44.0 44.0 files LensFileRepresentation[] The list of files used to create this dashboard. Medium, 36.0 36.0 filesUrl String The URL for the files associated with the dashboard. Small, 36.0 36.0 folder AssetReferenceRepresentation[] The folder that contains this dashboard. Small, 36.0 36.0 historiesUrl String The URL for the dashboard histories associated with this dashboard. Small, 44.0 44.0 mobileDisabled Boolean Indicates whether the dashboard is disabled for mobile or not. Small, 41.0 41.0 refreshDate Date The date of the most recent current dataset that is used by the dashboard, in ISO8601 date format. Small, 36.0 36.0 state DashboardStateRepresentation The state of the dashboard Big, 36.0 36.0 visibility ConnectWaveAssetVisibilityType Indicates whether the asset is hidden from users with view access or not. Valid values are: - All (Show all assets)
- Limited (Hide assets from viewers with view access)
Small, 51.0 51.0 - PATCH Request Body (DashboardInputRepresentation)
-
DashboardInputRepresentation inherits properties from the abstract BaseAssetInputRepresentation. These base properties appear in DashboardInputRepresentation alongside the properties defined explicitly in the following table.
Parameter Name Type Description Required or Optional Available Version currentHistoryId String The current saved history id to display for the dashboard. Optional 44.0 dateVersion Integer The version of dates used by the dashboard. Valid values are: - 1
- 2
Optional 44.0 folder AssetReferenceInputRepresentation The folder in which this dashboard is stored. Required for POST, optional for PATCH 44.0 historyLabel String A history label to tag the dashboard version being saved. Optional 44.0 mobileDisabled Boolean Indicates whether the dashboard is disabled for mobile or not. Optional 41.0 state DashboardStateInputRepresentation The state of the dashboard. Required for POST, optional for PATCH 36.0 type ConnectWaveAssetTypeEnum The asset type. The default type is Dashboard. Valid types are: - Collection
- Component
- Dashboard
- DashboardSnapshot
- DataConnector
- DataPoolEntity
- DataPoolEntityVersion
- Dataflow
- DataflowJob
- DataflowJobNode
- Dataset
- DatasetShard
- DatasetVersion
- ExternalData
- Folder
- Lens
- LightningComponent
- Recipe
- RecipeModel
- ReplicatedDataset
- Story
- Widget
- Workflow
Optional 44.0 xmd XmdInputRepresentation The asset XMD of the dashboard. Optional 44.0 visibility ConnectWaveAssetVisibilityType Indicates whether the asset is hidden from users with view access or not. Valid values are: - All (Show all assets)
- Limited (Hide assets from viewers with view access)
Optional 51.0 The following JSON shows how to edit an existing dashboard description.
1{ 2 "description": "This is my dashboard", 3 "label": "Test Dashboard" 4} - PATCH Response Body (DashboardRepresentation)
-
Property Name Type Description Filter Group and Version Available Version allowPreview Boolean Indicates whether this dashboard is available for preview. Small, 36.0 36.0 currentHistoryId String The current saved history to display for the dashboard. If null, the latest dashboard is displayed Small, 44.0 44.0 datasets AssetReferenceRepresentation[] The list of datasets used to create this dashboard. Small, 36.0 36.0 dateVersion Integer The version of dates used by the dashboard. Valid values are: - 1
- 2
Small, 44.0 44.0 files LensFileRepresentation[] The list of files used to create this dashboard. Medium, 36.0 36.0 filesUrl String The URL for the files associated with the dashboard. Small, 36.0 36.0 folder AssetReferenceRepresentation[] The folder that contains this dashboard. Small, 36.0 36.0 historiesUrl String The URL for the dashboard histories associated with this dashboard. Small, 44.0 44.0 mobileDisabled Boolean Indicates whether the dashboard is disabled for mobile or not. Small, 41.0 41.0 refreshDate Date The date of the most recent current dataset that is used by the dashboard, in ISO8601 date format. Small, 36.0 36.0 state DashboardStateRepresentation The state of the dashboard Big, 36.0 36.0 visibility ConnectWaveAssetVisibilityType Indicates whether the asset is hidden from users with view access or not. Valid values are: - All (Show all assets)
- Limited (Hide assets from viewers with view access)
Small, 51.0 51.0