Skip Navigation

Newer Version Available

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

ReleaseUpdate

Represents an individual release update. Available in API version 50.0 and later.

Supported SOAP Calls

describeSObjects(), query()

Supported REST HTTP Methods

Query

Fields

Field	Details
ApiVersion	Type double Properties Filter, Nillable, Sort Description The API version to which the update is applied.
Category	Type string Properties Filter, Group, Nillable, Sort Description Indicates the type of the release update. For example, “Security” or “Usability.”
Description	Type string Properties Filter, Nillable, Sort Description The description of the update that appears on the front of the card.
DeveloperName	Type string Properties Filter, Group, Nillable, Sort Description The unique name of the release update.
DueDate	Type date Properties Filter, Group, Nillable, Sort Description The date by which test runs must be completed.
DurableId	Type string Properties Filter, Group, Nillable, Sort Description The unique name of the release update.
HasNewSteps	Type boolean 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`).
IsReleased	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates if the update is released (`true`) or not (`false`).
NumCompSteps	Type integer Properties Filter, Group, Nillable, Sort Description Indicates how many steps have been completed in the update.
NumReqSteps	Type integer Properties Filter, Group, Nillable, Sort Description Indicates the total number of required steps before proceeding with test run.
NumSteps	Type integer Properties Filter, Group, Nillable, Sort Description Indicates the total number of all steps in the update.

Release	Type string 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 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 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 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.
StepStage	Type string 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 Properties Defaulted on create, Filter, Group, Sort Description Indicates if the update has a test run(`true`) or not (`false`). Default is false.
Title	Type string Properties Filter, Nillable, Sort Description The release update title that appears at the top of the release update in the UI.