Tableau CRM REST API 開発者ガイド
jCollections List リソース
コレクションのリストを返したり、コレクションを作成したりします。各コレクションには、Tableau CRM リソース項目が含まれます。
- リソース URL
-
1/wave/collections - 形式
- JSON
- 使用可能なバージョン
- 52.0
- HTTP のメソッド
- GET POST
- GET の要求パラメータ
-
パラメータ名 型 説明 必須か省略可能 使用可能なバージョン editableOnly Boolean 現在のユーザが編集アクセス権を持つコレクションのみが得られるように結果を絞り込みます。 省略可能 52.0 includeItems Boolean コレクション項目が応答で返されるか (true)、否か (false) を示します。 省略可能 52.0 limit Integer 返されるコレクションの制限。 省略可能 52.0 offset Integer 返されたコレクションのリストの開始インデックスを示します。デフォルト値は、0 です。 省略可能 52.0 pageToken String 次のページで使用するトークン。 省略可能 52.0 pinnedOnly Boolean 固定されたコレクションのみが得られるように結果を絞り込みます。 省略可能 52.0 type CollectionTypeEnum コレクション種別で結果を絞り込みます。有効な値は、Static です。デフォルトでは、すべての種別のコレクションが返されます。 省略可能 52.0 - GET レスポンスボディ (WaveCollectionListRepresentation)
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン collections WaveCollectionRepresentation[] Tableau CRM リソースのコレクション。 Small、52.0 52.0 nextPageToken String コレクション内のレコードがさらに増えた場合の次のページのトークン。 Small、52.0 52.0 totalCount Integer コレクションの合計数。 Small、52.0 52.0 - POST リクエストボディ (WaveCollectionInputRepresentation)
-
パラメータ名 型 説明 必須か省略可能 使用可能なバージョン color String コレクションに設定する色。16 進値で指定します。 省略可能 52.0 description String コレクションの説明。 省略可能 52.0 label String コレクションの表示ラベル。 必須 52.0 pins WaveCollectionPinInputRepresentation[] コレクションの固定されたルールのリスト。 省略可能 52.0 shares WaveFolderShareInputRepresentation[] コレクションの共有ルールのリスト。 省略可能 52.0 collectionType CollectionTypeEnum コレクション種別。有効な値は、Static です 必須 52.0 - POST レスポンスボディ (WaveCollectionRepresentation)
-
パラメータ名 型 説明 検索条件グループとバージョン 使用可能なバージョン collectionType CollectionTypeEnum コレクション種別。有効な値は、Static です Small、v52.0 52.0 color String コレクションに設定する色。16 進値で指定します。 Supplemental、v52.0 52.0 isPinned Boolean 現在のユーザのこのコレクションが固定されているか (true)、否か (false) を示します。 Small、v52.0 52.0 itemList WaveCollectionItemListRepresentation[] コレクション内の項目のリスト。 Small、52.0 52.0 itemsUrl Boolean コレクション内の項目を取得するための URL。 Small、v52.0 52.0 - WaveCollectionPinInputRepresentation
-
パラメータ名 型 説明 必須か省略可能 使用可能なバージョン pinnedFor ID 固定中のルールが定義されているグループ、ロール、またはユーザの ID。 必須 52.0 pinnedForType ConnectWaveShareTypeEnum 共有種別。有効な値は、次のとおりです。 - AllCspUsers
- AllPrmUsers
- CustomerPortalUser
- Group
- Organization
- PartnerUser
- PortalRole
- PortalRoleAndSubordinates
- Role
- RoleAndSubordinates
- User
必須 52.0 type CollectionPinTypeEnum 固定の種別。有効な値は、次のとおりです。 - All
- Desktop
- Mobile
省略可能 52.0 - WaveCollectionItemListRepresentation
-
パラメータ名 型 説明 検索条件グループとバージョン 使用可能なバージョン collectionItems WaveCollectionItemRepresentation[] コレクション項目のリスト。 Small、52.0 52.0 nextPageToken String 項目がさらに増えた場合の次のページのトークン。 Small、v52.0 52.0 totalCount Integer コレクション項目の合計数。 Small、v52.0 52.0 - WaveCollectionItemRepresentation
-
パラメータ名 型 説明 検索条件グループとバージョン 使用可能なバージョン assetType CollectionItemAssetTypeEnum コレクション項目のアセット種別。有効な値は、次のとおりです。 - Dashboard
- Lens
Small、52.0 52.0 collectionItemId String コレクションとアセット項目間の関連付けの ID。 Small、v52.0 52.0 files LensFileRepresentation[] アセット項目の作成に使用されたファイルのリスト。 Small、v52.0 52.0 folder AssetReferenceRepresentation アセット項目のフォルダメタデータ。 Small、v52.0 52.0 visibility ConnectWaveAssetVisibilityType アセットが参照アクセス権を持つユーザに対して非表示になるかどうかを示します。有効な値は、次のとおりです。 - All (すべてのアセットを表示)
- Limited (参照アクセス権を持つ閲覧者にアセットを非表示)
Small、v52.0 52.0