Plug-in Assembly (PluginAssembly) entity reference

Assembly that contains one or more plug-in types.

Messages

Message SDK class or method
Create CreateRequest or
Create
Delete DeleteRequest or
Delete
Retrieve RetrieveRequest or
Retrieve
RetrieveMultiple RetrieveMultipleRequest or
RetrieveMultiple
Update UpdateRequest or
Update

Properties

Property Value
CollectionSchemaName PluginAssemblies
DisplayCollectionName Plug-in Assemblies
DisplayName Plug-in Assembly
EntitySetName pluginassemblies
IsBPFEntity False
LogicalCollectionName pluginassemblies
LogicalName pluginassembly
OwnershipType OrganizationOwned
PrimaryIdAttribute pluginassemblyid
PrimaryNameAttribute name
SchemaName PluginAssembly

Writable attributes

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

AuthType

Property Value
Description Specifies mode of authentication with web sources like WebApp
DisplayName Specifies mode of authentication with web sources
IsValidForForm True
IsValidForRead True
LogicalName authtype
RequiredLevel None
Type Picklist

AuthType Choices/Options

Value Label Description
0 BasicAuth

Content

Property Value
Description Bytes of the assembly, in Base64 format.
DisplayName
FormatName TextArea
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName content
MaxLength 1073741823
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 SystemRequired
Type String

Description

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

IntroducedVersion

Property Value
Description Version in which the form is introduced.
DisplayName Introduced Version
FormatName VersionNumber
IsLocalizable False
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName introducedversion
MaxLength 48
RequiredLevel None
Type String

IsCustomizable

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

IsHidden

Property Value
Description Information that specifies whether this component should be hidden.
DisplayName Hidden
IsValidForForm False
IsValidForRead True
LogicalName ishidden
RequiredLevel SystemRequired
Type ManagedProperty

IsolationMode

Property Value
Description Information about how the plugin assembly is to be isolated at execution time; None / Sandboxed.
DisplayName Isolation Mode
IsValidForForm False
IsValidForRead True
LogicalName isolationmode
RequiredLevel SystemRequired
Type Picklist

IsolationMode Choices/Options

Value Label Description
1 None
2 Sandbox
3 External

Name

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

Password

Property Value
Description User Password
DisplayName User Password
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead False
LogicalName password
MaxLength 256
RequiredLevel None
Type String

Path

Property Value
Description File name of the plug-in assembly. Used when the source type is set to 1.
DisplayName Path
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName path
MaxLength 256
RequiredLevel None
Type String

PluginAssemblyId

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

PublicKeyToken

Property Value
Description Public key token of the assembly. This value can be obtained from the assembly by using reflection.
DisplayName Public Key Token
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName publickeytoken
MaxLength 32
RequiredLevel SystemRequired
Type String

SourceHash

Property Value
Description Hash of the source of the assembly.
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName sourcehash
MaxLength 256
RequiredLevel None
Type String

SourceType

Property Value
Description Location of the assembly, for example 0=database, 1=on-disk.
DisplayName Source Type
IsValidForForm True
IsValidForRead True
LogicalName sourcetype
RequiredLevel SystemRequired
Type Picklist

SourceType Choices/Options

Value Label Description
0 Database
1 Disk
2 Normal
3 AzureWebApp

Url

Property Value
Description Web Url
DisplayName Web Url
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName url
MaxLength 2000
RequiredLevel None
Type String

UserName

Property Value
Description User Name
DisplayName User Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName username
MaxLength 256
RequiredLevel None
Type String

Version

Property Value
Description Version number of the assembly. The value can be obtained from the assembly through reflection.
DisplayName Version
FormatName VersionNumber
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName version
MaxLength 48
RequiredLevel SystemRequired
Type String

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 Choices/Options

Value Label Description
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished

CreatedBy

Property Value
Description Unique identifier of the user who created the plug-in assembly.
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 assembly 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 pluginassembly.
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

CustomizationLevel

Property Value
Description Customization Level.
DisplayName
Format None
IsValidForForm False
IsValidForRead True
LogicalName customizationlevel
MaxValue 255
MinValue -255
RequiredLevel SystemRequired
Type Integer

IsManaged

Property Value
Description Information that specifies whether this component is managed.
DisplayName State
IsValidForForm False
IsValidForRead True
LogicalName ismanaged
RequiredLevel SystemRequired
Type Boolean

IsManaged Choices/Options

Value Label Description
1 Managed
0 Unmanaged

DefaultValue: 0

IsPasswordSet

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName ispasswordset
RequiredLevel None
Type Boolean

IsPasswordSet Choices/Options

Value Label Description
1 Yes
0 No

DefaultValue: 0

Major

Property Value
Description Major of the assembly version.
DisplayName
Format None
IsValidForForm False
IsValidForRead True
LogicalName major
MaxValue 65534
MinValue 0
RequiredLevel SystemRequired
Type Integer

Minor

Property Value
Description Minor of the assembly version.
DisplayName
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 assembly.
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 assembly 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 pluginassembly.
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

OrganizationId

Property Value
Description Unique identifier of the organization with which the plug-in assembly 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

PluginAssemblyIdUnique

Property Value
Description Unique identifier of the plug-in assembly.
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName pluginassemblyidunique
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.

pluginassembly_plugintype

Same as the pluginassembly_plugintype many-to-one relationship for the plugintype entity.

Property Value
ReferencingEntity plugintype
ReferencingAttribute pluginassemblyid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName pluginassembly_plugintype
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
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.

modifiedby_pluginassembly

See the modifiedby_pluginassembly one-to-many relationship for the systemuser entity.

createdby_pluginassembly

See the createdby_pluginassembly one-to-many relationship for the systemuser entity.

organization_pluginassembly

See the organization_pluginassembly one-to-many relationship for the organization entity.

lk_pluginassembly_modifiedonbehalfby

See the lk_pluginassembly_modifiedonbehalfby one-to-many relationship for the systemuser entity.

lk_pluginassembly_createdonbehalfby

See the lk_pluginassembly_createdonbehalfby one-to-many relationship for the systemuser entity.

See also

About the Entity Reference
Web API EntityType Reference