Newer Version Available

This content describes an older version of this product. View Latest

Package2VersionCreateRequest (Beta)

Represents a request to create a second-generation package version in a Dev Hub org. Available in API version 41.0 and later.

As a beta feature, Second-Generation Packaging is a preview and isn’t part of the “Services” under your master subscription agreement with Salesforce. Use this feature at your sole discretion, and make your purchase decisions only on the basis of generally available products and features. Salesforce doesn’t guarantee general availability of this feature within any particular time frame or at all, and we can discontinue it at any time. This feature is for evaluation purposes only, not for production use. It’s offered as is and isn’t supported, and Salesforce has no liability for any harm or damage arising out of or in connection with it. All restrictions, Salesforce reservation of rights, obligations concerning the Services, and terms for related Non-Salesforce Applications and Content apply equally to your use of this feature. You can provide feedback and suggestions for second-generation packaging in the Packaging 2 Beta group in the Trailblazer Community.

Note

Supported SOAP Calls

create(), query(), retrieve(), update(), upsert()

Supported REST HTTP Methods

Query, GET, POST

Fields

Field Details
Branch
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The branch to associate with this package version. Can be used to create a tree structure of inheritance. Upon successful creation of a Package2Version, this value is copied to the package version’s Branch field.

The default value is null.

InstallKey
Type
encryptedstring
Properties
Create, Nillable
Description
Installation key for installing a key-protected package. The default is null.

Used only on insert. If you query for this value, null is always returned (for security reasons).

The default value is null.

IsPasswordProtected
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Specifies whether installation of this package version requires the user to provide an installation key (true) or not (false).

The default value is null.

Package2Id
Type
reference
Properties
Create, Filter, Group, Sort
Description
A reference to an ID for the Package2 to create a version of.

The default value is null.

Package2VersionId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
A reference to an ID for the Package2Version that this request creates (starts with 05i).

The default value is null.

Status
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The status of the Package2Version creation request. Valid values include:
  • Queued
  • InProgress
  • Success
  • Error

The default value is null.

Tag
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Optional tags for the package version.

The default value is null.

VersionInfo
Type
base64
Properties
Create
Description
The blob that stores details about the package version.

The default value is null.