SandboxProcess
When you create a SandboxInfo record, a corresponding SandboxProcess record is created. The latest SandboxProcess record for a SandboxInfo record represents the current state of the sandbox.
This object is available in API version 35.0 and later.
Supported SOAP Calls
query(), retrieve(), update()
Supported REST HTTP Methods
GET, PATCH
Fields
Except for RefreshAction, all fields are
read only. The read-only fields represent the attributes chosen on SandboxInfo when a
copy process was enqueued, or represent the state of the process for monitoring
purposes.
Field | Details |
---|---|
ActivatedById |
|
ActivatedDate |
|
ActivationUserGroupId |
|
ApexClassId |
|
AutoActivate |
|
CopyArchivedActivities |
|
CopyChatter |
|
CopyProgress |
|
Description |
|
EndDate |
|
Features |
|
HistoryDays |
|
LicenseType |
|
RefreshAction |
|
SandboxInfoId |
|
SandboxName |
|
SandboxOrganization |
|
SourceId |
|
StartDate |
|
Status |
|
TemplateId |
|
Usage
SandboxInfo represents a sandbox, and SandboxProcess represents the sandbox
copy process, which occurs when you create a sandbox or refresh it. You can also delete
a sandbox.
Creating a Sandbox
To enqueue a new sandbox:
- Create a SandboxInfo record.
- To find the status of a sandbox after it is enqueued, query SandboxProcess for a given SandboxInfoId field to find the latest SandboxProcess record. The value of Completed in Status indicates that the creation process is finished.
Refreshing a Sandbox
To refresh a sandbox:
- To start a sandbox refresh, edit the SandboxInfo record.
- To find the status of a sandbox after it is enqueued, find the latest SandboxProcess record by querying SandboxProcess for a given SandboxInfoId value. The value of Status indicates the current state of the process.
- When the Status field value is Pending Activation, change the value of the RefreshAction field to either ACTIVATE or DISCARD.