ReleaseUpdate

Represents an individual release update.

Version 

Introduced in API version 49.0.

Supported SOAP API Calls 

describeSObjects(), query()

Supported REST API Methods 

Query

Fields 

ApiVersion 

• Type: double

• Required: No

• Properties: Filter, Nillable, Sort

• Description: The API version to which the update is applied.

AutoEnforceOnSandboxOnly 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Introduced: API version 63.0

• Default value: false

Category 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: Indicates the type of the release update. For example, “Security” or “Usability.”

Description 

• Type: string

• Required: No

• Properties: Filter, Nillable, Sort

• Description: The description of the update that appears on the front of the card.

DeveloperName 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The unique name of the release update.

DueDate 

• Type: date

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The date by which test runs must be completed.

DurableId 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The unique name of the release update.

HasNewSteps 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Description: Indicates if steps have been added to the release update since its original release (true) or not (false).

• Default value: false

IsReleased 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Description: Indicates if the update is released (true) or not (false).

• Default value: false

NumCompSteps 

• Type: int

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: Indicates how many steps have been completed in the update.

NumReqSteps 

• Type: int

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: Indicates the total number of required steps before proceeding with test run.

NumSteps 

• Type: int

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: Indicates the total number of all steps in the update.

RecompileApexClasses 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Introduced: API version 64.0

• Default value: false

Release 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The release, including patch number, in which the update is available. For example, 50.00.00.

  Also see ReleaseDate and ReleaseLabel.

  Note

ReleaseDate 

• Type: date

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The date in which the update is enforced.

  Only specified if the update is part of a scheduled release, so either Release or ReleaseDate will be non-null. Also see Release and ReleaseLabel.

  Note

ReleaseLabel 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The release label in which the update is enforced. For example, “Winter ‘21.” The label could also be a formatted date if Release is null and ReleaseDate is non-null.

Status 

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Description: Values include:

• Complete: The update has been applied.

• Info: An information-only update; no actions to take.

• Invocable: The update is not yet applied; ready for invocation.

• Invoked: The update has been invoked but can’t be revoked yet.

• Nascent: The update has incomplete steps so test run can’t be run yet.

• Pending: The Complete Steps By date is in the past and update is awaiting enforcement.

• Revocable: The update is in test run mode.

• Possible values:

  • Info — Info

  • Nascent — Nascent

  • Pending — Pending

  • Invocable — Invocable

  • Revocable — Revocable

  • Invoked — Invoked

  • Complete — Complete

StepStage 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: Indicates the stage in which the update is at. Options include Needs Action, Due Soon, Overdue, and Archived.

SupportsRevoke 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Description: Indicates if the update has a test run(true) or not (false). Default is false.

• Default value: false

Title 

• Type: string

• Required: No

• Properties: Filter, Nillable, Sort

• Description: The release update title that appears at the top of the release update in the UI.