Tableau CRM REST API Developer Guide
jNewer Version Available
Collections Items Resource
Returns Tableau CRM collection items and creates, updates, or deletes items in the
collection.
- Resource URL
-
1/wave/collections/<collectionId>/items - Formats
- JSON
- Available Version
- 52.0
- HTTP Methods
- GET POST PATCH DELETE
- GET Request Parameters
-
Parameter Name Type Description Required or Optional Available Version itemType CollectionItemAssetTypeEnum Filters the results by the collection item asset type. Valid values are: - Dashboard
- Lens
Optional 52.0 limit Integer The limit of collections to return. Optional 52.0 mobileOnly Boolean Filters the results to return only mobile asset items. Optional 52.0 offset Integer Indicates the starting index for list of collections items returned. The default value is 0. Optional 52.0 pageToken String The token to use for next page. Optional 52.0 - GET Response Body (WaveCollectionItemListRepresentation)
-
Property Name Type Description Filter Group and Version Available Version collectionItems WaveCollectionItemRepresentation[] A list of items in the collection. Small, 52.0 52.0 nextPageToken String The next page token if there are more records in the collection. Small, 52.0 52.0 totalCount Integer The total count of collections. Small, 52.0 52.0 - POST Request Body (WaveCollectionItemInputRepresentation)
-
Parameter Name Type Description Required or Optional Available Version assetType CollectionItemAssetTypeEnum Filters the results by the collection item asset type. Valid values are: - Dashboard
- Lens
Required 52.0 id ID The ID of the collection item. Required 52.0 itemId ID The ID of the item. Required 52.0 - POST Response Body (WaveCollectionItemRepresentation)
-
Parameter Name Type Description Filter Group and Version Available Version assetType CollectionItemAssetTypeEnum The collection item asset type. Valid values are: - Dashboard
- Lens
Small, 52.0 52.0 collectionItemId String The id of the association between the collection and asset item. Small, v52.0 52.0 files LensFileRepresentation[] The list of files used to create the asset item. Small, v52.0 52.0 folder AssetReferenceRepresentation The folder metadata for the asset item. Small, v52.0 52.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, v52.0 52.0 - PATCH Request Body (WaveCollectionItemListInputRepresentation)
-
Parameter Name Type Description Required or Optional Available Version items WaveCollectionItemInputRepresentation[] The list of items in the collection. Required 52.0 - PATCH Response Body (WaveCollectionItemListRepresentation)
-
Property Name Type Description Filter Group and Version Available Version collectionItems WaveCollectionItemRepresentation[] A list of items in the collection. Small, 52.0 52.0 nextPageToken String The next page token if there are more records in the collection. Small, 52.0 52.0 totalCount Integer The total count of collections. Small, 52.0 52.0 - DELETE Request
-
1/wave/collections/<collectionId>/items/<collectionItemId>