PackageVersionHeader

Specifies the package version for each installed managed package.

A managed package can have several versions with different content and behavior. This header allows you to specify the version used for each package referenced by your API client.

If a package version isn’t specified, the API client uses the version of the package specified in Setup. From Setup, enter API in the Quick Find box, select API, and then click Configure Enterprise Package Version Settings under Enterprise Package Version Settings.

This header is available in API version 16.0 and later.

Associated API Calls

convertLead(), create(), delete(), describeGlobal(), describeLayout(), describeSObject(), describeSObjects(), describeSoftphoneLayout(), describeTabs(), executeAnonymous(), merge(), process(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

packageVersions

Type: PackageVersion[]

Description: A list of package versions for installed managed packages referenced by your API client.

PackageVersion

Specifies a version of an installed managed package. A package version is majorNumber.minorNumber, for example 2.1.

majorNumber

Type: int

Description: The major version number of a package version.

minorNumber

Type: int

Description: The minor version number of a package version.

namespace

Type: string

Description: The unique namespace of the managed package.

Sample Code—Java

This sample sets the package version for one installed package in the PackageVersionHeader. Next, it executes the code passed into this method via the executeAnonymous Apex method.

1import com.sforce.soap.apex.SoapConnection;
2
3import com.sforce.soap.apex.PackageVersion;
4
5import com.sforce.soap.apex.ExecuteAnonymousResult;
6
7public void PackageVersionHeaderSample(SoapConnection connection, String code) throws Exception {
8
9  com.sforce.soap.apex.PackageVersion pv = new com.sforce.soap.apex.PackageVersion();
10
11  pv.setNamespace("installedPackageNamespaceHere");
12
13  pv.setMajorNumber(1);
14
15  pv.setMinorNumber(5);
16
17  PackageVersion[] pvs = new PackageVersion[]{pv};
18
19  connection.setPackageVersionHeader(pvs);
20
21  ExecuteAnonymousResult result = connection.executeAnonymous(apexCode);
22
23  if (result.isCompiled()) {
24
25    System.out.println("Compiled successfully.");
26
27    System.out.println("Execution result: " + (result.isSuccess() ? "SUCCESS" : "FAILED!"));
28
29    if (!result.isSuccess()) {
30
31      System.out.println("Cause: " + result.getExceptionMessage());
32
33      System.out.println(result.getExceptionStackTrace());
34
35    }
36
37  } else {
38
39    System.out.println("Failed to compile: " + result.getCompileProblem());
40
41  }
42
43}