Applications - Get Environment Application Package

Service:

Power Platform API

API Version:

2022-03-01-preview

List application packages that are available for install in a target environment.
Get a list of 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-preview

With optional parameters:

GET https://api.powerplatform.com/appmanagement/environments/{environmentId}/applicationPackages?appInstallState={appInstallState}&lcid={lcid}&api-version=2022-03-01-preview

URI Parameters

Name	In	Required	Type	Description
environmentId	path	True	string	Environment ID (not to be confused with Org ID).
api-version	query	True	string	The API version.
appInstallState	query		string	Application package install state.
lcid	query		string	Application package supported language identifier (ID).

Responses

Name	Type	Description
200 OK	ApplicationPackageContinuationResponse	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
ApplicationPackage
ApplicationPackageContinuationResponse
ApplicationVisibility	Application Visibility.
CatalogVisibility	Catalog visibility for the application.
ErrorDetails
InstancePackageState	State of the instance package.

ApplicationPackage

Name	Type	Description
applicationDescription	string	Application description.
applicationId	string	Application ID.
applicationName	string	Application name.
applicationVisibility	ApplicationVisibility	Application Visibility.
catalogVisibility	CatalogVisibility	Catalog visibility for the application.
customHandleUpgrade	boolean	Available package custom upgrade.
endDateUtc	string	End date for the application package.
id	string	Available package ID or instance package ID where both map to the ApplicationPackage ID.
instancePackageId	string	Instance package ID that is used only for a retry of package installation (for example: Reinstall).
lastError	ErrorDetails
learnMoreUrl	string	Learn more URL for the application.
localizedDescription	string	Localized description for the application package.
localizedName	string	Localized name of the application package.
platformMaxVersion	string	Available package CrmMaxVersion.
platformMinVersion	string	Available package CrmMinVersion.
publisherId	string	Publisher ID.
publisherName	string	Publisher name.
singlePageApplicationUrl	string	Single Page Application (SPA) URL associated with the application.
startDateUtc	string	Start date for the application package.
state	InstancePackageState	State of the instance package.
supportedCountries	string[]	List of supported countries 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	ApplicationPackage[]

ApplicationVisibility

Application Visibility.

Name	Type	Description
All	string
BapAdminCenter	string
CrmAdminCenter	string
None	string
OneAdminCenter	string

CatalogVisibility

Catalog visibility for the application.

Name	Type	Description
AdminCenter	string
All	string
None	string
Teams	string

ErrorDetails

Name	Type	Description
errorCode	integer	Error code from Dataverse.
errorName	string	Error name.
message	string	Error message.
source	string	Source of the error.
statusCode	integer	Status code for the error.
type	string	Error type.

InstancePackageState

State of the instance package.

Name	Type	Description
InstallFailed	string
InstallRequested	string
InstallRetrying	string
InstallScheduled	string
Installed	string
Installing	string
None	string
TemplateInstalled	string
UninstallFailed	string
UninstallRequested	string
Uninstalled	string
Uninstalling	string