CRM Analytics REST API Developer Guide
jNote: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
Auto-Install Requests List Resource
Returns a collection of auto-install requests for Analytics embedded apps, creates an
auto-install request, or deletes groups of auto-install requests by an Analytics folder ID or a
template API name.
- Resource URL
-
1/wave/auto-install-requests - Formats
- JSON
- Available Version
- 50.0
- HTTP Methods
- GET POST DELETE
- Request parameters for GET
-
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
- Skipped
- 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
- WaveAppAutoUpdate
- 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.
1/wave/auto-install-requests?searchOptions=ExcludeNonExistingApps&sortOptions=RequestStatusAscending - Response body for GET
- Auto-Install Request Collection
- Request body for POST
- Auto-Install Request Insert Input
- Response body for POST
- Auto-Install Request