Tableau CRM REST API Developer Guide
jNewer Version Available
Collections List Resource
Returns a list of collections or creates a collection. Each collection contains Tableau CRM resource items.
- Resource URL
-
1/wave/collections - Formats
- JSON
- Available Version
- 52.0
- HTTP Methods
- GET POST
- GET Request Parameters
-
Parameter Name Type Description Required or Optional Available Version editableOnly Boolean Filters the results for only collections the current user has edit access to. Optional 52.0 includeItems Boolean Indicates whether the collection items are returned in the response (true) or not (false). Optional 52.0 limit Integer The limit of collections to return. Optional 52.0 offset Integer Indicates the starting index for list of collections returned. The default value is 0. Optional 52.0 pageToken String The token to use for next page. Optional 52.0 pinnedOnly Boolean Filters the results for pinned collections only. Optional 52.0 type CollectionTypeEnum Filters the results by collection type. Valid values are: Static. The default is to return all types of collections. Optional 52.0 - GET Response Body (WaveCollectionListRepresentation)
-
Property Name Type Description Filter Group and Version Available Version collections WaveCollectionRepresentation[] A collection of Tableau CRM resources. 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 (WaveCollectionInputRepresentation)
-
Parameter Name Type Description Required or Optional Available Version color String The configured color for the collection, represented as a hexadecimal value. Optional 52.0 description String The description for the collection. Optional 52.0 label String The label of the collection. Required 52.0 pins WaveCollectionPinInputRepresentation[] The list of pinning rules for the collection. Optional 52.0 shares WaveFolderShareInputRepresentation[] The list of sharing rules for the collection. Optional 52.0 collectionType CollectionTypeEnum The collection type. Valid values are: Static Required 52.0 - POST Response Body (WaveCollectionRepresentation)
-
Parameter Name Type Description Filter Group and Version Available Version collectionType CollectionTypeEnum The collection type. Valid values are: Static Small, v52.0 52.0 color String The configured color for the collection, represented as a hexadecimal value. Supplemental, v52.0 52.0 isPinned Boolean Indicates whether this collection is pinned for the current user (true) or not (false). Small, v52.0 52.0 itemList WaveCollectionItemListRepresentation[] The list of items in the collection. Small, 52.0 52.0 itemsUrl Boolean The URL to get the items in the collection. Small, v52.0 52.0 - WaveCollectionPinInputRepresentation
-
Parameter Name Type Description Required or Optional Available Version pinnedFor ID The id of a group, a role, or a user the pinning rule is defined for. Required 52.0 pinnedForType ConnectWaveShareTypeEnum The share type. Valid values are: - AllCspUsers
- AllPrmUsers
- CustomerPortalUser
- Group
- Organization
- PartnerUser
- PortalRole
- PortalRoleAndSubordinates
- Role
- RoleAndSubordinates
- User
Required 52.0 type CollectionPinTypeEnum The type of pinning. Valid values are: - All
- Desktop
- Mobile
Optional 52.0 - WaveCollectionItemListRepresentation
-
Parameter Name Type Description Filter Group and Version Available Version collectionItems WaveCollectionItemRepresentation[] The list of collection items. Small, 52.0 52.0 nextPageToken String The token for the next page if there are more items. Small, v52.0 52.0 totalCount Integer The total count of collection items. Small, v52.0 52.0 - 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