Tableau CRM REST API 開発者ガイド
jAuto-Install Requests List リソース
Tableau CRM Embedded App の自動インストール要求のコレクションを返したり、自動インストール要求を作成したり、自動インストール要求のグループを Tableau CRM フォルダ ID またはテンプレート API 参照名で削除したりします。
- リソース URL
-
- 形式
- JSON
- 使用可能なバージョン
- 50.0
- HTTP のメソッド
- GET POST DELETE
- GET の要求パラメータ
-
パラメータ名 型 説明 必須か省略可能 使用可能なバージョン folderId ID 特定のフォルダの内容のみが含まれるように結果を絞り込みます。要求ユーザの非公開フォルダにある項目のユーザ ID などになります。 省略可能 50.0 folderLabel String 表示ラベルにより特定のフォルダの内容のみが含まれるように結果を絞り込みます。 省略可能 50.0 pageSize Integer 1 ページで返される項目の数。最小値は 1、最大値は 200、デフォルトは 25 です。 省略可能 50.0 requestName String 特定の自動インストール要求名の内容のみが含まれるように結果を絞り込みます。 省略可能 50.0 requestStatuses AutoInstallRequestStatusEnum 特定の自動インストール要求状況の内容のみが含まれるように結果を絞り込みます。使用できる値は次のとおりです。 - AppInProgress
- Cancelled
- Enqueued
- Failed
- InProgress
- New
- Success
省略可能 50.0 requestTypes AutoInstallRequestTypeEnum 特定の自動インストール要求種別の内容のみが含まれるように結果を絞り込みます。使用できる値は次のとおりです。 - OrgCompatibilityCheck
- StartDataflow
- WaveAppCreate
- WaveAppDelete
- WaveAppUpdate
- WaveEnable
省略可能 50.0 searchOptions AutoInstallRequestSearchOptionEnum 特定の検索オプションの内容のみが含まれるように結果を絞り込みます。使用できる値は次のとおりです。 - ExcludeNonExistingApps
- MostRecentOnlyByTemplateAndFolder
- NonExistingAppsOnly
省略可能 50.0 sortOptions AutoInstallRequestSortOptionEnum 指定した並び替えオプションに従って結果を並び替えます。使用できる値は次のとおりです。 - CreatedDateAscending
- CreatedDateDescending
- FolderIdAscending
- FolderIdDescending
- FolderLabelAscending
- FolderLabelDescending
- LastModifiedDateAscending
- LastModifiedDateDescending
- RequestNameAscending
- RequestNameDescending
- RequestStatusAscending
- RequestStatusDescending
- RequestTypeAscending
- RequestTypeDescending
- TemplateApiNameAscending
- TemplateApiNameDescending
省略可能 50.0 templateApiName String 特定のアプリケーションテンプレートから作成された内容のみを含めるように結果を絞り込みます。 省略可能 50.0 次の REST URL は、GET 要求で要求パラメータを使用して絞り込みと並び替えを行う方法を示しています。
- Get レスポンスボディ (AutoInstallRequestCollectionRepresentation)
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン requests AutoInstallRequestRepresentation[] 自動インストール要求のコレクション。 Small、50.0 50.0 - POST リクエストボディ (AutoInstallRequestInsertInputRepresentation)
-
AutoInstallRequestInsertInputRepresentation は、抽象 BaseAutoInstallRequestInputRepresentation からプロパティを継承します。これらの基本プロパティは、AutoInstallRequestInsertInputRepresentation に、次のテーブルで明示的に定義されたプロパティとともに表示されます。
パラメータ名 型 説明 必須か省略可能 使用可能なバージョン configuration AutoInstallConfigurationInputRepresentation 自動インストール要求設定。 必須 50.0 folderId String Tableau CRM アプリケーションフォルダ ID。 必須 50.0 requestName String 自動インストール要求の名前。 必須 50.0 requestType AutoInstallRequestTypeEnum 自動インストール要求の種別。使用できる値は次のとおりです。 - OrgCompatibilityCheck
- StartDataflow
- WaveAppCreate
- WaveAppDelete
- WaveAppUpdate
- WaveEnable
必須 50.0 templateApiId String Tableau CRM テンプレート API 参照名または ID。 必須 50.0 - POST レスポンスボディ (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 - GET の要求パラメータ
-
パラメータ名 型 説明 必須か省略可能 使用可能なバージョン folderId ID このフォルダ ID のすべての自動インストール要求を削除します。要求ユーザの非公開フォルダにある項目のユーザ ID などになります。 省略可能 50.0 templateApiName String このテンプレート API 参照名または ID の��べての自動インストール要求を削除します。 省略可能 50.0 - AutoInstallConfigurationInputRepresentation
-
パラメータ名 型 説明 必須か省略可能 使用可能なバージョン appConfiguration AutoInstallAppConfigurationInputRepresentation Tableau CRM アプリケーションの作成または更新に使用する設定。 必須 50.0 parentRequestIds String[] この要求が連動する親自動インストール要求 ID のコレクション。 省略可能 50.0 - AutoInstallAppConfigurationInputRepresentation
-
パラメータ名 型 説明 必須か省略可能 使用可能なバージョン 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