Object Reference for Salesforce and Force.com

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

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

ProcessInstanceStep

Represents one work item in an approval process (ProcessInstance).

Exceptions apply to approval history data retrieved with this object and available only via the SOAP API. For each approval process instance that was pending when Summer ’14 became available for your organization, some field values are never populated or are populated only after the approval process instance is next acted upon—such as when a user approves, rejects, or reassigns an approval request—after the Summer ’14 rollout.

Note

ProcessInstanceStep fields are never populated for approval process instances that were completed before the Summer ’14 rollout. For approval process instances that were pending during the Summer ’14 rollout, all ProcessInstanceStep fields are populated only after the approval process instance is next acted upon after the Summer ’14 rollout.

Supported Calls

describeSObjects(), query(), retrieve()

Special Access Rules

Portal and Communities users can’t access this object.

Fields

Field Details
ActorId
Type
reference
Properties
Filter, Group, Sort
Description
ID of the user who is currently assigned to this approval step.
Comments
Type
string
Properties
Filter, Nillable, Sort
Description
Limit: 4,000 bytes.
ElapsedTimeInDays
Type
double
Properties
Filter, Nillable, Sort
Description
The total time in days since this step was started.
ElapsedTimeInHours
Type
double
Properties
Filter, Nillable, Sort
Description
The total time in hours since this step was started.
ElapsedTimeInMinutes
Type
double
Properties
Filter, Nillable, Sort
Description
The total time in minutes since this step was started.
OriginalActorId
Type
reference
Properties
Filter, Group, Sort
Description
ID of the user who was originally assigned to this approval step.
ProcessInstanceId
Type
reference
Properties
Filter, Group, Sort
Description
ID of the ProcessInstance that this approval step belongs to.
StepNodeId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
ID of the node currently assigned to this approval step.
StepStatus
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The current status of this approval step.
  • Approved
  • Fault
  • Held
  • NoResponse
  • Pending
  • Reassigned
  • Rejected
  • Removed
  • Started

If the approval step requires unanimous approval and one approver rejects the request, the value of this field for the other approvers changes to NoResponse. Likewise, if approval is based on the first response and an approver responds, the value of this field for the other approvers changes to NoResponse.

Usage

Query or retrieve a new step in an approval process (ProcessInstance).