PluginType Entity Reference

Type that inherits from the IPlugin interface and is contained within a plug-in assembly.

Messages

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

Entity Properties

Property Value
CollectionSchemaName PluginTypes
DisplayCollectionName Plug-in Types
DisplayName Plug-in Type
EntitySetName plugintypes
IsBPFEntity False
LogicalCollectionName plugintypes
LogicalName plugintype
OwnershipType OrganizationOwned
PrimaryIdAttribute plugintypeid
PrimaryNameAttribute name
SchemaName PluginType

Writable attributes

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

Description

Property Value
Description Description of the plug-in type.
DisplayName Description
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName description
MaxLength 256
RequiredLevel None
Type String

FriendlyName

Property Value
Description User friendly name for the plug-in.
DisplayName Display Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName friendlyname
MaxLength 256
RequiredLevel SystemRequired
Type String

Name

Property Value
Description Name of the plug-in type.
DisplayName Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName name
MaxLength 256
RequiredLevel None
Type String

PluginAssemblyId

Property Value
Description Unique identifier of the plug-in assembly that contains this plug-in type.
DisplayName Plugin Assembly
IsValidForForm True
IsValidForRead True
LogicalName pluginassemblyid
RequiredLevel None
Targets pluginassembly
Type Lookup

PluginTypeId

Property Value
Description Unique identifier of the plug-in type.
DisplayName Plug-in Type
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName plugintypeid
RequiredLevel SystemRequired
Type Uniqueidentifier

TypeName

Property Value
Description Fully qualified type name of the plug-in type.
DisplayName Type Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName typename
MaxLength 256
RequiredLevel SystemRequired
Type String

WorkflowActivityGroupName

Property Value
Description Group name of workflow custom activity.
DisplayName Workflow Activity Group Name
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName workflowactivitygroupname
MaxLength 256
RequiredLevel None
Type String

Read-only attributes

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

AssemblyName

Property Value
Description Full path name of the plug-in assembly.
DisplayName Assembly Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName assemblyname
MaxLength 100
RequiredLevel ApplicationRequired
Type String

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 Unique identifier of the user who created the plug-in type.
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

CreatedOn

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

CreatedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who created the plugintype.
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

Culture

Property Value
Description Culture code for the plug-in assembly.
DisplayName Culture
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName culture
MaxLength 32
RequiredLevel ApplicationRequired
Type String

CustomizationLevel

Property Value
Description Customization level of the plug-in type.
DisplayName
Format None
IsValidForForm False
IsValidForRead True
LogicalName customizationlevel
MaxValue 255
MinValue -255
RequiredLevel SystemRequired
Type Integer

CustomWorkflowActivityInfo

Property Value
Description Serialized Custom Activity Type information, including required arguments. For more information, see SandboxCustomActivityInfo.
DisplayName Custom Workflow Activity Info
Format TextArea
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName customworkflowactivityinfo
MaxLength 1048576
RequiredLevel None
Type Memo

IsManaged

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName ismanaged
RequiredLevel SystemRequired
Type Boolean

IsManaged Options

Value Label
1 Managed
0 Unmanaged

DefaultValue: False

IsWorkflowActivity

Property Value
Description Indicates if the plug-in is a custom activity for workflows.
DisplayName Is Workflow Activity
IsValidForForm True
IsValidForRead True
LogicalName isworkflowactivity
RequiredLevel None
Type Boolean

IsWorkflowActivity Options

Value Label
1 Yes
0 No

DefaultValue: False

Major

Property Value
Description Major of the version number of the assembly for the plug-in type.
DisplayName Version major
Format None
IsValidForForm False
IsValidForRead True
LogicalName major
MaxValue 65534
MinValue 0
RequiredLevel SystemRequired
Type Integer

Minor

Property Value
Description Minor of the version number of the assembly for the plug-in type.
DisplayName Version minor
Format None
IsValidForForm False
IsValidForRead True
LogicalName minor
MaxValue 65534
MinValue 0
RequiredLevel SystemRequired
Type Integer

ModifiedBy

Property Value
Description Unique identifier of the user who last modified the plug-in type.
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

ModifiedOn

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

ModifiedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who last modified the plugintype.
DisplayName Modified By (Delegate)
IsValidForForm False
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

OrganizationId

Property Value
Description Unique identifier of the organization with which the plug-in type is associated.
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName organizationid
RequiredLevel SystemRequired
Targets organization
Type Lookup

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

PluginAssemblyIdName

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

PluginTypeIdUnique

Property Value
Description Unique identifier of the plug-in type.
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName plugintypeidunique
RequiredLevel SystemRequired
Type Uniqueidentifier

PublicKeyToken

Property Value
Description Public key token of the assembly for the plug-in type.
DisplayName Public Key Token
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName publickeytoken
MaxLength 32
RequiredLevel ApplicationRequired
Type String

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

Version

Property Value
Description Version number of the assembly for the plug-in type.
DisplayName Version
FormatName VersionNumber
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName version
MaxLength 48
RequiredLevel ApplicationRequired
Type String

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.

plugin_type_service

Added by: Service Solution

Same as service entity plugin_type_service Many-To-One relationship.

Property Value
ReferencingEntity service
ReferencingAttribute strategyid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName plugin_type_service
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Restrict
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

plugintype_sdkmessageprocessingstep

Same as sdkmessageprocessingstep entity plugintype_sdkmessageprocessingstep Many-To-One relationship.

Property Value
ReferencingEntity sdkmessageprocessingstep
ReferencingAttribute eventhandler
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName plugintype_sdkmessageprocessingstep
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

plugintype_plugintypestatistic

Same as plugintypestatistic entity plugintype_plugintypestatistic Many-To-One relationship.

Property Value
ReferencingEntity plugintypestatistic
ReferencingAttribute plugintypeid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName plugintype_plugintypestatistic
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

plugintypeid_sdkmessageprocessingstep

Same as sdkmessageprocessingstep entity plugintypeid_sdkmessageprocessingstep Many-To-One relationship.

Property Value
ReferencingEntity sdkmessageprocessingstep
ReferencingAttribute plugintypeid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName plugintypeid_sdkmessageprocessingstep
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Restrict
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

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.

pluginassembly_plugintype

See pluginassembly Entity pluginassembly_plugintype One-To-Many relationship.

lk_plugintype_createdonbehalfby

See systemuser Entity lk_plugintype_createdonbehalfby One-To-Many relationship.

organization_plugintype

See organization Entity organization_plugintype One-To-Many relationship.

modifiedby_plugintype

See systemuser Entity modifiedby_plugintype One-To-Many relationship.

createdby_plugintype

See systemuser Entity createdby_plugintype One-To-Many relationship.

lk_plugintype_modifiedonbehalfby

See systemuser Entity lk_plugintype_modifiedonbehalfby One-To-Many relationship.

See also

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