ActionPlanTemplate

Represents the instance of an action plan template. In Life Sciences cloud, this object is available in API version 65.0 and later.This object is available in API version 44.0 and later.

Supported Calls

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

Fields

Field Name Details
ActionPlanType
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort
Description

This action plan template’s type. Possible values are:

  • Industries
  • Visit Execution. For Intelligent Sales, select only Visit Execution.
    • PrvdEngmtCompliance—Provider Engagement Compliance
Category
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the category that the action plan template belongs to.

Available in API version 64.0 and later.

Possible values are:
  • Onboarding
  • Application
Description
Type
textarea
Properties
Create, Filter, Group, Nillable, Sort, Update
Description

The description of this action plan template.

EstimatedCompletionDays
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The estimated number of days to complete the action plan.

Available in API version 64.0 and later.

FileBasedTemplatePath
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The path of the file based template using which the action plan template is created.

Available in API version 64.0 and later.

IsAdHocItemCreationEnabled
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether users can add tasks or other items to generated action plans (true) or not (false).
IsLocked
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description

Indicates whether this action plan template is locked or not. The default value is false.

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.

MayEdit
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description

Indicates whether this action plan template can be edited or not. The default value is false.

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

The name of this action plan template.

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

The ID of the user who owns this action plan template. This field is a polymorphic relationship field.

Relationship Name
Owner
Refers To
Group, User
ParentTemplateId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the parent template associated with the action plan template.
This field is a relationship field.
Relationship Name
ParentTemplate
Refers To
ActionPlanTemplate
SourceType
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the source type to which the action plan template belongs to.

Available in API version 64.0 and later.

Possible values are:
  • CRM
  • MigratedFromSandbox
Status
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description

The status of this action plan template.

Possible values are:
  • Draft
  • Final—Published
  • Obsolete
  • ReadOnly
Subcategory
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The subcategory to which the action plan template belongs.

Available in API version 64.0 and later.

Possible values are:
  • Product Onboarding
  • Customer Onboarding
TargetEntityType
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort
Description
The parent object this action plan template relates to.
Possible values are:
  • RelatedListValidation__c—RelatedListValidation
  • omnistudio__VlocityScheduledJob__c—Vlocity Scheduled Job
  • API version 58.0 and later with Health Cloud

    • CareBarrier
UniqueName
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The unique name for this action plan template. This field is unique within your organization.

Associated Objects

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

ActionPlanTemplateChangeEvent
Change events are available for the object.
ActionPlanTemplateFeed
Feed tracking is available for the object.
ActionPlanTemplateHistory
History is available for tracked fields of the object.
ActionPlanTemplateOwnerSharingRule
Sharing rules are available for the object.
ActionPlanTemplateShare
Sharing is available for the object.