PackageInstallRequest

Represents a request to install a package (first- or 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
EnableRss	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Specifies whether the package can send and receive Remote Site Settings (RSS) and Content Security Policy (CSP) data from third-party websites (`true`) or not (`false`). The default value is `false`. Available in API version 43.0 and later.
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 in an unmanaged package. Valid values are: `Block`: Throw an exception on name conflicts. `RenameMetadata`: Rename only those components that can be renamed, otherwise throw an exception.
PackageInstallRequestErrors	Type QueryResult Properties Filter, Group, Nillable, Sort Description An array of strings that are actionable, visible errors. Because this field represents a relationship, use only in subqueries.
PackageInstallSource	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description For internal use only.
Password	Type string Properties Create, Filter, Group, Nillable, Sort Description The installation key for the package. Required for packages that are protected by an installation key.
ProfileMappings	Type SubscriberPackageProfileMappings Properties Create, Nillable Description Mappings between profile settings in the package and profiles in the subscriber org. When installing a package, the admin for the subscriber org chooses which profiles in the org to map the profile settings in the package to.
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` `InProgress` `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.

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

SubscriberPackageInstallError

Represents a single error that occurred during package installation.

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

SubscriberPackageProfileMappings

Represents the list of profile mappings for which this package is installed.

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.

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

Tooling API