Tableau CRM REST API 開発者ガイド
jFolder リソース
- リソース URL
-
1/wave/folders/<folderID> - 形式
- JSON
- 使用可能なバージョン
- 36.0
- HTTP のメソッド
- GET DELETE PATCH PUT
- GET の要求パラメータ
-
パラメータ名 型 説明 必須か省略可能 使用可能なバージョン mobileOnlyFeaturedAssets Boolean Tableau CRM モバイルアプリケーションで有効になっているダッシュボードのみを表示するように、フォルダのコレクションを絞り込みます。 省略可能 43.0 フォルダのアプリケーションログを取得するには、GET 要求に Supplemental 値を設定した filterGroup 要求パラメータを使用します。
1/wave/folders/<folderID>?filterGroup=Supplemental - GET レスポンスボディ (WaveFolderRepresentation)
-
WaveFolderRepresentation は、抽象 BaseWaveAssetRepresentation からプロパティを継承します。これらの基本プロパティは、WaveFolderRepresentation に、次のテーブルで明示的に定義されたプロパティとともに表示されます。
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン appLog AppLogRepresentation アプリケーションの作成またはアップグレードに基づくアプリケーションログ。 Supplemental、49.0 49.0 applicationStatus ConnectWaveApplicationStatusEnum アプリケーションの作成状況。有効な値は、次のとおりです。 - CancelledStatus
- CompletedStatus
- DataflowInProgressStatus
- ExtensionAssetTypeInProgressStatus
- FailedStatus
- InProgressStatus
- NewStatus
Medium、36.0 36.0 attachedFiles AssetReferenceRepresentation[] インサイトフォルダに添付されるファイルの ID Big、39.0 39.0 canBeSharedExternally Boolean このアプリケーションをコミュニティ��ーザと共有できるか否かを示します。 Big、37.0 37.0 defaultAsset AssetReferenceRepresentation アプリケーションをアプリケーションランタイムモードで表示するときに示されるデフォルトのダッシュボードまたはレンズ。 Big、37.0 37.0 featuredAssets Map<String, FeaturedAssetsRepresentation> このアプリケーションの UI で使用される主要アセットの対応付け。 Big、39.0 39.0 icon AssetReferenceRepresentation アセットアイコン。 Small、36.0 36.0 isPinned Boolean このアプリケーションが固定表示か否かを示します。 Small、39.0 39.0 shares WaveFolderShareRepresentation[] フォルダ共有リスト。 Big、36.0 36.0 templateOptions TemplateOptionsRepresentation テンプレート Tableau CRM アプリケーションで最後に実行されたアクションで使用されたオプション。 Big、37.0 37.0 templateSourceId String フォルダまたはアプリケーションの作成に使用されるソーステンプレート ID または API 名。 Medium、36.0 36.0 templateValues Map<String, Object> フォルダやアプリケーションの作成または更新に使用するテンプレート値の対応付け。 Large、37.0 37.0 templateVersion String このアプリケーションの作成元であるテンプレートのバージョン。 Medium、37.0 37.0 - PUT および PATCH リクエストボディ (BaseWaveFolderInputRepresentation)
-
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン assetIcon String 新規フォルダまたはアプリケーションを最適に表すアイコンの列挙。有効な値は 1.png から 20.png です。 省略可能 36.0 description String フォルダまたはアプリケーションの説明。 省略可能 36.0 label String フォルダまたはアプリケーションのユーザに表示する名前。 省略可能 36.0 name String 新規フォルダまたはアプリケーションの内部 API 参照名。 省略可能 36.0 - PUT および PATCH レスポンスボディ (WaveFolderRepresentation)
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン appLog AppLogRepresentation アプリケーションの作成またはアップグレードに基づくアプリケーションログ。 Supplemental、49.0 49.0 applicationStatus ConnectWaveApplicationStatusEnum アプリケーションの作成状況。有効な値は、次のとおりです。 - CancelledStatus
- CompletedStatus
- DataflowInProgressStatus
- ExtensionAssetTypeInProgressStatus
- FailedStatus
- InProgressStatus
- NewStatus
Medium、36.0 36.0 attachedFiles AssetReferenceRepresentation[] インサイトフォルダに添付されるファイルの ID Big、39.0 39.0 canBeSharedExternally Boolean このアプリケーションをコミュニティユーザと共有できるか否かを示します。 Big、37.0 37.0 defaultAsset AssetReferenceRepresentation アプリケーションをアプリケーションランタイムモードで表示するときに示されるデフォルトのダッシュボードまたはレンズ。 Big、37.0 37.0 featuredAssets Map<String, FeaturedAssetsRepresentation> このアプリケーションの UI で使用される主要アセットの対応付け。 Big、39.0 39.0 icon AssetReferenceRepresentation アセットアイコン。 Small、36.0 36.0 isPinned Boolean このアプリケーションが固定表示か否かを示します。 Small、39.0 39.0 shares WaveFolderShareRepresentation[] フォルダ共有リスト。 Big、36.0 36.0 templateOptions TemplateOptionsRepresentation テンプレート Tableau CRM アプリケーションで最後に実行されたアクションで使用されたオプション。 Big、37.0 37.0 templateSourceId String フォルダまたはアプリケーションの作成に使用されるソーステンプレート ID または API 名。 Medium、36.0 36.0 templateValues Map<String, Object> フォルダやアプリケーションの作成または更新に使用するテンプレート値の対応付け。 Large、37.0 37.0 templateVersion String このアプリケーションの作成元であるテンプレートのバージョン。 Medium、37.0 37.0 -
- FeaturedAssetsRepresentation
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン assets TypedAssetReferenceRepresentation[] 主要アセットのリスト。 Small、39.0 39.0 - TypedAssetReferenceRepresentation
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン type ConnectWaveAssetTypeEnum アセットタイプ。有効な値は次のとおりです。 - Component
- Dashboard
- DashboardSnapshot
- DataConnector
- Dataflow
- DataflowJob
- Dataset
- DatasetShard
- DatasetVersion
- ExternalData
- Folder
- Lens
- Recipe
- ReplicatedDataset
- Story
- Workflow
Small、40.0 40.0 -
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン accessType ConnectWaveAccessTypeEnum アクセス種別。有効な値は、次のとおりです。 - Edit
- Manage
- View
Small、36.0 36.0 imageUrl String ユーザ画像の URL。 Small、36.0 36.0 shareType ConnectWaveShareTypeEnum 共有種別。有効な値は、次のとおりです。 - AllCspUsers
- AllPrmUsers
- CustomerPortalUser
- Group
- Organization
- PartnerUser
- PortalRole
- PortalRoleAndSubordinates
- Role
- RoleAndSubordinates
- User
Small、36.0 36.0 sharedWithId String 共有表現のあるユーザの ID。 Small、36.0 36.0 sharedWithLabel String 共有ユーザ、グループ、組織の表示ラベル。 Small、36.0 36.0 - TemplateOptionsRepresentation
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン appAction ConnectWaveTemplateAppActionEnum テンプレートアプリケーションで実行された、最後のテンプレートアクション。有効な値は、次のとおりです。 - Create
- Decouple
- Overlay
- Upgrade
Medium、37.0 37.0 appActionDate Date 最後のアクションが実行された日時。 Medium、37.0 37.0 appActionUser WaveUserRepresentation 最後のアクションを実行したユーザ。 Medium、37.0 37.0
- AppLogRepresentation
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン message String ログメッセージエントリ。 Supplemental、49.0 49.0 - FeaturedAssetsInputRepresentation
-
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン assets TypedAssetReferenceInputRepresentation[] デフォルトの主要アセットのリスト。 必須 39.0 - TypedAssetReferenceInputRepresentation
-
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン type ConnectWaveAssetTypeEnum アセットタイプ。有効な値は次のとおりです。 - Component
- Dashboard
- DashboardSnapshot
- DataConnector
- Dataflow
- DataflowJob
- Dataset
- DatasetShard
- DatasetVersion
- ExternalData
- Folder
- Lens
- Recipe
- ReplicatedDataset
- Story
- Workflow
必須 40.0 -
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン accessType ConnectWaveAccessTypeEnum アクセス種別。有効な値は、次のとおりです。 - Edit
- Manage
- View
必須 36.0 shareType ConnectWaveShareTypeEnum 共有種別。有効な値は、次のとおりです。 - AllCspUsers
- AllPrmUsers
- CustomerPortalUser
- Group
- Organization
- PartnerUser
- PortalRole
- PortalRoleAndSubordinates
- Role
- RoleAndSubordinates
- User
必須 36.0 sharedWithId ID フォルダを共有するエンティティの ID。 必須 36.0