ProcessTrigger Entity Reference

Applies to Dynamics 365 for Customer Engagement apps version 9.x

Trigger that invoke a rule.

Messages

Message Web API Operation SDK Assembly
Create POST [org URI]/api/data/v9.0/processtriggers
See Create
CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.0/processtriggers(processtriggerid)
See Delete
DeleteRequest or
Delete
Retrieve GET [org URI]/api/data/v9.0/processtriggers(processtriggerid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/processtriggers
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
Update PATCH [org URI]/api/data/v9.0/processtriggers(processtriggerid)
See Update
UpdateRequest or
Update

Entity Properties

Property Value
CollectionSchemaName ProcessTriggers
DisplayCollectionName Process Triggers
DisplayName Process Trigger
EntitySetName processtriggers
IsBPFEntity False
LogicalCollectionName processtriggers
LogicalName processtrigger
OwnershipType None
PrimaryIdAttribute processtriggerid
PrimaryNameAttribute
SchemaName ProcessTrigger

Writable attributes

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

ControlName

Property Value
Description Name of the control.
DisplayName Control Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName controlname
MaxLength 100
RequiredLevel None
Type String

ControlType

Property Value
Description Type of the control to which this trigger is bound
DisplayName Control Type
IsValidForForm False
IsValidForRead True
LogicalName controltype
RequiredLevel None
Type Picklist

ControlType Options

Value Label
1 Attribute
2 Form Tab

Event

Property Value
Description Indicates the event.
DisplayName Event
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName event
MaxLength 100
RequiredLevel SystemRequired
Type String

FormId

Property Value
Description Unique identifier of the form associated with the trigger.
DisplayName Form
IsValidForForm True
IsValidForRead True
LogicalName formid
RequiredLevel None
Targets systemform
Type Lookup

IsCustomizable

Property Value
Description Indicates whether this component can be customized.
DisplayName Customizable
IsValidForForm False
IsValidForRead True
LogicalName iscustomizable
RequiredLevel SystemRequired
Type ManagedProperty

MethodId

Property Value
Description Displays StageID to which the PBL rule belongs to
DisplayName MethodId
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName methodid
RequiredLevel None
Type Uniqueidentifier

PipelineStage

Property Value
Description Pipeline Stage to Execute Workflow Event Plugin.
DisplayName PipelineStage
IsValidForForm False
IsValidForRead True
LogicalName pipelinestage
RequiredLevel SystemRequired
Type Picklist

PipelineStage Options

Value Label
0 Default Value
20 Before Main Operation
40 After Main Operation

PrimaryEntityTypeCode

Property Value
Description Primary entity for the process which is invoked by the event.
DisplayName Primary Entity
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName primaryentitytypecode
RequiredLevel SystemRequired
Type EntityName

ProcessId

Property Value
Description Shows the ID of the process.
DisplayName Process
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName processid
RequiredLevel SystemRequired
Targets workflow
Type Lookup

ProcessTriggerId

Property Value
Description Unique identifier of the process trigger record.
DisplayName Process Trigger
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName processtriggerid
RequiredLevel SystemRequired
Type Uniqueidentifier

Scope

Property Value
Description Scope level for PBL rules.
DisplayName Scope
IsValidForForm False
IsValidForRead True
LogicalName scope
RequiredLevel SystemRequired
Type Picklist

Scope Options

Value Label
1 Form
2 Entity

Read-only attributes

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

ComponentState

Property Value
Description For internal use only.
DisplayName Component State
IsValidForForm False
IsValidForRead True
LogicalName componentstate
RequiredLevel SystemRequired
Type Picklist

ComponentState Options

Value Label
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished

CreatedBy

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

CreatedByName

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

CreatedByYomiName

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

CreatedOn

Property Value
DateTimeBehavior UserLocal
Description Shows the date and time when the record was created. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options.
DisplayName Created On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime

CreatedOnBehalfBy

Property Value
Description Shows who created the record on behalf of another user.
DisplayName Created By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedOnBehalfByName

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

CreatedOnBehalfByYomiName

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

FormIdName

Property Value
Description Name for the Form associated with this trigger.
DisplayName Form Name
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName formidname
MaxLength 200
RequiredLevel None
Type String

IsManaged

Property Value
Description Indicates whether the solution component is part of a managed solution.
DisplayName Is Managed
IsValidForForm False
IsValidForRead True
LogicalName ismanaged
RequiredLevel SystemRequired
Type Boolean

IsManaged Options

Value Label
1 Managed
0 Unmanaged

DefaultValue: False

ModifiedBy

Property Value
Description Shows who last updated the record.
DisplayName Modified By
IsValidForForm True
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedByName

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

ModifiedByYomiName

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

ModifiedOn

Property Value
DateTimeBehavior UserLocal
Description Shows the date and time when the record was last updated. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options.
DisplayName Modified On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime

ModifiedOnBehalfBy

Property Value
Description Shows who last updated the record on behalf of another user.
DisplayName Modified By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedOnBehalfByName

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

ModifiedOnBehalfByYomiName

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

OverwriteTime

Property Value
DateTimeBehavior UserLocal
Description For internal use only.
DisplayName Record Overwrite Time
Format DateOnly
IsValidForForm False
IsValidForRead True
LogicalName overwritetime
RequiredLevel SystemRequired
Type DateTime

OwnerId

Property Value
Description Enter the user or team who is assigned to manage the record. This field is updated every time the record is assigned to a different user.
DisplayName Owner
IsValidForForm False
IsValidForRead True
LogicalName ownerid
RequiredLevel ApplicationRequired
Targets systemuser,team
Type Owner

OwnerIdType

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

OwningBusinessUnit

Property Value
Description Select the business unit that owns the record.
DisplayName Owning Business Unit
IsValidForForm False
IsValidForRead True
LogicalName owningbusinessunit
RequiredLevel ApplicationRequired
Type Uniqueidentifier

OwningUser

Property Value
Description Unique identifier for the user that owns the record.
DisplayName Owning User
IsValidForForm False
IsValidForRead True
LogicalName owninguser
RequiredLevel ApplicationRequired
Type Uniqueidentifier

ProcessIdName

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

ProcessTriggerIdUnique

Property Value
Description For internal use only.
DisplayName Process Id
IsValidForForm False
IsValidForRead True
LogicalName processtriggeridunique
RequiredLevel SystemRequired
Type Uniqueidentifier

SolutionId

Property Value
Description Unique identifier of the associated solution.
DisplayName Solution
IsValidForForm False
IsValidForRead True
LogicalName solutionid
RequiredLevel SystemRequired
Type Uniqueidentifier

SupportingSolutionId

Property Value
Description For internal use only.
DisplayName Solution
IsValidForForm False
IsValidForRead False
LogicalName supportingsolutionid
RequiredLevel None
Type Uniqueidentifier

VersionNumber

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

One-To-Many Relationships

Listed by SchemaName.

ProcessTrigger_SyncErrors

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

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName ProcessTrigger_SyncErrors
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: Cascade
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.

process_processtrigger

See workflow Entity process_processtrigger One-To-Many relationship.

lk_processtriggerbase_createdby

See systemuser Entity lk_processtriggerbase_createdby One-To-Many relationship.

lk_processtriggerbase_createdonbehalfby

See systemuser Entity lk_processtriggerbase_createdonbehalfby One-To-Many relationship.

processtrigger_systemform

See systemform Entity processtrigger_systemform One-To-Many relationship.

lk_processtriggerbase_modifiedonbehalfby

See systemuser Entity lk_processtriggerbase_modifiedonbehalfby One-To-Many relationship.

lk_processtriggerbase_modifiedby

See systemuser Entity lk_processtriggerbase_modifiedby One-To-Many relationship.

See also

About the Entity Reference
Programming reference for Dynamics 365 Customer Engagement
Web API Reference
processtrigger EntityType