DevopsEnvironment

Represents a connection from DevOps Center to an environment, which currently can be only a Salesforce org. Developers use development environments to do their work. Each pipeline stage has an associated environment. This object is available in API version 66.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Field Details
CanTrackChanges
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether source tracking is enabled for this environment.
The default value is false.
DoceHubType
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Possible values are:
  • CORE
IsDevEnvironment
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the environment is a development environment.
The default value is false.
IsExpired
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates if the connection to the environment is invalid or the environment has expired. For example, a deleted or expired scratch org, or a refreshed sandbox whose org ID no longer matches OrgIdentifier.
The default value is false.
IsTestEnvironment
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether DevOps Center uses test.salesforce.com for login. When false, DevOps Center uses login.salesforce.com.
The default value is false.
IsVibeEnvironment
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether this pipeline is associated with a Code Builder (Agentforce Vibes) environment.
The default value is false.
LastRevisionCounter
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Tracks the last revision or sync point for source control to determine changes. DevOps Center uses this value to ensure that it doesn't pull duplicate records.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The name of the environment.
NamedCredential
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The unique name of the named credential that DevOps Center uses to authenticate and connect to the org referenced by this environment.
OrgIdentifier
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The 18-character ID of the Salesforce org that this environment is connected to. DevOps Center connects to an org using a URL. When it connects, it compares its org ID with the value in this field. If the two IDs differ, DevOps Center determines that the connected org is a refreshed sandbox.
OrgType
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Classifies the connected Salesforce org.
Possible values are:
  • PRODUCTION
  • SANDBOX
The default value is PRODUCTION.
OrgUrl
Type
url
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The login URL DevOps Center uses to connect to the org.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The ID of the owner of this record.
This field is a polymorphic relationship field.
Relationship Name
Owner
Refers To
Group, User
RefreshDate
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date and time that this sandbox was last refreshed from its parent org. DevOps Center uses this field with Refresh Source ID to determine post-refresh state. For example, work items that are missing from a recently swapped environment.
RefreshSourceId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the environment that this sandbox was cloned from. DevOps Center uses this field and Refresh Date to determine which work items are missing from a recently swapped environment.
This field is a relationship field.
Relationship Name
RefreshSource
Refers To
DevopsEnvironment
ReplacesId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the environment that this one replaces during reconnection or sandbox swap.
This field is a relationship field.
Relationship Name
Replaces
Refers To
DevopsEnvironment

Usage

Use this object to manage and track the Salesforce orgs DevOps Center connects to for pipeline stages and work items.

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

DevopsEnvironmentFeed
Feed tracking is available for the object.
DevopsEnvironmentHistory
History is available for tracked fields of the object.
DevopsEnvironmentShare
Sharing is available for the object.