Applications - Install Application Package

Service:

Power Platform API

API Version:

2022-03-01-preview

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

URI Parameters

Name	In	Required	Type	Description
environmentId	path	True	string	Environment ID (not to be confused with the organization ID).
uniqueName	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	InstancePackage	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
ApplicationVisibility	Application visibility
ErrorDetails
InstancePackage
InstancePackageOperation
InstancePackageState	State of the instance package
TpsInstallRequestPayload	Payload to be sent during installation of the package

ApplicationVisibility

Enumeration

Application visibility

Value	Description
All
BapAdminCenter
CrmAdminCenter
None
OneAdminCenter

ErrorDetails

Object

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

Object

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	ApplicationVisibility	Application visibility
customHandleUpgrade	boolean	Custom handle upgrade flag for the application
id	string (uuid)	Instance package ID
lastOperation	InstancePackageOperation
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

Object

Name	Type	Description
createdOn	string (date-time)	Date and time for creation of the instance package operation
errorDetails	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	InstancePackageState	State of the instance package
statusMessage	string	Status message

InstancePackageState

Enumeration

State of the instance package

Value	Description
InstallFailed
InstallRequested
InstallRetrying
InstallScheduled
Installed
Installing
None
TemplateInstalled
UninstallFailed
UninstallRequested
Uninstalled
Uninstalling

TpsInstallRequestPayload

Object

Payload to be sent during installation of the package

Name	Type	Description
payloadValue	string