この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

Tableau CRM REST API の付録

この付録では、Tableau CRM REST API のすべてのリソースで使用される共有表現と共有列挙について説明します。以下の表現の詳細は、それ自体が REST API エンドポイントになるわけではありませんが、REST API リクエストボディとレスポンスボディで使用されるオブジェクト表現を説明します。

共有表現

AbstractFieldRepresentation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`defaultValue`	Object	デフォルト値 (省略可能)。	Small、37.0	37.0
`description`	String	項目の説明 (省略可能)。	Small、37.0	37.0
`fieldType`	ConnectWaveFieldTypeEnum	項目のデータ型。有効な値は、次のとおりです。 `Date` `DateOnly` `DateTime` `Numeric` `Text`	Small、37.0	37.0
`format`	String	日付データ型の場合は、この形式を使用して入力値を解析します。その他のデータ型の場合は、この形式を使用して表示します。	Small、37.0	37.0
`label`	String	項目の表示ラベル。	Small、37.0	37.0
`multiValue`	Boolean	項目が複数値項目か否かを示します。デフォルトは false です。	Small、37.0	37.0
`multiValueSeparator`	String	`multiValue` が true の項目でのみ必須です。複数値の区切り文字です。	Small、37.0	37.0
`name`	String	項目の API 参照名。	Small、37.0	37.0
`precision`	Integer	数値の桁数またはテキストの長さ (データ型によって異なる)。	Small、37.0	37.0
`scale`	Integer	数値スケール (数値データ型のみ)。	Small、37.0	37.0
`systemField`	Boolean	項目がシステム項目か否かを示します。デフォルトは false です。システム項目はクエリできません。	Small、37.0	37.0
`uniqueId`	Boolean	項目がデータセットの一意の ID か否かを示します。デフォルトは false です。データセットに使用できる一意の ID は 1 つのみです。	Small、37.0	37.0

AdvancedPropertyValueRepresentation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`name`	String	詳細プロパティの名前。	Small、44.0	44.0
`value`	String	詳細プロパティの値。	Small、44.0	44.0

AssetReferenceRepresentation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`id`	String	アセットの 18 文字の ID。	Small、36.0	36.0
`label`	String	アセットの表示ラベル。	Small、36.0	36.0
`name`	String	アセットの API 参照名。	Small、36.0	36.0
`namespace`	String	アセット名を修飾する名前空間。デフォルトは、現在の組織の名前空間です。名前空��が設定されている Developer Edition 組織以外のすべての組織は「空の名前空間」になります。	Small、37.0	37.0
`url`	String	アセットの URL。	Small、36.0	36.0

AssetReferenceInputRepresentation

プロパティ名	型	説明	必須か省略可能	使用可能なバージョン
`id`	String	アセットの 18 文字の ID。	省略可能 (ID または名前を指定してください)。	36.0
`name`	String	アセットの API 参照名。	省略可能 (ID または名前を指定してください)。	36.0
`namespace`	String	アセット名を修飾する名前空間。デフォルトは、現在の組織の名前空間です。名前空間が設定されている Developer Edition 組織以外のすべての組織は「空の名前空間」になります。	名前空間が定義されている組織でのみ必須です。	37.0

AssetRevertHistoryInputRepresentation

プロパティ名	型	説明	必須か省略可能	使用可能なバージョン
`historyId`	String	このアセットを元に戻すために必要な取得元履歴 ID。	必須	42.0
`historyLabel`	String	元に戻す変更にタグを付ける履歴の表示ラベル。	省略可能	42.0

BaseAssetInputRepresentation

プロパティ名	型	説明	必須か省略可能	使用可能なバージョン
`description`	String	アセットの簡単な説明。	POST では必須、PATCH では省略可能	36.0
`name`	String	アセットの API 参照名。	POST では必須、PATCH では編集不可	36.0
`label`	String	アセットの表示ラベル。	POST と PATCH で省略可能	37.0

BaseTemplatedAssetRepresentation

BaseTemplatedAssetRepresentation は、抽象 BaseWaveAssetRepresentation からプロパティを継承します。これらの基本プロパティは、BaseTemplatedAssetRepresentation に、次のテーブルで明示的に定義されたプロパティとともに表示されます。

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`templatedAssetSourceName`	String	このアセットを作成するために使用したテンプレートの開発者名 (テンプレートを使用した場合)。	Small、52.0	52.0
`templateSourceId`	String	このアセットを作成するために使用したテンプレートの ID (テンプレートを使用した場合)。	Small、52.0	52.0

BaseWaveAssetRepresentation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`assetSharingUrl`	String	このアセットをユーザインターフェースで開くための URL。ディープリンクの形式です。サーバは、urlType、assetId、orgId、loginHost が指定されている可能性のあるリンクパラメータと、その他の省略可能なパラメータを検証し、必要に応じて変換して対象のク��イアントに正しい結果を生成します。たとえば、アセットをデスクトップクライアントに開きますが、モバイル OS を使用している場合はモバイルに開きます。	Small、36.0	36.0
`createdBy`	WaveUserRepresentation	アセットを作成したユーザ。	Small、36.0	36.0
`createdDate`	Date	アセットが作成された時刻 (ISO8601 日付形式)。	Small、36.0	36.0
`description`	String	アセットの簡単な説明。	Small、36.0	36.0
`id`	String	アセットの 18 文字の ID。	Small、36.0	36.0
`label`	String	アセットの表示ラベル。	Small、36.0	36.0
`lastAccessedDate`	Date	アセットが最後にアクセスされた時刻 (ISO8601 日付形式)。	Small、36.0	36.0
`lastModifiedBy`	WaveUserRepresentation	アセットを最後に更新したユーザ。	Small、36.0	36.0
`lastModifiedDate`	Date	アセットが最後に変更された時刻 (ISO8601 日付形式)。	Small、36.0	36.0
`name`	String	アセットの API 参照名。	Small、36.0	36.0
`namespace`	String	アセット名を修飾する名前空間。デフォルトは、現在の組織の名前空間です。名前空間が設定されている Developer Edition 組織以外のすべての組織は「空の名前空間」になります。	Small、36.0	36.0
`permissions`	PermissionsRepresentation	現在のユーザの権限。	Small、36.0	36.0
`type`	ConnectWaveAssetTypeEnum	アセットタイプ。有効な値は次のとおりです。 `Collection` `Component` `Dashboard` `DashboardSnapshot` `DataConnector` `DataPoolEntity` `DataPoolEntityVersion` `Dataflow` `DataflowJob` `DataflowJobNode` `Dataset` `DatasetShard` `DatasetVersion` `ExternalData` `Folder` `Lens` `LightningComponent` `Recipe` `RecipeModel` `ReplicatedDataset` `Story` `Widget` `Workflow`	Small、36.0	36.0
`url`	String	アセットの URL。	Small、36.0	36.0

TypedAssetReferenceRepresentation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`type`	ConnectWaveAssetTypeEnum	アセットの種別。	Small、51.0	51.0

TypedAssetReferenceInputRepresentation

プロパティ名	型	説明	必須か��略可能	使用可能なバージョン
`type`	ConnectWaveAssetTypeEnum	アセットの種別。	必須	51.0

WaveUserRepresentation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`id`	String	18 文字のユーザ ID。	Small、36.0	36.0
`name`	String	ユーザの名前。	Small、36.0	36.0
`profilePhotoUrl`	String	ユーザの Chatter プロファイル写真。	Small、36.0	36.0

PermissionsRepresentation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`create`	Boolean	ユーザがアセットを作成できるか否かを示します。	Small、45.0	45.0
`manage`	Boolean	ユーザがアセットのアクセスを管理できるか否かを示します。	Small、36.0	36.0
`modify`	Boolean	ユーザがアセットを変更できるか否かを示します。	Small、36.0	36.0
`view`	Boolean	ユーザがアセットを表示できるか否かを示します。	Small、36.0	36.0

スケジュール表現

ScheduleRepresentation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`assetId`	String	このスケジュールが属しているアセット ID。	Small、52.0	52.0
`frequency`	ConnectWaveScheduleFrequencyTypeEnum	このスケジュールが実行される頻度。有効な値は、次のとおりです。 `Daily` (毎日 1 回実行) `EventDriven` (イベント駆動型スケジュールを作成) `Hourly` (毎日 1 回以上特定の時間に実行) `Minutely` (毎日分単位で指定した時間に実行) `Monthly` (毎月 1 回以上特定の日付に実行) `MonthlyRelative` (毎月 1 回以上相対的な日付に実行) `None` (Not scheduled to run) `Weekly` (毎週 1 回以上特定の曜日に実行)	Small、39.0	39.0
`nextScheduledDate`	Date	このスケジュールの次の予定時間 (UTC)	Small、43.0	43.0
`notificationLevel`	ConnectEmailNotificationLevelEnum	このスケジュールに関連付けられているデータフローのメール通知レベル。有効な値は、次のとおりです。 `Always` `Failures` `Never` `Warnings`	Small、43.0	43.0
`time`	TimeRepresentation	このスケジュールを実行する時間、分、タイムゾーン。	Small、39.0	39.0

DailyScheduleRepresentation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`frequency`	ConnectWaveScheduleFrequencyTypeEnum	このスケジュールが実行される頻度。有効な値は、次のとおりです。 `Daily` (毎日 1 回実行) `EventDriven` (イベント駆動型スケジュールを作成) `Hourly` (毎日 1 回以上特定の時間に実行) `Minutely` (毎日分単位で指定した時間に実行) `Monthly` (毎月 1 回以上特定の日付に実行) `MonthlyRelative` (毎月 1 回以上相対的な日付に実行) `None` (Not scheduled to run) `Weekly` (毎週 1 回以上特定の曜日に実行)	Small、39.0	39.0
`time`	TimeRepresentation	このスケジュールを実行する時間、分、タイムゾーン。	Small、39.0	39.0

HourlyScheduleRepresentation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`daysOfWeek`	ConnectWaveDayOfWeekEnum[]	スケジュールを実行する曜日。有効な値は、次のとおりです。 `Monday` `Tuesday` `Wednesday` `Thursday` `Friday` `Saturday` `Sunday`	Small、40.0	40.0
`hourlyInterval`	Integer	タスクをキューに追加する間隔 (時間単位)。	Small、40.0	40.0
`lastHour`	Integer	このタスクのキューへの追加を停止する最終時間。	Small、40.0	40.0

MonthlyRelativeScheduleRepresentation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`frequency`	ConnectWaveScheduleFrequencyTypeEnum	このスケジュールが実行される頻度。有効な値は、次のとおりです。 `Daily` (毎日 1 回実行) `EventDriven` (イベント駆動型スケジュールを作成) `Hourly` (毎日 1 回以上特定の時間に実行) `Minutely` (毎日分単位で指定した時間に実行) `Monthly` (毎月 1 回以上特定の日付に実行) `MonthlyRelative` (毎月 1 回以上相対的な日付に実行) `None` (Not scheduled to run) `Weekly` (毎週 1 回以上特定の曜日に実行)	Small、39.0	39.0
`time`	TimeRepresentation	このスケジュールを実行する時間、分、タイムゾーン。	Small、39.0	39.0
`dayInWeek`	ConnectWaveDayOfWeekEnum	スケジュールを実行する曜日。有効な値は、次のとおりです。 `Monday` `Tuesday` `Wednesday` `Thursday` `Friday` `Saturday` `Sunday`	Small、39.0	39.0
`weekInMonth`	ConnectWaveRelativeWeekEnum	月の週。有効な値は次のとおりです。 `First` `Second` `Third` `Fourth` `Last`	Small、39.0	39.0

MonthlySpecificScheduleRepresentation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`frequency`	ConnectWaveScheduleFrequencyTypeEnum	このスケジュールが実行される頻度。有効な値は、次のとおりです。 `Daily` (毎日 1 回実行) `EventDriven` (イベント駆動型スケジュールを作成) `Hourly` (毎日 1 回以上特定の時間に実行) `Minutely` (毎日分単位で指定した時間に実行) `Monthly` (毎月 1 回以上特定の日付に実行) `MonthlyRelative` (毎月 1 回以上相対的な日付に実行) `None` (Not scheduled to run) `Weekly` (毎週 1 回以上特定の曜日に実行)	Small、39.0	39.0
`time`	TimeRepresentation	このスケジュールを実行する時間とタイムゾーン。	Small、39.0	39.0
`daysOfMonth`	Integer[]	毎月スケジュールを実行する日付 (-1、1 ～ 31)。月にその日付がない場合は、ジョブがスキップされます。月の末日には -1 という単一の値を指定できます (-1 をその他の日付と併用することはできません)。	Small、39.0	39.0

WeeklyScheduleRepresentation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`frequency`	ConnectWaveScheduleFrequencyTypeEnum	このスケジュールが実行される頻度。有効な値は、次のとおりです。 `Daily` (毎日 1 回実行) `EventDriven` (イベント駆動型スケジュールを作成) `Hourly` (毎日 1 回以上特定の時間に実行) `Minutely` (毎日分単位で指定した時間に実行) `Monthly` (毎月 1 回以上特定の日付に実行) `MonthlyRelative` (毎月 1 回以上相対的な日付に実行) `None` (Not scheduled to run) `Weekly` (毎週 1 回以上特定の曜日に実行)	Small、39.0	39.0
`time`	TimeRepresentation	このスケジュールを実行する時間とタイムゾーン。	Small、39.0	39.0
`daysOfWeek`	ConnectWaveDayOfWeekEnum[]	スケジュールを実行する曜日。有効な値は、次のとおりです。 `Monday` `Tuesday` `Wednesday` `Thursday` `Friday` `Saturday` `Sunday`	Small、39.0	39.0

TimeRepresentation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`hour`	Integer	このスケジュールを実行する時間 (0 ～ 23)。	Small、39.0	39.0
`minute`	Integer	このスケジュールを実行する分 (0 ～ 59)。	Small、39.0	39.0
`timeZone`	TimeZoneRepresentation	スケジュールを実行する時間のタイムゾーン。	Small、39.0	39.0

TimeZoneRepresentation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`gmtOffset`	Double	GMT との符号付き時差。	Small、39.0	39.0
`name`	String	このタイムゾーンの表示名。	Small、39.0	39.0
`zoneId`	String	このタイムゾーンの ID。	Small、39.0	39.0

ScheduleInputRepresentation

プロパティ名	型	説明	必須か省略可能	使用可能なバージョン
`frequency`	ConnectWaveScheduleFrequencyTypeEnum	このスケジュールが実行される頻度。有効な値は、次のとおりです。 `Daily` (毎日 1 回実行) `EventDriven` (イベント駆動型スケジュールを作成) `Hourly` (毎日 1 回以上特定の時間に実行) `Minutely` (毎日分単位で指定した時間に実行) `Monthly` (毎月 1 回以上特定の日付に実行) `MonthlyRelative` (毎月 1 回以上相対的な日付に実行) `None` (Not scheduled to run) `Weekly` (毎週 1 回以上特定の曜日に実行)	必須	39.0
`notificationLevel`	ConnectEmailNotificationLevelEnum	スケジュール済みジョブのメール通知レベル。有効な値は、次のとおりです。 `Always` `Warnings` `Failures` `Never`	省略可能	42.0
`time`	TimeInputRepresentation	スケジュールを実行する時間。	必須	39.0

DailyScheduleInputRepresentation