Tableau CRM REST API 開発者ガイド
jCollections Items リソース
Tableau CRM コレクション項目を返し、コレクション内の項目を作成、更新、または削除します。
- リソース URL
-
1/wave/collections/<collectionId>/items - 形式
- JSON
- 使用可能なバージョン
- 52.0
- HTTP のメソッド
- GET POST PATCH DELETE
- GET の要求パラメータ
-
パラメータ名 型 説明 必須か省略可能 使用可能なバージョン itemType CollectionItemAssetTypeEnum コレクション項目のアセット種別で結果を絞り込みます。有効な値は、次のとおりです。 - Dashboard
- Lens
省略可能 52.0 limit Integer 返されるコレクションの制限。 省略可能 52.0 mobileOnly Boolean モバイルアセット項目のみが返されるように結果を絞り込みます。 省略可能 52.0 offset Integer 返されたコレクション項目のリストの開始インデックスを示します。デフォルト値は、0 です。 省略可能 52.0 pageToken String 次のページで使用するトークン。 省略可能 52.0 - GET レスポンスボディ (WaveCollectionItemListRepresentation)
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン collectionItems WaveCollectionItemRepresentation[] コレクション内の項目のリスト。 Small、52.0 52.0 nextPageToken String コレクション内のレコードがさらに増えた場合の次のページのトークン。 Small、52.0 52.0 totalCount Integer コレクションの合計数。 Small、52.0 52.0 - POST リクエストボディ (WaveCollectionItemInputRepresentation)
-
パラメータ名 型 説明 必須か省略可能 使用可能なバージョン assetType CollectionItemAssetTypeEnum コレクション項目のアセット種別で結果を絞り込みます。有効な値は、次のとおりです。 - Dashboard
- Lens
必須 52.0 id ID コレクション項目の ID。 必須 52.0 itemId ID 項目の ID。 必須 52.0 - POST レスポンスボディ (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 - PATCH リクエストボディ (WaveCollectionItemListInputRepresentation)
-
パラメータ名 型 説明 必須か省略可能 使用可能なバージョン items WaveCollectionItemInputRepresentation[] コレクション内の項目のリスト。 必須 52.0 - PATCH レスポンスボディ (WaveCollectionItemListRepresentation)
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン collectionItems WaveCollectionItemRepresentation[] コレクション内の項目のリスト。 Small、52.0 52.0 nextPageToken String コレクション内のレコードがさらに増えた場合の次のページのトークン。 Small、52.0 52.0 totalCount Integer コレクションの合計数。 Small、52.0 52.0 - DELETE 要求
-
1/wave/collections/<collectionId>/items/<collectionItemId>