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()

Fields

Field Details
ApprovalChainName
Type
string
Properties
Filter, Group, Nillable, Sort
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
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
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, Group, User
Comments
Type
textarea
Properties
Nillable
Description
The comments added by the reviewer of the item.
FlowOrchestrationWorkItemId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The identifier of the associated flow orchestration work item.
This field is a relationship field.
Relationship Name
FlowOrchestrationWorkItem
Refers To
FlowOrchestrationWorkItem
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
The name of the related record that's submitted for approval.
RelatedRecordId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The related record that's submitted for approval as a part of this item.
This field is a polymorphic relationship field.
Relationship Name
RelatedRecord
Refers To
AIOpptStageSuggestion, Account, ActivationTarget, ActivationTargetPlatform, ActvTgtPlatformFieldValue, AdAvailabilityViewConfig, Address, AnalyticsUserAttrFuncTkn, ApprovalSubmission, ApprovalSubmissionDetail, ApprovalWorkItem, Asset, AssetAction, AssetActionSource, AssetContractRelationship, AssetRateAdjustment, AssetRateCardEntry, AssetRelationship, AssetStatePeriod, AssociatedLocation, AsyncOperationTracker, AttrPicklistExcludedValue, AttributeAdjustmentCondition, AttributeBasedAdjRule, AttributeBasedAdjustment, AttributeCategory, AttributeCategoryAttribute, AttributeDefinition, AttributePicklist, AttributePicklistValue, AuditTrailFileExport, AuthorizationForm, AuthorizationFormConsent, AuthorizationFormDataUse, AuthorizationFormText, BatchJob, BatchJobPart, BatchJobPartFailedRecord, BundleBasedAdjustment, BusinessBrand, Case, CaseComment, ChannelProgram, ChannelProgramLevel, ChannelProgramMember, CollaborationGroup, CommSubscription, CommSubscriptionChannelType, CommSubscriptionConsent, CommSubscriptionTiming, Contact, ContactPointAddress, ContactPointConsent, ContactPointEmail, ContactPointPhone, ContactPointTypeConsent, ContactRequest, ContextDefinitionSync, Contract, ContractItemPrice, ContractItemPriceAdjTier, CostBook, CostBookEntry, Customer, DTRecordsetReplica, DataAction, DataActionJobSummary, DataActionTarget, DataGraph, DataKitDeploymentLog, DataLakeObjectInstance, DataQueryWorkspace, DataQueryWorkspaceTab, DataSourceBundle, DataStream, DataUseLegalBasis, DataUsePurpose, DecisionTblFileImportData, DelegatedAccount, DocGenerationQueryResult, DocTemplateSectionCondition, DocumentEnvelope, DocumentGenerationProcess, DocumentRecipient, DocumentTemplate, DocumentTemplateContentDoc, DocumentTemplateSection, DocumentTemplateToken, DuplicateRecordItem, DuplicateRecordSet, EmailMessage, EmpUserProvisionProcessErr, EngagementAttendee, EngagementChannelType, EngagementInteraction, EngagementTopic, ExtDataShare, ExtDataShareTarget, ExternalEventMapping, FlowOrchestrationInstance, FulfillmentOrder, FulfillmentOrderItemAdjustment, FulfillmentOrderItemTax, FulfillmentOrderLineItem, GenOpPlan, GenOpPlanParam, GenOpPlanRequest, GeneratedDocument, GeneratedDocumentSection, Idea, IdentityResolution, Image, Individual, IntegrationProviderDcsnRqmt, IntegrationProviderExecution, Lead, Location, LocationTrustMeasure, ManagedContentVariant, MarketSegment, MarketSegmentActivation, MktCalculatedInsight, MktDataTransform, MktMLModel, MktMLPredictionJob, ObjectStateDefinition, ObjectStateTransition, ObjectStateValue, Obligation, Opportunity, OpportunityRelatedDeleteLog, Order, OrderAction, OrderAdjustmentGroup, OrderDeliveryGroup, OrderDeliveryMethod, OrderItem, OrderItemAdjustmentLineItem, OrderItemDetail, OrderItemRateAdjustment, OrderItemRateCardEntry, OrderItemRecipient, OrderItemRelationship, OrderItemTaxLineItem, OrgMetricScanResult, OrgMetricScanSummary, Organization, PartnerFundAllocation, PartnerFundClaim, PartnerFundRequest, PartnerMarketingBudget, PartyConsent, PriceBookEntryDerivedPrice, PriceBookRateCard, PricingAdjBatchJob, PricingAdjBatchJobLog, PricingApiExecution, PricingProcessExecution, ProcessException, Product2, ProductAttributeDefinition, ProductCatalog, ProductCategory, ProductCategoryDisqual, ProductCategoryProduct, ProductCategoryQualification, ProductClassification, ProductClassificationAttr, ProductComponentGroup, ProductComponentGrpOverride, ProductConfigFlowAssignment, ProductConfigurationFlow, ProductConfigurationRule, ProductDisqualification, ProductQualification, ProductRampSegment, ProductRelComponentOverride, ProductUsageGrant, ProfileSkill, ProfileSkillEndorsement, ProfileSkillUser, PromptAction, PromptError, QuickText, QuickTextUsage, Quote, QuoteLineDetail, QuoteLineItem, QuoteLineItemRecipient, QuoteLineRateAdjustment, QuoteLineRateCardEntry, RateAdjustmentByAttribute, RateAdjustmentByTier, RateCard, RateCardEntry, RatingFrequencyPolicy, RecordActnSelItemExtrc, RecordAlert, RecordAlertActionableTarget, SalesTransactionType, Seller, SetupDataSynchronization, Shipment, ShipmentItem, Site, SocialPersona, SocialPost, Solution, StreamingChannel, TableauHostMapping, Topic, UnitOfMeasure, UnitOfMeasureClass, UsageGrantRenewalPolicy, UsageGrantRolloverPolicy, UsageResource, UsageResourceBillingPolicy, User, UserEsignVendorIdentifier, UserLicense, UserLocalWebServerIdentity, UserProvisioningRequest, WorkBadge, WorkBadgeDefinition, WorkOrder, WorkOrderLineItem, WorkThanks
RelatedRecordObjectName
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The name of the related record that's submitted for approval.
ReviewedById
Type
reference
Properties
Filter, Group, Nillable, Sort
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
Description
The date and time when the work item was reviewed.
Status
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The status of the approval work item.
Possible values are:
  • Approved
  • Assigned
  • Canceled
  • Errored—Error
  • Recalled
  • Rejected
  • Withdrawn