SubscriberPackageVersion | Tooling API

Supported SOAP Calls

describeSObjects(), query(), retrieve()

Supported REST HTTP Methods

GET, Query

Fields

Field	Details
AppExchangeDescription	Type string Properties Nillable, Sort Description The AppExchange description for this package. If the AppExchange listing for the package doesn’t contain a value for this field, the field’s value is `null`.
AppExchangeLogoUrl	Type string Properties Nillable, Sort Description The URL that AppExchange uses to display the logo for this package. If the AppExchange listing for the package doesn’t contain a value for this field, the field’s value is `null`.
AppExchangePackageName	Type string Properties Group, Nillable, Sort Description The AppExchange name for this package. If the AppExchange listing for the package doesn’t contain a value for this field, the field’s value is `null`.
AppExchangePublisherName	Type string Properties Group, Nillable, Sort Description The AppExchange publisher name for this package. If the AppExchange listing for the package doesn’t contain a value for this field, the field’s value is `null`.
BuildNumber	Type int Properties Group, Nillable, Sort Description Part of the version number of a package version. The complete version number format is `major.minor.patch.build`—for example, in `1.2.0.5` the build number is `5`.
CspTrustedSites	Type SubscriberPackageCspTrustedSites Properties Nillable Description List of new Content Security Policy (CSP) Trusted Sites that the user must authorize before installing the package version. Package upgrades don't include previously installed CSP Trusted Sites.
Dependencies	Type SubscriberPackageDependencies Properties Nillable Description Other subscriber package versions that this subscriber package version depends on. Available in API version 44.0 and later.
Description	Type string Properties Nillable, Sort Description Description of the package.
InstallationKey	Type RAW Properties Not applicable Description Installation key for a key-protected package. This field is hidden. It’s not queryable, but you can include it in the `WHERE` clause of SOQL queries. In some queries, it’s required. To query unlocked packages that have installation keys, you must include the correct InstallationKey value in your `WHERE` clause. However, if the unlocked package version is already installed in your org you can query it without specifying an InstallationKey value. For managed packages, an InstallationKey value in the `WHERE` clause is optional.
InstallValidationStatus	Type picklist Properties Group, Nillable, Restricted picklist, Sort Description Status of the validation tests that are run during the package version install. Valid values are: `NoErrorsDetected` `BetaInstallIntoProductionOrg` `CannotInstallEarlierVersion` `CannotUpgradeBeta` `CannotUpgradeUnmanaged` `DeprecatedInstallPackage` `ExtensionsOnLocalPackages` `PackageNotInstalled` `PackageHasInDevExtensions` `InstallIntoDevOrg` `NoAccess` `PackagingDisabled` `PackagingNoAccess` `PackageUnavailable` `UninstallInProgress` `UnknownError` `NamespaceCollision`
IsBeta	Type boolean Properties Defaulted on create, Group, Sort Description Indicates whether the package version is released (`false`).
IsDeprecated	Type boolean Properties Defaulted on create, Group, Sort Description Specifies whether this package version has been marked as deprecated (`true`) or not (`false`).
IsManaged	Type boolean Properties Defaulted on create, Group, Sort Description Specifies whether this package is managed (`true`) or not (`false`).
IsPasswordProtected	Type boolean Properties Defaulted on create, Group, Sort Description Specifies whether installation of this package version requires the user to provide an installation key (`true`) or not (`false`).
IsSecurityReviewed	Type boolean Properties Defaulted on create, Group, Sort Description Specifies whether the package has passed the security review required for publishing in AppExchange.
MajorVersion	Type int Properties Group, Nillable, Sort Description Part of the version number of a package version. The complete version number format is `major.minor.patch.build`—for example, in `1.2.0.5` the major version is `1`.
MinorVersion	Type int Properties Group, Nillable, Sort Description Part of the version number of a package version. The complete version number format is `major.minor.patch.build`—for example, in `1.2.0.5` the minor version is `2`.
Name	Type string Properties Group, idLookup, Sort Description Name of the package.
Package2ContainerOptions	Type picklist Properties Group, Nillable, Restricted picklist, Sort Description Container options for the second-generation package. These options determine the upgrade and editability rules. Valid values are: `Managed` `Unlocked`
PatchVersion	Type int Properties Group, Nillable, Sort Description Part of the version number of a package version. The complete version number format is `major.minor.patch.build`—for example, in `1.2.0.5` the patch version is `0`.
PostInstallUrl	Type string Properties Nillable, Sort Description The fully qualified URL of the post-installation instructions. Instructions are shown as a link after installation and are available from the package detail view.
Profiles	Type SubscriberPackageProfiles Properties Nillable Description List of profiles for which the package was installed.
PublisherName	Type string Properties Group, Nillable, Sort Description The name of the publisher of this package.
ReleaseNotesUrl	Type string Properties Nillable, Sort Description The fully qualified URL of the package release notes. Release notes are shown as a link during the installation process and are available from the package detail view after installation.
ReleaseState	Type picklist Properties Group, Nillable, Restricted picklist, Sort Description If the package version is a beta version, the value is `Beta`. Otherwise, the value is `Released`.
RemoteSiteSettings	Type SubscriberPackageRemoteSiteSettings Properties Nillable Description List of new Remote Site Settings that the user must authorize before installing the package. Package upgrades don’t include previously installed Remote Site Settings.
SubscriberPackageId	Type ID Properties Group, Nillable, Sort Description ID of the parent SubscriberPackage. The ID starts with the string `033`. This value is case-sensitive and must be unique.

SubscriberPackageCspTrustedSites

Represents the list of new Content Security Policy (CSP) Trusted Sites that the user must authorize before installing the package version. Available in API version 41.0 and later.

Field	Details
settings	Type SubscriberPackageCspTrustedSite Description List of CSP trusted sites that have been added to the package. These sites must be authorized before installation. If the AppExchange listing for the package doesn’t contain a value for this field, the field’s value is `null`.

SubscriberPackageCspTrustedSite

Represents a new Content Security Policy (CSP) Trusted Sites that the user must authorize before installing the package version. Available in API version 41.0 and later.

Field	Details
endpointUrl	Type string Description The URL associated with the CSP trusted site.

SubscriberPackageDependencies

Represents a list of subscriber package version IDs that a subscriber package version depends on. Available in API version 44.0 and later.

Field	Details
ids	Type SubscriberPackageDependency Description List of SubscriberPackageDependency IDs: 04t IDs for the package versions that a subscriber package version depends on.

SubscriberPackageProfiles

Represents a mapping between the profiles contained in the package and the profiles that are applied in the target subscriber org. Available in API version 41.0 and later.

Field	Details
destinationProfiles	Type SubscriberPackageDestinationProfile Description The profiles that the administrator installing the package in a target subscriber org actually applies.
sourceProfiles	Type SubscriberPackageSourceProfile Description The profiles that are contained in the package that is being installed.

SubscriberPackageDestinationProfile

Represents the profile that an administrator applies when installing the package in a target subscriber org. Available in API version 41.0 and later.

Field	Details
description	Type string Description The description of the profile.
displayName	Type string Description The display name of this profile.
name	Type string Description The name of the profile.
noAccess	Type boolean Description Returns `true` if the profile is internal.
profileId	Type string Description The ID of the profile.
type	Type string Description The API name of the profile.

SubscriberPackageSourceProfile

Represents a profile contained in the package to be installed. Available in API version 41.0 and later.

Field	Details
label	Type string Description The profile label.
value	Type string Description The name of the profile.

SubscriberPackageRemoteSiteSettings

Represents a list of Remote Site Settings (RSS) that have been added to the package since the last version. Available in API version 41.0 and later.

Field	Details
settings	Type SubscriberPackageRemoteSiteSetting Description List of RSS added to the package since the last version.

SubscriberPackageRemoteSiteSetting

Defines a URL to an external service. The administrator of the subscriber org must authorize access to these services. Available in API version 41.0 and later.

Field	Details
secure	Type boolean Description Returns `true` if the URL uses the `https` protocol. Applies only if protocol security is enabled.
url	Type string Description The URL of the remote service.

Usage

Represents a version of an installable package. To query this object, include an ID (begins with 04t) in your SOQL WHERE clause.

For subscriber package versions with no installation keys, queries must include an ID value, but an InstallationKey value is not required.

1SELECT Dependencies FROM SubscriberPackageVersion
2   WHERE ID = '04txxxxxxxxxxxx'

For unlocked package versions that have installation keys, queries must include both an ID value and an InstallationKey value.

1SELECT Dependencies FROM SubscriberPackageVersion
2   WHERE ID = '04txxxxxxxxxxxx' AND InstallationKey='password123'

For managed first- and second-generation package versions that have installation keys and for unlocked package versions that are installed in your org, queries must include an ID value, but an InstallationKey value is optional.

1SELECT Dependencies FROM SubscriberPackageVersion
2   WHERE ID = '04txxxxxxxxxxxx'

1SELECT Dependencies FROM SubscriberPackageVersion
2   WHERE ID = '04txxxxxxxxxxxx' AND InstallationKey='password123'