ChangeRequest

Standard fields extend the ChangeRequest object for use in Agentforce IT Service to represent the fix implemented for an issue. This object is available in API version 65.0 and later.

Supported Calls 

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

Fields 

ActualStartDate 

  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The date and time on which a change request is actually started.

AssignedGroupId 

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The group or queue to which the change request is assigned. This field is a relationship field.
  • Relationship Name: AssignedGroup
  • Refers To: Group

AssignedUserId 

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The primary user to whom the change request is assigned. This field is a relationship field.
  • Relationship Name: AssignedUser
  • Refers To: User

BusinessHoursId 

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The ID of the business hours related to the entitlement process for a change request. This field is a relationship field.
  • Relationship Name: BusinessHours
  • Refers To: BusinessHours

CalculatedRiskScore 

  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The score calculated by automated processes to determine how likely is the proposed change to cause risk.

ClosedStatusCode 

  • Type: picklist

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

  • Description: Specifies the status code for the change request when it’s closed, such as Successful, Partially Successful, or Failed.

  • Possible values:

    • Failed
    • PartiallySuccessful—Partially Successful
    • Successful

ClosedStatusComments 

  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: The comments related to the change request when the status is Closed.

CompletionDate 

  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The date and time on which a change request is closed.

EntitlementId 

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The ID of the entitlement related to the change request. This field is a relationship field.
  • Relationship Name: Entitlement
  • Refers To: Entitlement

ImplementationPlan 

  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: The implementation plan related to a change request.

IsClosed 

  • Type: boolean
  • Properties: Defaulted on create, Filter, Group, Sort
  • Description: Indicates whether a change request is closed (true) or not (false).
  • Default value: false

IsStopped 

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether a change request is paused for further processing (true) or not (false).
  • Default value: false

MilestoneStatus 

  • Type: string
  • Properties: Group, Nillable, Sort
  • Description: The milestone status related to the entitlement process for a change request.

RequestedById 

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The user who requests the change request. This field is a relationship field.
  • Relationship Name: RequestedBy
  • Refers To: User

SlaExitDate 

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The date and time when the entitlement process ends for a change request.

SlaStartDate 

  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The date and time when the entitlement process starts for a change request.

StopStartDate 

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The date and time when the change request is paused.

SubCategory 

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Specifies the subcategory of a change request.

TestPlan 

  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: The test plan related to a change request.

Type 

  • Type: picklist

  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update

  • Description: Specifies the type of a change request, such as standard, normal, or emergency. The Type and Change Type fields are mutually exclusive and only one should be used at a time.

  • Default value: Standard

  • Possible values:

    • Emergency
    • Normal
    • Standard

Urgency 

  • Type: picklist

  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update

  • Description: Specifies the urgency of the change request.

  • Default value: High

  • Possible values:

    • High
    • Low
    • Medium

For other fields on this object, see Object Reference for the Salesforce Platform: ChangeRequest