ActiveScratchOrg (Beta)

Represents an active scratch org. This object is available in API version 40.0 and later.

Supported Calls

This release contains a beta version of ActiveScratchOrg, which means it’s a high-quality feature with known limitations. General availability, with complete documentation and support, is planned for a subsequent release.

Note

delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update()

Fields

Field Name	Details
AlmReference	Type textarea Properties Nillable, Update Description A description of how this scratch org is associated with a particular continuous integration (CI) job.
Description	Type textarea Properties Create, Nillable, Update Description A description of this scratch org.
Edition	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The org edition of this scratch org. Possible values are Group, Developer, Enterprise, and Professional. This field is read-only.
ExpirationDate	Type date Properties Filter, Group, Nillable, Sort Description Date when the scratch org expires. This field is read-only.
Features	Type textarea Properties Nillable Description The features enabled in this scratch org, such as MultiCurrency. See the Salesforce DX Developer Guide for the full list of valid features. This field is read-only.
LastLoginDate	Type date Properties Filter, Group, Nillable, Sort Description The date of the last user login to the scratch org. This field is read-only.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The date this scratch org was last referenced. This field is read-only.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The date this scratch org was last viewed. This field is read-only.
Name	Type string Properties Autonumber, Defaulted on create, Filter, Sort Description The auto-generated ID of this scratch org. This field is read-only.
Namespace	Type string Properties Filter, Group, Nillable, Sort Description The namespace associated with this scratch org. This field is read-only.
OrgName	Type string Properties Filter, Group, Nillable, Sort Description The name of the scratch org. This field is read-only.
OwnerId	Type reference Properties Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who owns this scratch org. This field is read-only.
ScratchOrg	Type string Properties Filter, Group, Sort Description The org ID of the scratch org. This field is read-only.
ScratchOrgInfoId	Type reference Properties Filter, Group, Nillable, Sort, Update Description The id of the associated ScratchOrgInfo object. This field is read-only.
SignupEmail	Type email Properties Filter, Group, Nillable, Sort Description The email address of the Administration user. This field is read-only.
SignupInstance	Type string Properties Filter, Group, Nillable, Sort Description The Salesforce instance on which this scratch org resides. This field is read-only.
SignupTrialDays	Type int Properties Filter, Group, Nillable, Sort Description The number of days between the scratch org's creation and expiration. This field is read-only.
SignupUsername	Type string Properties Filter, Group, Nillable, Sort Description The username of the Administration user of the scratch org. This field is read-only.
Template	Type string Properties Filter, Group, Nillable, Sort Description The template used to create this scratch org. This field is read-only.

Usage

Salesforce automatically creates an instance of this object after a ScratchOrgInfo record moves to the Active state. The new ActiveScratchOrg gets many of its field values from the ScratchOrgInfo object with which it is associated.

When you delete an ActiveScratchOrg record, its associated scratch org is deleted and its associated ScratchOrgInfo record is moved to the Deleted state.

Object Reference for Salesforce and Force.com

ActiveScratchOrg (Beta)

Supported Calls

Fields

Usage

See Also: