Newer Version Available

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

ActionPlan

Represents the instance of an action plan, a set of tasks created from an action plan template.

Supported Calls

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

Fields

Field Name Details
ActionPlanState
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description

The action plan’s state. Default values are Not Started, In Progress, Canceled, and Completed.

ActionPlanTemplateVersionId
Type
reference
Properties
Create, Filter, Group, Sort
Description

The ID of the version of the action plan template used to create this action plan. At creation, the referenced action plan template must be in the published state.

ActionPlanType
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort
Description

The action plan’s type. Always set to Industries.

IsUsingHolidayHours
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort
Description

Indicates that task completion dates have been calculated by incrementing the task offset for each non-work day, excluding recurring holidays.

LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description

The most recent date on which a user referenced this record.

LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description

The most recent date on which a user viewed this record.

Name
Type
string
Properties
Create, Filter, Group, Sort, Update
Description

Name of the action plan.

OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description

The ID of the user who owns this record.

StartDate
Type
date
Properties
Create, Defaulted on create, Filter, Group, Sort
Description

The start date of this action plan.

TargetId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort
Description

The ID of the parent object record that relates to this action plan. For API version 46 and later, supported parent objects are Account, Campaign, Case, Contact, Contract, Lead, and Opportunity as well as custom objects with activities enabled. (In API version 45 and earlier: the ID of the parent Account record that relates to this action plan.)

Associated Objects

This object has the following associated objects. Unless noted, they are available in the same API version as this object.

ActionPlanOwnerSharingRule
Sharing rules are available for the object.
ActionPlanShare
Sharing is available for the object.