Edit

Share via

Plug-in Type (PluginType) table/entity reference (Microsoft Dataverse)

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

Messages

The following table lists the messages for the Plug-in Type (PluginType) table. Messages represent operations that can be performed on the table. They may also be events.

Name
Is Event?		 Web API Operation SDK for .NET
Associate
Event: True		 Associate records Associate records
Create
Event: False		 POST /plugintypes
See Create		 Create records
Delete
Event: False		 DELETE /plugintypes(plugintypeid)
See Delete		 Delete records
Disassociate
Event: True		 Disassociate records Disassociate records
Retrieve
Event: False		 GET /plugintypes(plugintypeid)
See Retrieve		 Retrieve records
RetrieveMultiple
Event: False		 GET /plugintypes
See Query data		 Query data
Update
Event: False		 PATCH /plugintypes(plugintypeid)
See Update		 Update records
Upsert
Event: False		 PATCH /plugintypes(plugintypeid)
See Upsert a table row		 UpsertRequest

Properties

The following table lists selected properties for the Plug-in Type (PluginType) table.

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

Writable columns/attributes

These columns/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
IsValidForForm True
IsValidForRead True
LogicalName description
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 256

FriendlyName

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

Name

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

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
Type Lookup
Targets pluginassembly

PluginTypeExportKey

Property Value
Description Uniquely identifies the plug-in type associated with a plugin package when exporting a solution.
DisplayName Plugin Type export key
IsValidForForm False
IsValidForRead True
LogicalName plugintypeexportkey
RequiredLevel SystemRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 256

PluginTypeId

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

TypeName

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

WorkflowActivityGroupName

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

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate and IsValidForUpdate. Listed by SchemaName.

AssemblyName

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

ComponentState

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

ComponentState Choices/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
Type Lookup
Targets systemuser

CreatedOn

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

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
Type Lookup
Targets systemuser

Culture

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

CustomizationLevel

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

CustomWorkflowActivityInfo

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

IsManaged

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName ismanaged
RequiredLevel SystemRequired
Type Boolean
GlobalChoiceName ismanaged
DefaultValue False
True Label Managed
False Label Unmanaged

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
GlobalChoiceName plugintype_isworkflowactivity
DefaultValue False
True Label Yes
False Label No

Major

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

Minor

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

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
Type Lookup
Targets systemuser

ModifiedOn

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

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
Type Lookup
Targets systemuser

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
Type Lookup
Targets organization

OverwriteTime

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

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
IsValidForForm True
IsValidForRead True
LogicalName publickeytoken
RequiredLevel ApplicationRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 32

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
IsValidForForm True
IsValidForRead True
LogicalName version
RequiredLevel ApplicationRequired
Type String
Format VersionNumber
FormatName VersionNumber
ImeMode Auto
IsLocalizable False
MaxLength 48

VersionNumber

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

Many-to-One relationships

These relationships are many-to-one. Listed by SchemaName.

createdby_plugintype

One-To-Many Relationship: systemuser createdby_plugintype

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute createdby
ReferencingEntityNavigationPropertyName createdby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_plugintype_createdonbehalfby

One-To-Many Relationship: systemuser lk_plugintype_createdonbehalfby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute createdonbehalfby
ReferencingEntityNavigationPropertyName createdonbehalfby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_plugintype_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_plugintype_modifiedonbehalfby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute modifiedonbehalfby
ReferencingEntityNavigationPropertyName modifiedonbehalfby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

modifiedby_plugintype

One-To-Many Relationship: systemuser modifiedby_plugintype

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute modifiedby
ReferencingEntityNavigationPropertyName modifiedby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

organization_plugintype

One-To-Many Relationship: organization organization_plugintype

Property Value
ReferencedEntity organization
ReferencedAttribute organizationid
ReferencingAttribute organizationid
ReferencingEntityNavigationPropertyName organizationid
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

pluginassembly_plugintype

One-To-Many Relationship: pluginassembly pluginassembly_plugintype

Property Value
ReferencedEntity pluginassembly
ReferencedAttribute pluginassemblyid
ReferencingAttribute pluginassemblyid
ReferencingEntityNavigationPropertyName pluginassemblyid
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

One-to-Many relationships

These relationships are one-to-many. Listed by SchemaName.

plugintype_customapi

Many-To-One Relationship: customapi plugintype_customapi

Property Value
ReferencingEntity customapi
ReferencingAttribute plugintypeid
ReferencedEntityNavigationPropertyName CustomAPIId
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: UseCollectionName
Group: Details
Label:
MenuId: null
Order: 10000
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

plugintype_plugintypestatistic

Many-To-One Relationship: plugintypestatistic plugintype_plugintypestatistic

Property Value
ReferencingEntity plugintypestatistic
ReferencingAttribute plugintypeid
ReferencedEntityNavigationPropertyName plugintype_plugintypestatistic
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

plugintype_sdkmessageprocessingstep

Many-To-One Relationship: sdkmessageprocessingstep plugintype_sdkmessageprocessingstep

Property Value
ReferencingEntity sdkmessageprocessingstep
ReferencingAttribute eventhandler
ReferencedEntityNavigationPropertyName plugintype_sdkmessageprocessingstep
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

plugintypeid_sdkmessageprocessingstep

Many-To-One Relationship: sdkmessageprocessingstep plugintypeid_sdkmessageprocessingstep

Property Value
ReferencingEntity sdkmessageprocessingstep
ReferencingAttribute plugintypeid
ReferencedEntityNavigationPropertyName plugintypeid_sdkmessageprocessingstep
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

See also

Dataverse table/entity reference
Dataverse Web API Reference
plugintype

  • Last updated on