Applications - Get Environment Application Package
Get the list of application packages that are available for install in a target environment.
Get the list of available application packages that are relevant in the context of a target environment. The client can filter the application packages based on install state (NotInstalled, Installed, All) and any other response parameters utilizing standard OData capabilities.
GET https://api.powerplatform.com/appmanagement/environments/{environmentId}/applicationPackages?api-version=2022-03-01-previewGET https://api.powerplatform.com/appmanagement/environments/{environmentId}/applicationPackages?appInstallState={appInstallState}&lcid={lcid}&api-version=2022-03-01-previewURI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
environment
|
path | True |
string |
Environment ID (not to be confused with Org ID). |
|
api-version
|
query | True |
string |
The API version. |
|
app
|
query |
string |
Application package install state. |
|
|
lcid
|
query |
string |
Application package supported language ID. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
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 |
|
|
Application |
Application visibility |
|
Catalog |
Catalog visibility for the application |
|
Error |
|
|
Instance |
State of the instance package |
ApplicationPackage
| Name | Type | Description |
|---|---|---|
| applicationDescription |
string |
Application description |
| applicationId |
string (uuid) |
Application ID |
| applicationName |
string |
Application name |
| applicationVisibility |
Application visibility |
|
| catalogVisibility |
Catalog visibility for the application |
|
| customHandleUpgrade |
boolean |
Available package custom upgrade |
| endDateUtc |
string (date-time) |
End date for application package |
| id |
string (uuid) |
Available package ID or instance package ID, where both map to the application package ID |
| instancePackageId |
string (uuid) |
Instance package ID that is used only for a retry of package installation (for example, a reinstall). |
| lastError | ||
| learnMoreUrl |
string |
Learn more URL for the application |
| localizedDescription |
string maxLength: 1000 |
Localized description for the application package |
| localizedName |
string |
Localized name of application package |
| platformMaxVersion |
string |
Available package platform maximum version |
| platformMinVersion |
string |
Available package platform minimum version |
| publisherId |
string (uuid) |
Publisher ID |
| publisherName |
string |
Publisher name |
| singlePageApplicationUrl |
string |
Single Page Application (SPA) URL associated with the application |
| startDateUtc |
string (date-time) |
Start date for application package |
| state |
State of the instance package |
|
| supportedCountries |
string[] |
List of supported countries/regions for the application |
| uniqueName |
string |
Available package unique name or instance package unique name |
| version |
string |
Available package version or instance package version |
ApplicationPackageContinuationResponse
| Name | Type | Description |
|---|---|---|
| @odata.nextLink |
string |
|
| value |
ApplicationVisibility
Application visibility
| Value | Description |
|---|---|
| None | |
| CrmAdminCenter | |
| BapAdminCenter | |
| OneAdminCenter | |
| All |
CatalogVisibility
Catalog visibility for the application
| Value | Description |
|---|---|
| None | |
| AdminCenter | |
| Teams | |
| 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 |
InstancePackageState
State of the instance package
| Value | Description |
|---|---|
| None | |
| Installed | |
| Uninstalled | |
| InstallRequested | |
| UninstallRequested | |
| InstallFailed | |
| UninstallFailed | |
| Installing | |
| Uninstalling | |
| InstallScheduled | |
| InstallRetrying | |
| TemplateInstalled |