Tableau CRM REST API Developer Guide
jNewer Version Available
Auto-Install Requests List Resource
Returns a collection of auto-install requests for Tableau CRM embedded apps, creates an
auto-install request, or deletes groups of auto-install requests by a Tableau CRM folder ID or a
template API name.
- Resource URL
-
- Formats
- JSON
- Available Version
- 50.0
- HTTP Methods
- GET POST DELETE
- GET Request Parameters
-
Parameter Name Type Description Required or Optional Available Version folderId ID Filters the results to include only the contents of a specific folder. The id can be the requesting user’s ID for items in the user’s private folder. Optional 50.0 folderLabel String Filters the results to include only the contents of a specific folder by label. Optional 50.0 pageSize Integer The number of items to be returned in a single page. Minimum is 1, maximum is 200, and default is 25. Optional 50.0 requestName String Filters the results to include only the contents with a specific auto-install request name. Optional 50.0 requestStatuses AutoInstallRequestStatusEnum Filters the results to include only the contents with a specific auto-install request status. Valid values include: - AppInProgress
- Cancelled
- Enqueued
- Failed
- InProgress
- New
- Success
Optional 50.0 requestTypes AutoInstallRequestTypeEnum Filters the results to include only the contents with a specific auto-install request type. Valid values include: - OrgCompatibilityCheck
- StartDataflow
- WaveAppCreate
- WaveAppDelete
- WaveAppUpdate
- WaveEnable
Optional 50.0 searchOptions AutoInstallRequestSearchOptionEnum Filters the results to include only the contents with specific search options. Valid values include: - ExcludeNonExistingApps
- MostRecentOnlyByTemplateAndFolder
- NonExistingAppsOnly
Optional 50.0 sortOptions AutoInstallRequestSortOptionEnum Sorts the results according to the given sort option. Valid values include: - CreatedDateAscending
- CreatedDateDescending
- FolderIdAscending
- FolderIdDescending
- FolderLabelAscending
- FolderLabelDescending
- LastModifiedDateAscending
- LastModifiedDateDescending
- RequestNameAscending
- RequestNameDescending
- RequestStatusAscending
- RequestStatusDescending
- RequestTypeAscending
- RequestTypeDescending
- TemplateApiNameAscending
- TemplateApiNameDescending
Optional 50.0 templateApiName String Filters the results to include only the contents created from a specific application template. Optional 50.0 The following REST URL shows how to use the request parameters to filter and sort in the GET request.
- GET Response Body (AutoInstallRequestCollectionRepresentation)
-
Property Name Type Description Filter Group and Version Available Version requests AutoInstallRequestRepresentation[] A collection of auto-install requests Small, 50.0 50.0 - POST Request Body (AutoInstallRequestInsertInputRepresentation)
-
AutoInstallRequestInsertInputRepresentation inherits properties from the abstract BaseAutoInstallRequestInputRepresentation. These base properties appear in AutoInstallRequestInsertInputRepresentation alongside the properties defined explicitly in the following table.
Parameter Name Type Description Required or Optional Available Version configuration AutoInstallConfigurationInputRepresentation The auto-install request configuration. Required 50.0 folderId String The Tableau CRM application folder ID. Required 50.0 requestName String The name of the auto-install request. Required 50.0 requestType AutoInstallRequestTypeEnum The type of the auto-install request. Valid values include: - OrgCompatibilityCheck
- StartDataflow
- WaveAppCreate
- WaveAppDelete
- WaveAppUpdate
- WaveEnable
Required 50.0 templateApiId String The Tableau CRM template API name or ID. Required 50.0 - POST Response Body (AutoInstallRequestRepresentation)
-
Property Name Type Description Filter Group and Version Available Version appFromRequest WaveFolderRepresentation[] The Tableau CRM application that this auto-install request is associated with. Supplemental, 50.0 50.0 configuration AutoInstallConfigurationRepresentation[] The configuration attributes for the auto-install request. Supplemental, 50.0 50.0 createdBy WaveUserRepresentation The user that created the auto-install request. Small, 50.0 50.0 createdDate Date The date and time the auto-install request was created. Small, 50.0 50.0 failedReason AutoInstallRequestFailedReasonEnum The reason that the auto-install request failed, where applicable. Valid values are: - AppConstructionFailure
- AppCreateFailure
- AppUpdateFailure
- CancelFailed
- DeleteFailed
- DependencyCancelled
- DependencyFailure
- FailedOther
- FailedToEnqueue
- OrganizationIncompatible
- RequestCancelled
- RetriesExhausted
- WaveDisabled
Small, 50.0 50.0 folderId String The Tableau CRM application folder ID for the auto-install request. Small, 50.0 50.0 folderLabel String The Tableau CRM application folder label for the auto-install request. Small, 50.0 50.0 id String The ID for the auto-install request. Small, 50.0 50.0 lastModifiedBy WaveUserRepresentation The user that last modified the auto-install request. Small, 50.0 50.0 lastModifiedDate Date The date and time the auto-install request was last modified. Small, 50.0 50.0 parentRequests AutoInstallRequestRepresentation[] The collection of auto-install requests that the auto-install request depends on. Supplemental, 50.0 50.0 requestLog String The log for the auto-install request. Big, 50.0 50.0 requestName String The user specified name for the auto-install request. Small, 50.0 50.0 requestStatus AutoInstallRequestStatusEnum The status of the auto-install request. Valid values are: - AppInProgress
- Cancelled
- Enqueued
- Failed
- InProgress
- New
- Success
Small, 50.0 50.0 requestTemplate TemplateRepresentation The Tableau CRM template used to create and update the app, where applicable. Supplemental, 50.0 50.0 requestType AutoInstallRequestTypeEnum The type of the auto-install request. Valid values are: - OrgCompatibilityCheck
- StartDataflow
- WaveAppCreate
- WaveAppDelete
- WaveAppUpdate
- WaveEnable
Small, 50.0 50.0 templateApiName String The Tableau CRM template API name or ID for the auto-install request. Small, 50.0 50.0 templateVersion String The Tableau CRM template version for the auto-install request. Small, 50.0 50.0 url String The URL to get the auto-install request. Small, 50.0 50.0 - GET Request Parameters
-
Parameter Name Type Description Required or Optional Available Version folderId ID Deletes all auto-install requests for the folder ID. The ID can be the requesting user’s ID for items in the user’s private folder. Optional 50.0 templateApiName String Deletes all auto-install requests for the template API name or ID. Optional 50.0 - AutoInstallConfigurationInputRepresentation
-
Parameter Name Type Description Required or Optional Available Version appConfiguration AutoInstallAppConfigurationInputRepresentation The configuration used to create or update the Tableau CRM application. Required 50.0 parentRequestIds String[] The collection of the parent auto-install request ids this request depends on. Optional 50.0 - AutoInstallAppConfigurationInputRepresentation
-
Parameter Name Type Description Required or Optional Available Version autoShareWithLicensedUsers Boolean Indicates whether the Tableau CRM application is automatically shared with users that are assigned the Tableau CRM View Only Embedded App permission set or not. Required 50.0 autoShareWithOriginator Boolean Indicates whether the Tableau CRM application is automatically shared with the user that initiated the auto-install request or not. Required 50.0 deleteAppOnConstructionFailure Boolean Indicates whether the Tableau CRM application is deleted when a failure occurs on the WaveAppCreate request or not. Required 50.0 failOnDuplicateNames Boolean Indicates whether the Tableau CRM application creation fails when another asset exists with the same developer name or not. Required 50.0 values Map<String, Object> A map of application template variable values used to create or update the Tableau CRM application. Required 50.0