Applications - Get Environment Application Package

Get list of application packages that are available for installation in a target environment.

GET https://api.powerplatform.com/appmanagement/environments/{environmentId}/applicationPackages?api-version=2022-03-01-preview
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

Success

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

Security

oauth2

Azure Active Directory OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize?resource=https://api.powerplatform.com
Token URL: https://login.microsoftonline.com/common/oauth2/token

Definitions

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

Application Visibility

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

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

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