Analytics REST API Developer Guide
jNewer Version Available
Auto-Install Request Resource
Returns an auto-install request for an Analytics embedded app, updates and deletes an
auto-install request.
- Resource URL
-
1/wave/auto-install-requests/<autoInstallRequestId> - Formats
- JSON
- Available Version
- 50.0
- HTTP Methods
- GET PATCH DELETE
- GET Response Body (AutoInstallRequestRepresentation)
-
Property Name Type Description Filter Group and Version Available Version appFromRequest WaveFolderRepresentation[] The Analytics 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 Analytics application folder ID for the auto-install request. Small, 50.0 50.0 folderLabel String The Analytics 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 Analytics 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 Analytics template API name or ID for the auto-install request. Small, 50.0 50.0 templateVersion String The Analytics 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 - PATCH Request Body (AutoInstallRequestUpdateInputRepresentation)
-
AutoInstallRequestUpdateInputRepresentation inherits properties from the abstract BaseAutoInstallRequestInputRepresentation. These base properties appear in AutoInstallRequestUpdateInputRepresentation alongside the properties defined explicitly in the following table.
Parameter Name Type Description Required or Optional Available Version requestLog String The log of the auto-install request. Required 50.0 - PATCH Response Body (AutoInstallRequestRepresentation)
-
Property Name Type Description Filter Group and Version Available Version appFromRequest WaveFolderRepresentation[] The Analytics 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 Analytics application folder ID for the auto-install request. Small, 50.0 50.0 folderLabel String The Analytics 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 Analytics 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 Analytics template API name or ID for the auto-install request. Small, 50.0 50.0 templateVersion String The Analytics 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 - AutoInstallConfigurationRepresentation
-
Parameter Name Type Description Filter Group and Version Available Version appConfiguration AutoInstallAppConfigurationRepresentation The configuration used to create or update the Analytics application. Supplemental, v50.0 50.0 parentRequestIds String[] The collection of the parent auto-install request ids this request depends on. Supplemental, v50.0 50.0 - AutoInstallAppConfigurationRepresentation
-
Parameter Name Type Description Filter Group and Version Available Version autoShareWithLicensedUsers Boolean Indicates whether the Analytics application is automatically shared with users that are assigned the Analytics View Only Embedded App permission set or not. Required 50.0 autoShareWithOriginator Boolean Indicates whether the Analytics application is automatically shared with the user that initiated the auto-install request or not. Required 50.0 deleteAppOnConstructionFailure Boolean Indicates whether the Analytics application is deleted when a failure occurs on the WaveAppCreate request or not. Required 50.0 failOnDuplicateNames Boolean Indicates whether the Analytics 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 Analytics application. Required 50.0 - PATCH Request Body (BaseAutoInstallRequestInputRepresentation)
-
Parameter Name Type Description Required or Optional Available Version requestStatus AutoInstallRequestStatusEnum The status of the auto-install request. Valid values are: - AppInProgress
- Cancelled
- Enqueued
- Failed
- InProgress
- New
- Success
Optional 50.0