msdyn_playbooktemplate Entity Reference

Playbook templates contains the definition of the Playbook that helps to standardize a set of best practices or next best actions.

Added by: Playbook Solution

Messages

Message Web API Operation SDK Assembly
Assign PATCH [org URI]/api/data/v9.0/msdyn_playbooktemplates(msdyn_playbooktemplateid)
Update ownerid property.
AssignRequest
Create POST [org URI]/api/data/v9.0/msdyn_playbooktemplates
See Create
CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.0/msdyn_playbooktemplates(msdyn_playbooktemplateid)
See Delete
DeleteRequest or
Delete
GrantAccess GrantAccess Action GrantAccessRequest
IsValidStateTransition IsValidStateTransition Function IsValidStateTransitionRequest
ModifyAccess ModifyAccess Action ModifyAccessRequest
Retrieve GET [org URI]/api/data/v9.0/msdyn_playbooktemplates(msdyn_playbooktemplateid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/msdyn_playbooktemplates
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
RetrievePrincipalAccess RetrievePrincipalAccess Function RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccess Function RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess RevokeAccess Action RevokeAccessRequest
SetState PATCH [org URI]/api/data/v9.0/msdyn_playbooktemplates(msdyn_playbooktemplateid)
Update statecode and statuscode properties.
SetStateRequest
Update PATCH [org URI]/api/data/v9.0/msdyn_playbooktemplates(msdyn_playbooktemplateid)
See Update
UpdateRequest or
Update

Entity Properties

Property Value
CollectionSchemaName msdyn_playbooktemplates
DisplayCollectionName Playbook templates
DisplayName Playbook template
EntitySetName msdyn_playbooktemplates
IsBPFEntity False
LogicalCollectionName msdyn_playbooktemplates
LogicalName msdyn_playbooktemplate
OwnershipType UserOwned
PrimaryIdAttribute msdyn_playbooktemplateid
PrimaryNameAttribute msdyn_name
SchemaName msdyn_playbooktemplate

Writable attributes

These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

ImportSequenceNumber

Property Value
Description Sequence number of the import that created this record.
DisplayName Import Sequence Number
Format None
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName importsequencenumber
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

msdyn_categoryid

Property Value
Description Shows the unique ID of the playbook category associated with the playbook template.
DisplayName Category
IsValidForForm True
IsValidForRead True
LogicalName msdyn_categoryid
RequiredLevel SystemRequired
Targets msdyn_playbookcategory
Type Lookup

msdyn_Description

Property Value
Description Type additional information to describe the playbook template.
DisplayName Description
Format Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_description
MaxLength 2000
RequiredLevel None
Type Memo

msdyn_EstimatedDuration

Property Value
Description Enter the estimated duration in days to indicate the time it may take to complete the playbook template once launched.
DisplayName Estimated duration (days)
Format None
IsValidForForm True
IsValidForRead True
LogicalName msdyn_estimatedduration
MaxValue 1000
MinValue 0
RequiredLevel None
Type Integer

msdyn_fullentitylist

Property Value
Description Internal Use Only
DisplayName Entities enabled for playbook
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_fullentitylist
MaxLength 100
RequiredLevel None
Type String

msdyn_name

Property Value
Description Type the name of the playbook template.
DisplayName Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_name
MaxLength 100
RequiredLevel ApplicationRequired
Type String

msdyn_playbooktemplateId

Property Value
Description Shows the unique ID of the playbook template.
DisplayName Playbook template
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName msdyn_playbooktemplateid
RequiredLevel SystemRequired
Type Uniqueidentifier

msdyn_relatedentitylist

Property Value
Description Internal Use Only
DisplayName Entities to which a playbook applies
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_relatedentitylist
MaxLength 1073741823
RequiredLevel None
Type String

msdyn_trackprogress

Property Value
Description Select whether or not to track the progress of the playbook by creating the activities under a playbook which is in turn linked to the record type the playbook applies to.
DisplayName Track progress
IsValidForForm True
IsValidForRead True
LogicalName msdyn_trackprogress
RequiredLevel ApplicationRequired
Type Boolean

msdyn_trackprogress Options

Value Label
1 Yes
0 No

DefaultValue: True

OverriddenCreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time that the record was migrated.
DisplayName Record Created On
Format DateOnly
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName overriddencreatedon
RequiredLevel None
Type DateTime

OwnerId

Added by: Active Solution Solution

Property Value
Description Publisher Id
DisplayName Publisher
IsValidForForm True
IsValidForRead True
LogicalName ownerid
RequiredLevel SystemRequired
Targets systemuser,team
Type Owner

OwnerIdType

Added by: Active Solution Solution

Property Value
Description Owner Id Type
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridtype
RequiredLevel SystemRequired
Type EntityName

statecode

Property Value
Description Status of the Playbook Template
DisplayName Status
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State

statecode Options

Value Label DefaultStatus InvariantName
0 Draft 1 Draft
1 Published 2 Published

statuscode

Property Value
Description Reason for the status of the Playbook Template
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status

statuscode Options

Value Label State
1 Draft 0
2 Published 1

TimeZoneRuleVersionNumber

Property Value
Description For internal use only.
DisplayName Time Zone Rule Version Number
Format None
IsValidForForm False
IsValidForRead True
LogicalName timezoneruleversionnumber
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

UTCConversionTimeZoneCode

Property Value
Description Time zone code that was in use when the record was created.
DisplayName UTC Conversion Time Zone Code
Format None
IsValidForForm False
IsValidForRead True
LogicalName utcconversiontimezonecode
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

Read-only attributes

These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

CreatedBy

Added by: Active Solution Solution

Property Value
Description Unique identifier of the user who created the record.
DisplayName Created By
IsValidForForm True
IsValidForRead True
LogicalName createdby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyname
MaxLength 100
RequiredLevel None
Type String

CreatedByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

CreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the record was created.
DisplayName Created On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime

CreatedOnBehalfBy

Added by: Active Solution Solution

Property Value
Description Unique identifier of the delegate user who created the record.
DisplayName Created By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedOnBehalfByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

CreatedOnBehalfByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

ModifiedBy

Added by: Active Solution Solution

Property Value
Description Unique identifier of the user who modified the record.
DisplayName Modified By
IsValidForForm True
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

ModifiedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the record was modified.
DisplayName Modified On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime

ModifiedOnBehalfBy

Added by: Active Solution Solution

Property Value
Description Unique identifier of the delegate user who modified the record.
DisplayName Modified By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedOnBehalfByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedOnBehalfByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

msdyn_categoryidName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName msdyn_categoryidname
MaxLength 100
RequiredLevel None
Type String

OwnerIdName

Added by: Active Solution Solution

Property Value
Description Name of the owner
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owneridname
MaxLength 100
RequiredLevel SystemRequired
Type String

OwnerIdYomiName

Added by: Active Solution Solution

Property Value
Description Yomi name of the owner
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owneridyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

OwningBusinessUnit

Added by: Active Solution Solution

Property Value
Description Unique identifier for the business unit that owns the record
DisplayName Owning Business Unit
IsValidForForm False
IsValidForRead True
LogicalName owningbusinessunit
RequiredLevel None
Targets businessunit
Type Lookup

OwningTeam

Added by: Active Solution Solution

Property Value
Description Unique identifier for the team that owns the record.
DisplayName Owning Team
IsValidForForm False
IsValidForRead True
LogicalName owningteam
RequiredLevel None
Targets team
Type Lookup

OwningUser

Added by: Active Solution Solution

Property Value
Description Unique identifier for the user that owns the record.
DisplayName Owning User
IsValidForForm False
IsValidForRead True
LogicalName owninguser
RequiredLevel None
Targets systemuser
Type Lookup

VersionNumber

Added by: Active Solution Solution

Property Value
Description Version Number
DisplayName Version Number
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

One-To-Many Relationships

Listed by SchemaName.

msdyn_playbooktemplate_SyncErrors

Added by: System Solution Solution

Same as syncerror entity msdyn_playbooktemplate_SyncErrors Many-To-One relationship.

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName msdyn_playbooktemplate_SyncErrors
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

msdyn_playbooktemplate_DuplicateMatchingRecord

Added by: System Solution Solution

Same as duplicaterecord entity msdyn_playbooktemplate_DuplicateMatchingRecord Many-To-One relationship.

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute duplicaterecordid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName msdyn_playbooktemplate_DuplicateMatchingRecord
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

msdyn_playbooktemplate_DuplicateBaseRecord

Added by: System Solution Solution

Same as duplicaterecord entity msdyn_playbooktemplate_DuplicateBaseRecord Many-To-One relationship.

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute baserecordid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName msdyn_playbooktemplate_DuplicateBaseRecord
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

msdyn_playbooktemplate_AsyncOperations

Added by: System Solution Solution

Same as asyncoperation entity msdyn_playbooktemplate_AsyncOperations Many-To-One relationship.

Property Value
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName msdyn_playbooktemplate_AsyncOperations
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

msdyn_playbooktemplate_MailboxTrackingFolders

Added by: System Solution Solution

Same as mailboxtrackingfolder entity msdyn_playbooktemplate_MailboxTrackingFolders Many-To-One relationship.

Property Value
ReferencingEntity mailboxtrackingfolder
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName msdyn_playbooktemplate_MailboxTrackingFolders
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

msdyn_playbooktemplate_ProcessSession

Added by: System Solution Solution

Same as processsession entity msdyn_playbooktemplate_ProcessSession Many-To-One relationship.

Property Value
ReferencingEntity processsession
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName msdyn_playbooktemplate_ProcessSession
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

msdyn_playbooktemplate_BulkDeleteFailures

Added by: System Solution Solution

Same as bulkdeletefailure entity msdyn_playbooktemplate_BulkDeleteFailures Many-To-One relationship.

Property Value
ReferencingEntity bulkdeletefailure
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName msdyn_playbooktemplate_BulkDeleteFailures
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

msdyn_playbooktemplate_PrincipalObjectAttributeAccesses

Added by: System Solution Solution

Same as principalobjectattributeaccess entity msdyn_playbooktemplate_PrincipalObjectAttributeAccesses Many-To-One relationship.

Property Value
ReferencingEntity principalobjectattributeaccess
ReferencingAttribute objectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName msdyn_playbooktemplate_PrincipalObjectAttributeAccesses
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

msdyn_playbooktemplate_Annotations

Added by: System Solution Solution

Same as annotation entity msdyn_playbooktemplate_Annotations Many-To-One relationship.

Property Value
ReferencingEntity annotation
ReferencingAttribute objectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName msdyn_playbooktemplate_Annotations
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: NoCascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

msdyn_playbooktemplate_msdyn_playbookinstance

Same as msdyn_playbookinstance entity msdyn_playbooktemplate_msdyn_playbookinstance Many-To-One relationship.

Property Value
ReferencingEntity msdyn_playbookinstance
ReferencingAttribute msdyn_playbooktemplateid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName msdyn_playbooktemplate_msdyn_playbookinstance
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order: 10000
CascadeConfiguration Assign: NoCascade
Delete: Restrict
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

msdyn_playbooktemplate_msdyn_playbookactivity

Same as msdyn_playbookactivity entity msdyn_playbooktemplate_msdyn_playbookactivity Many-To-One relationship.

Property Value
ReferencingEntity msdyn_playbookactivity
ReferencingAttribute msdyn_playbooktemplateid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName msdyn_playbooktemplate_msdyn_playbookactivity
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order: 10000
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: NoCascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

Many-To-One Relationships

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName.

lk_msdyn_playbooktemplate_createdby

Added by: System Solution Solution

See systemuser Entity lk_msdyn_playbooktemplate_createdby One-To-Many relationship.

lk_msdyn_playbooktemplate_createdonbehalfby

Added by: System Solution Solution

See systemuser Entity lk_msdyn_playbooktemplate_createdonbehalfby One-To-Many relationship.

lk_msdyn_playbooktemplate_modifiedby

Added by: System Solution Solution

See systemuser Entity lk_msdyn_playbooktemplate_modifiedby One-To-Many relationship.

lk_msdyn_playbooktemplate_modifiedonbehalfby

Added by: System Solution Solution

See systemuser Entity lk_msdyn_playbooktemplate_modifiedonbehalfby One-To-Many relationship.

user_msdyn_playbooktemplate

Added by: System Solution Solution

See systemuser Entity user_msdyn_playbooktemplate One-To-Many relationship.

team_msdyn_playbooktemplate

Added by: System Solution Solution

See team Entity team_msdyn_playbooktemplate One-To-Many relationship.

business_unit_msdyn_playbooktemplate

Added by: System Solution Solution

See businessunit Entity business_unit_msdyn_playbooktemplate One-To-Many relationship.

category_playbooktemplate

See msdyn_playbookcategory Entity category_playbooktemplate One-To-Many relationship.

Many-To-Many Relationships

Relationship details provided where the msdyn_playbooktemplate entity is the first entity in the relationship. Listed by SchemaName.

msdyn_callablecontext_msdyn_playbooktemplate

See msdyn_callablecontext Entity msdyn_callablecontext_msdyn_playbooktemplate Many-To-Many Relationship.

See also

About the Entity Reference
Programming reference for Dynamics 365 Customer Engagement
Web API Reference
Microsoft.Dynamics.CRM.msdyn_playbooktemplate