Applications - Install Application Package
Start the install of application package in target environment.
Trigger the installation of an application package, based on the package unique name, to be installed into a target environment. The client can also include a custom payload when requesting installation of an application package.
POST https://api.powerplatform.com/appmanagement/environments/{environmentId}/applicationPackages/{uniqueName}/install?api-version=2022-03-01-previewURI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
environment
|
path | True |
string |
Environment ID (not to be confused with the organization ID). |
|
unique
|
path | True |
string |
Package unique name. |
|
api-version
|
query | True |
string |
The API version. |
Request Body
| Name | Type | Description |
|---|---|---|
| payloadValue |
string |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
Success |
|
| 202 Accepted |
Success |
|
| 400 Bad Request |
Bad Request |
|
| 401 Unauthorized |
Unauthorized |
|
| 403 Forbidden |
Forbidden |
Security
oauth2
Microsoft Entra ID OAuth2
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize?resource=https://api.powerplatform.com
Scopes
| Name | Description |
|---|---|
| .default | .default |
Definitions
| Name | Description |
|---|---|
|
Application |
Application visibility |
|
Error |
|
|
Instance |
|
|
Instance |
|
|
Instance |
State of the instance package |
|
Tps |
Payload to be sent during installation of the package |
ApplicationVisibility
Application visibility
| Value | Description |
|---|---|
| None | |
| CrmAdminCenter | |
| BapAdminCenter | |
| OneAdminCenter | |
| All |
ErrorDetails
| Name | Type | Description |
|---|---|---|
| errorCode |
integer (int32) |
Error code from Dataverse |
| errorName |
string |
Error name |
| message |
string |
Error message |
| source |
string |
Source of the error |
| statusCode |
integer (int32) |
Status code for error |
| type |
string |
Error type |
InstancePackage
| Name | Type | Description |
|---|---|---|
| applicationDescription |
string |
Application description associated with the instance package |
| applicationId |
string (uuid) |
Application ID associated with the instance package |
| applicationName |
string |
Application name associated with the instance package |
| applicationVisibility |
Application visibility |
|
| customHandleUpgrade |
boolean |
Custom handle upgrade flag for the application |
| id |
string (uuid) |
Instance package ID |
| lastOperation | ||
| learnMoreUrl |
string |
Learn more url for the application |
| localizedDescription |
string |
Localized description of application |
| localizedName |
string |
Localized name of application |
| packageId |
string (uuid) |
Package ID |
| packageUniqueName |
string |
Package unique name. |
| packageVersion |
string |
Package version |
| publisherId |
string (uuid) |
Publisher ID |
| publisherName |
string |
Publisher name for the application |
| singlePageApplicationUrl |
string |
Single Page Application (SPA) URL |
| termsOfServiceBlobUris |
string[] |
Terms of service for the application |
InstancePackageOperation
| Name | Type | Description |
|---|---|---|
| createdOn |
string (date-time) |
Date and time for creation of the instance package operation |
| errorDetails | ||
| instancePackageId |
string (uuid) |
Instance package ID |
| modifiedOn |
string (date-time) |
Date and time for modification of the instance package operation |
| operationId |
string (uuid) |
Operation ID for the operation triggered on the instance package |
| state |
State of the instance package |
|
| statusMessage |
string |
Status message |
InstancePackageState
State of the instance package
| Value | Description |
|---|---|
| None | |
| Installed | |
| Uninstalled | |
| InstallRequested | |
| UninstallRequested | |
| InstallFailed | |
| UninstallFailed | |
| Installing | |
| Uninstalling | |
| InstallScheduled | |
| InstallRetrying | |
| TemplateInstalled |
TpsInstallRequestPayload
Payload to be sent during installation of the package
| Name | Type | Description |
|---|---|---|
| payloadValue |
string |