Represents a user’s pending
approval request.
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.
ProcessInstanceWorkitem 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 ProcessInstanceWorkitem fields are populated after the
approval process instance is next acted upon after the Summer ’14 rollout, with three
exceptions: ElapsedTimeInDays, ElapsedTimeInDays, and
ElapsedTimeInMinutes fields are never populated in ProcessInstanceWorkitem
records for which equivalent ProcessInstanceStep records were created before the Summer
’14 rollout.
For all other ProcessInstanceWorkitem records, these three fields are populated after the
approval process instance is next acted upon after the Summer ’14 rollout.
Because ProcessInstanceHistory combines fields from ProcessInstanceStep and
ProcessInstanceWorkitem, you may notice incorrect elapsed times of 0 in ProcessInstanceHistory
records because the elapsed time fields were never populated in the related
ProcessInstanceWorkitem record.
Supported Calls
delete(), describeSObjects(), query(), retrieve(), update()
Special Access Rules
Only portal and communities users with the
Customer Community Plus and Partner Community licenses can access this object.
Fields
| ActorId |
- Type
- reference
- Properties
- Filter, Group, Sort, Update
- Description
- ID of the user who is currently responsible for approving an approval
request.
|
| ElapsedTimeInDays |
- Type
- double
- Properties
- Filter, Nillable
- Description
- The total time in days since this approval request was started.
|
| ElapsedTimeInHours |
- Type
- double
- Properties
- Filter, Nillable
- Description
- The total time in hours since this approval request was started.
|
| ElapsedTimeInMinutes |
- Type
- double
- Properties
- Filter, Nillable
- Description
- The total time in minutes since this approval request was started.
|
| OriginalActorId |
- Type
- reference
- Properties
- Filter, Group, Sort, Update
- Description
- ID of the user who was originally assigned this approval request.
|
| ProcessInstanceId |
- Type
- reference
- Properties
- Filter, Group, Sort, Update
- Description
- ID of the ProcessInstance associated with this approval request.
|
Usage
Use this object to manage a pending approval request for a user.
j