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 list of Application Packages that are relevant in the context of a target environment. 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 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	CatalogVisibility for application
ErrorDetails
InstancePackageState	State of instance package

ApplicationPackage

Name	Type	Description
applicationDescription	string	Application Description
applicationId	string	Application ID
applicationName	string	Application Name
applicationVisibility	ApplicationVisibility	Application Visibility
catalogVisibility	CatalogVisibility	CatalogVisibility for application
customHandleUpgrade	boolean	AvailablePackage CustomUpgrade
endDateUtc	string	End date for applicationPackage
id	string	AvailablePackage Id or InstancePackage PackageId, both maps to ApplicationPackageId
instancePackageId	string	InstancePackage Id, used only for retry of package installation ie, Reinstall.
lastError	ErrorDetails
learnMoreUrl	string	Learn more URL for the application
localizedDescription	string	LocalizedDescription for the application package
localizedName	string	Localized name of application package
platformMaxVersion	string	AvailablePackage CrmMaxVersion
platformMinVersion	string	AvailablePackage CrmMinVersion
publisherId	string	Publisher ID
publisherName	string	Publisher name
singlePageApplicationUrl	string	Single Page Application URL associated with the application
startDateUtc	string	Start date for applicationPackage
state	InstancePackageState	State of instance package
supportedCountries	string[]	List of supported countries for the application
uniqueName	string	AvailablePackage UniqueName or InstancePackage PackageUniqueName
version	string	AvailablePackage Version or InstancePackage PackageVersion

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

CatalogVisibility for application

Name	Type	Description
AdminCenter	string
All	string
None	string
Teams	string

ErrorDetails

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

InstancePackageState

State of 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