PackageInstallRequest

Represents a request to install a package (first- and second-generation) in a target subscriber org. Available in API version 41.0 and later.

Supported SOAP Calls

create(), describeSObjects(), query(), retrieve()

Supported REST HTTP Methods

GET, POST, Query

Fields

Field	Details
Errors	Type SubscriberPackageInstallErrors Properties Nillable Description Errors that occurred during installation, if any.
NameConflictResolution	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Controls name conflicts between package members. Valid values are: `Block`: Throw an exception on name conflicts. `Rename`: Rename only those components that can be renamed, otherwise throw an exception.
PackageInstallSource	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Specifies the source of the package to be installed. Valid values are: `U`: Installed from a public copy on AppExchange. `R`: Installed from a private copy on AppExchange. `D`: Installed from DOT file. `S`: Installed as part of a sandbox copy. `A`: Auto-installed package.
Password	Type string Properties Create, Filter, Group, Nillable, Sort Description An optional password (installation key) for sharing the package privately with anyone who has the password. Don't enter a password if you want to make the package available to anyone on AppExchange and share your package publicly.
ProfileMappings	Type SubscriberPackageProfileMappings Properties Create, Nillable Description List of profile mappings for which this package is installed.
SecurityType	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Users for which this package is installed. Valid values are: `Custom`: Installed for specified custom profiles. `Full`: Installed for all users. `None`: Installed for administrators only.
Status	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The status of the install request. Valid values are: `Error` `In Progress` `Success` `Unknown`
SubscriberPackageVersionKey	Type string Properties Create, Filter, Group, Sort Description Foreign key to the subscriber package version.

SubscriberPackageInstallErrors

Represents the list of errors that occurred during package installation. Available in API version 41.0 and later.

Field	Details
errors	Type SubscriberPackageInstallError Description The errors that occurred during package install.

SubscriberPackageInstallError

Represents a single error that occurred during package installation. Available in API version 41.0 and later.

Field	Details
message	Type string Description Describes the error that occurred.

SubscriberPackageProfileMappings

Represents the list of profile mappings for which this package is installed. Available in API version 41.0 and later.

Field	Details
profileMappings	Type SubscriberPackageProfileMapping Description Name of the profile mapping.

SubscriberPackageProfileMapping

Represents a mapping between a profile in the package that is being installed and the profile in the target subscriber org. Available in API version 41.0 and later.

Field	Details
source	Type string Description The name of the profile in the package that is being installed.
target	Type string Description The name of the profile in the target subscriber org.

Tooling API