Newer Version Available

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

ApprovalWorkItem

Contains run-time information about each step in an approval workflow, such as assignees and their decisions regarding the object's approval. Has a master-detail relationship with ApprovalSubmission. This object is available in API version 61.0 and later.

Supported Calls

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

Special Access Rules

This object is available in Enterprise, Performance, Unlimited, and Developer Editions for users with access to the Approval Submission object.

Fields

Field Details
ApprovalChainName
Type
string
Properties
Filter, Group, Nillable, Sort, Update
Description
The name of the related approval chain. This field is populated when there are multiple approval chains that are run in parallel. This field is only available with Advanced Approvals enabled.
ApprovalConditionName
Type
string
Properties
Filter, Group, Nillable, Sort, Update
Description
The name of the condition that assigns the work item to a user or group for approval.
ApprovalSubmissionId
Type
reference
Properties
Filter, Group, Sort
Description
The approval submission that's associated with this item.
This field is a relationship field.
Relationship Name
ApprovalSubmission
Relationship Type
Master-detail
Refers To
ApprovalSubmission (the master object)
AssignedToId
Type
reference
Properties
Filter, Group, Nillable, Sort, Update
Description
The user, group, or queue that was assigned the work item.
This field is a polymorphic relationship field.
Relationship Name
AssignedTo
Refers To
Group (Type = Regular), Group (Type = Queue), User
Comments
Type
textarea
Properties
Nillable, Update
Description
The comments that the user adds when they review or override the work item.
FlowOrchestrationWorkItemId
Type
reference
Properties
Filter, Group, Nillable, Sort, Update
Description
The identifier of the associated flow orchestration work item.
This field is a relationship field.
Relationship Name
FlowOrchestrationWorkItem
Refers To
FlowOrchestrationWorkItem
IsAutoReviewed
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the work item was auto-reviewed (true) or not (false).
The default value is false.
This field is only available with Advanced Approvals enabled.
IsEligibleForAutoApproval
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether custom logic is used for auto-approval of this approval work item (true) or not (false).
This field is only available with Advanced Approvals enabled.
IsEligibleForSmartApproval
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the approval work item is eligible for smart approval (true) or not (false).
The default value is false.
This field is only available with Advanced Approvals enabled.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
The sequentially-generated name of the related record that’s submitted for approval, for example AWI-000000001.
RelatedRecordId
Type
reference
Properties
Filter, Group, Nillable, Sort, Update
Description
The API name of the related record that's submitted for approval.
Relationship Name
RelatedRecord
Refers To
The objects that you have access to for approvals.
RelatedRecordObjectName
Type
string
Properties
Filter, Group, Nillable, Sort, Update
Description
The name of the related record that's submitted for approval.
ReviewedById
Type
reference
Properties
Filter, Group, Nillable, Sort, Update
Description
The identifier of the user that reviewed the work item.
This field is a relationship field.
Relationship Name
ReviewedBy
Refers To
User
ReviewedDate
Type
dateTime
Properties
Filter, Nillable, Sort, Update
Description
The date and time when the work item was reviewed.
SmartApprovalBasisWorkItemId
Type
reference
Properties
Filter, Group, Nillable, Sort, Update
Description
The previous approval work item used as a reference for the auto-approval evaluation.
This field is a relationship field.
This field is only available with Advanced Approvals enabled.
Relationship Name
SmartApprovalBasisWorkItem
Refers To
ApprovalWorkItem
Status
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort, Update
Description
The status of the approval work item.
Possible values are:
  • Approved
  • Assigned
  • Canceled
  • Errored—Error
  • Recalled
  • Rejected
  • Withdrawn

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.

ApprovalWorkItemHistory
History is available for tracked fields of the object.