Tableau CRM REST API 開発者ガイド
jAuto-Install Request リソース
Tableau CRM Embedded App の自動インストール要求を返したり、自動インストール要求を更新および削除したりします。
- リソース URL
-
1/wave/auto-install-requests/<autoInstallRequestId> - 形式
- JSON
- 使用可能なバージョン
- 50.0
- HTTP のメソッド
- GET PATCH DELETE
- Get レスポンスボディ (AutoInstallRequestRepresentation)
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン appFromRequest WaveFolderRepresentation[] この自動インストール要求が関連付けられている Tableau CRM アプリケーション。 Supplemental、50.0 50.0 configuration AutoInstallConfigurationRepresentation[] 自動インストール要求の設定属性。 Supplemental、50.0 50.0 createdBy WaveUserRepresentation 自動インストール要求を作成したユーザ。 Small、50.0 50.0 createdDate Date 自動インストール要求が作成された日時。 Small、50.0 50.0 failedReason AutoInstallRequestFailedReasonEnum 自動インストール要求が失敗した理由 (該当する場合)。有効な値は、次のとおりです。 - AppConstructionFailure
- AppCreateFailure
- AppUpdateFailure
- CancelFailed
- DeleteFailed
- DependencyCancelled
- DependencyFailure
- FailedOther
- FailedToEnqueue
- OrganizationIncompatible
- RequestCancelled
- RetriesExhausted
- WaveDisabled
Small、50.0 50.0 folderId String 自動インストール要求の Tableau CRM アプリケーションフォルダ ID。 Small、50.0 50.0 folderLabel String 自動インストール要求の Tableau CRM アプリケーションフォルダの表示ラベル。 Small、50.0 50.0 id String 自動インストール要求の ID。 Small、50.0 50.0 lastModifiedBy WaveUserRepresentation 自動インストール要求を最後に変更したユーザ。 Small、50.0 50.0 lastModifiedDate Date 自動インストール要求が最後に変更された日時。 Small、50.0 50.0 parentRequests AutoInstallRequestRepresentation[] この自動インストール要求が連動する自動インストール要求のコレクション。 Supplemental、50.0 50.0 requestLog String 自動インストール要求のログ。 Big、50.0 50.0 requestName String ユーザが指定した、自動インストール要求の名前。 Small、50.0 50.0 requestStatus AutoInstallRequestStatusEnum 自動インストール要求の状況。有効な値は、次のとおりです。 - AppInProgress
- Cancelled
- Enqueued
- Failed
- InProgress
- New
- Success
Small、50.0 50.0 requestTemplate TemplateRepresentation アプリケーションの作成または更新に使用する Tableau CRM テンプレート (該当する場合)。 Supplemental、50.0 50.0 requestType AutoInstallRequestTypeEnum 自動インストール要求の種別。有効な値は、次のとおりです。 - OrgCompatibilityCheck
- StartDataflow
- WaveAppCreate
- WaveAppDelete
- WaveAppUpdate
- WaveEnable
Small、50.0 50.0 templateApiName String 自動インストール要求の Tableau CRM テンプレート API 参照名または ID。 Small、50.0 50.0 templateVersion String 自動インストール要求の Tableau CRM テンプレートバージョン。 Small、50.0 50.0 url String 自動インストール要求を取得するための URL。 Small、50.0 50.0 - PATCH リクエストボディ (AutoInstallRequestUpdateInputRepresentation)
-
AutoInstallRequestUpdateInputRepresentation は、抽象 BaseAutoInstallRequestInputRepresentation からプロパティを継承します。これらの基本プロパティは、AutoInstallRequestUpdateInputRepresentation に、次のテーブルで明示的に定義されたプロパティとともに表示されます。
パラメータ名 型 説明 必須か省略可能 使用可能なバージョン requestLog String 自動インストール要求のログ。 必須 50.0 - PATCH レスポンスボディ (AutoInstallRequestRepresentation)
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン appFromRequest WaveFolderRepresentation[] この自動インストール要求が関連付けられている Tableau CRM アプリケーション。 Supplemental、50.0 50.0 configuration AutoInstallConfigurationRepresentation[] 自動インストール要求の設定属性。 Supplemental、50.0 50.0 createdBy WaveUserRepresentation 自動インストール要求を作成したユーザ。 Small、50.0 50.0 createdDate Date 自動インストール要求が作成された日時。 Small、50.0 50.0 failedReason AutoInstallRequestFailedReasonEnum 自動インストール要求が失敗した理由 (該当する場合)。有効な値は、次のとおりです。 - AppConstructionFailure
- AppCreateFailure
- AppUpdateFailure
- CancelFailed
- DeleteFailed
- DependencyCancelled
- DependencyFailure
- FailedOther
- FailedToEnqueue
- OrganizationIncompatible
- RequestCancelled
- RetriesExhausted
- WaveDisabled
Small、50.0 50.0 folderId String 自動インストール要求の Tableau CRM アプリケーションフォルダ ID。 Small、50.0 50.0 folderLabel String 自動インストール要求の Tableau CRM アプリケーションフォルダの表示ラベル。 Small、50.0 50.0 id String 自動インストール要求の ID。 Small、50.0 50.0 lastModifiedBy WaveUserRepresentation 自動インストール要求を最後に変更したユーザ。 Small、50.0 50.0 lastModifiedDate Date 自動インストール要求が最後に変更された日時。 Small、50.0 50.0 parentRequests AutoInstallRequestRepresentation[] この自動インストール要求が連動する自動インストール要求のコレクション。 Supplemental、50.0 50.0 requestLog String 自動インストール要求のログ。 Big、50.0 50.0 requestName String ユーザが指定した、自動インストール要求の名前。 Small、50.0 50.0 requestStatus AutoInstallRequestStatusEnum 自動インストール要求の状況。有効な値は、次のとおりです。 - AppInProgress
- Cancelled
- Enqueued
- Failed
- InProgress
- New
- Success
Small、50.0 50.0 requestTemplate TemplateRepresentation アプリケーションの作成または更新に使用する Tableau CRM テンプレート (該当する場合)。 Supplemental、50.0 50.0 requestType AutoInstallRequestTypeEnum 自動インストール要求の種別。有効な値は、次のとおりです。 - OrgCompatibilityCheck
- StartDataflow
- WaveAppCreate
- WaveAppDelete
- WaveAppUpdate
- WaveEnable
Small、50.0 50.0 templateApiName String 自動インストール要求の Tableau CRM テンプレート API 参照名または ID。 Small、50.0 50.0 templateVersion String 自動インストール要求の Tableau CRM テンプレートバージョン。 Small、50.0 50.0 url String 自動インストール要求を取得するための URL。 Small、50.0 50.0 - AutoInstallConfigurationRepresentation
-
パラメータ名 型 説明 検索条件グループとバージョン 使用可能なバージョン appConfiguration AutoInstallAppConfigurationRepresentation Tableau CRM アプリケーションの作成または更新に使用する設定。 Supplemental、v50.0 50.0 parentRequestIds String[] この要求が連動する親自動インストール要求 ID のコレクション。 Supplemental、v50.0 50.0 - AutoInstallAppConfigurationRepresentation
-
パラメータ名 型 説明 検索条件グループとバージョン 使用可能なバージョン autoShareWithLicensedUsers Boolean Tableau CRM アプリケーションが、「Tableau CRM の参照のみ組み込みアプリケーション」権限セットが割り当てられているユーザと自動的に共有されるか否かを示します。 必須 50.0 autoShareWithOriginator Boolean Tableau CRM アプリケーションが、自動インストール要求を開始したユーザと自動的に共有されるか否かを示します。 必須 50.0 deleteAppOnConstructionFailure Boolean WaveAppCreate 要求でエラーが発生したときに Tableau CRM アプリケーションが削除されるか否かを示します。 必須 50.0 failOnDuplicateNames Boolean 同じ API 参照名の別のアセットが存在するときに Tableau CRM アプリケーションの作成に失敗するか否かを示します。 必須 50.0 values Map<String, Object> Tableau CRM アプリケーションの作成または更新に使用するアプリケーションテンプレート変数値の対応付け。 必須 50.0 - PATCH リクエストボディ (BaseAutoInstallRequestInputRepresentation)
-
パラメータ名 型 説明 必須か省略可能 使用可能なバージョン requestStatus AutoInstallRequestStatusEnum 自動インストール要求の状況。有効な値は、次のとおりです。 - AppInProgress
- Cancelled
- Enqueued
- Failed
- InProgress
- New
- Success
省略可能 50.0