Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Messages
The following table lists the messages for the Plug-in (plugin) 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 |
---|---|---|
Assign Event: True |
PATCH /plugins(pluginid)Update the ownerid property. |
AssignRequest |
Associate Event: True |
Associate records | Associate records |
Create Event: True |
POST /pluginsSee Create |
Create records |
CreateMultiple Event: True |
CreateMultiple | CreateMultipleRequest |
Delete Event: True |
DELETE /plugins(pluginid)See Delete |
Delete records |
Disassociate Event: True |
Disassociate records | Disassociate records |
GrantAccess Event: True |
GrantAccess | GrantAccessRequest |
IsValidStateTransition Event: False |
IsValidStateTransition | IsValidStateTransitionRequest |
ModifyAccess Event: True |
ModifyAccess | ModifyAccessRequest |
Retrieve Event: True |
GET /plugins(pluginid)See Retrieve |
Retrieve records |
RetrieveMultiple Event: True |
GET /pluginsSee Query data |
Query data |
RetrievePrincipalAccess Event: True |
RetrievePrincipalAccess | RetrievePrincipalAccessRequest |
RetrieveSharedPrincipalsAndAccess Event: True |
RetrieveSharedPrincipalsAndAccess | RetrieveSharedPrincipalsAndAccessRequest |
RevokeAccess Event: True |
RevokeAccess | RevokeAccessRequest |
SetState Event: True |
PATCH /plugins(pluginid)Update the statecode and statuscode properties. |
SetStateRequest |
Update Event: True |
PATCH /plugins(pluginid)See Update |
Update records |
UpdateMultiple Event: True |
UpdateMultiple | UpdateMultipleRequest |
Upsert Event: False |
PATCH /plugins(pluginid)See Upsert a table row |
UpsertRequest |
UpsertMultiple Event: False |
UpsertMultiple | UpsertMultipleRequest |
Properties
The following table lists selected properties for the Plug-in (plugin) table.
Property | Value |
---|---|
DisplayName | Plug-in |
DisplayCollectionName | Plug-ins |
SchemaName | plugin |
CollectionSchemaName | plugins |
EntitySetName | plugins |
LogicalName | plugin |
LogicalCollectionName | plugins |
PrimaryIdAttribute | pluginid |
PrimaryNameAttribute | name |
TableType | Standard |
OwnershipType | UserOwned |
Writable columns/attributes
These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
- CustomAPI
- ImportSequenceNumber
- IsCustomizable
- Language
- name
- OverriddenCreatedOn
- OwnerId
- OwnerIdType
- pluginId
- SdkMessageProcessingStep
- statecode
- statuscode
- TimeZoneRuleVersionNumber
- TriggerType
- UTCConversionTimeZoneCode
CustomAPI
Property | Value |
---|---|
Description | |
DisplayName | CustomAPI |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | customapi |
RequiredLevel | None |
Type | Lookup |
Targets | customapi |
ImportSequenceNumber
Property | Value |
---|---|
Description | Sequence number of the import that created this record. |
DisplayName | Import Sequence Number |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | importsequencenumber |
RequiredLevel | None |
Type | Integer |
MaxValue | 2147483647 |
MinValue | -2147483648 |
IsCustomizable
Property | Value |
---|---|
Description | For internal use only. |
DisplayName | Is Customizable |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | iscustomizable |
RequiredLevel | SystemRequired |
Type | ManagedProperty |
Language
Property | Value |
---|---|
Description | |
DisplayName | Language |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | language |
RequiredLevel | ApplicationRequired |
Type | Picklist |
DefaultFormValue | -1 |
GlobalChoiceName | plugin_language |
Language Choices/Options
Value | Label |
---|---|
100000000 | PoweFx |
100000001 | C# |
name
Property | Value |
---|---|
Description | The name of the custom entity. |
DisplayName | Name |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | name |
RequiredLevel | ApplicationRequired |
Type | String |
Format | Text |
FormatName | Text |
ImeMode | Auto |
IsLocalizable | False |
MaxLength | 100 |
OverriddenCreatedOn
Property | Value |
---|---|
Description | Date and time that the record was migrated. |
DisplayName | Record Created On |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | overriddencreatedon |
RequiredLevel | None |
Type | DateTime |
CanChangeDateTimeBehavior | False |
DateTimeBehavior | UserLocal |
Format | DateOnly |
ImeMode | Inactive |
SourceTypeMask | 0 |
OwnerId
Property | Value |
---|---|
Description | Owner Id |
DisplayName | Owner |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | ownerid |
RequiredLevel | SystemRequired |
Type | Owner |
Targets | systemuser, team |
OwnerIdType
Property | Value |
---|---|
Description | Owner Id Type |
DisplayName | |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | owneridtype |
RequiredLevel | SystemRequired |
Type | EntityName |
pluginId
Property | Value |
---|---|
Description | Unique identifier for entity instances |
DisplayName | Plug-in |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | pluginid |
RequiredLevel | SystemRequired |
Type | Uniqueidentifier |
SdkMessageProcessingStep
Property | Value |
---|---|
Description | |
DisplayName | SdkMessageProcessingStep |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | sdkmessageprocessingstep |
RequiredLevel | None |
Type | Lookup |
Targets | sdkmessageprocessingstep |
statecode
Property | Value |
---|---|
Description | Status of the Plug-in |
DisplayName | Status |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | statecode |
RequiredLevel | SystemRequired |
Type | State |
DefaultFormValue | |
GlobalChoiceName | plugin_statecode |
statecode Choices/Options
Value | Details |
---|---|
0 | Label: Active DefaultStatus: 1 InvariantName: Active |
1 | Label: Inactive DefaultStatus: 2 InvariantName: Inactive |
statuscode
Property | Value |
---|---|
Description | Reason for the status of the Plug-in |
DisplayName | Status Reason |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | statuscode |
RequiredLevel | None |
Type | Status |
DefaultFormValue | |
GlobalChoiceName | plugin_statuscode |
statuscode Choices/Options
Value | Details |
---|---|
1 | Label: Active State:0 TransitionData: None |
2 | Label: Inactive State:1 TransitionData: None |
TimeZoneRuleVersionNumber
Property | Value |
---|---|
Description | For internal use only. |
DisplayName | Time Zone Rule Version Number |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | timezoneruleversionnumber |
RequiredLevel | None |
Type | Integer |
MaxValue | 2147483647 |
MinValue | -1 |
TriggerType
Property | Value |
---|---|
Description | |
DisplayName | TriggerType |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | triggertype |
RequiredLevel | ApplicationRequired |
Type | Picklist |
DefaultFormValue | -1 |
GlobalChoiceName | plugin_triggertype |
TriggerType Choices/Options
Value | Label |
---|---|
100000000 | Instant |
100000001 | Automated |
UTCConversionTimeZoneCode
Property | Value |
---|---|
Description | Time zone code that was in use when the record was created. |
DisplayName | UTC Conversion Time Zone Code |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | utcconversiontimezonecode |
RequiredLevel | None |
Type | Integer |
MaxValue | 2147483647 |
MinValue | -1 |
Read-only columns/attributes
These columns/attributes return false for both IsValidForCreate and IsValidForUpdate. Listed by SchemaName.
- ComponentIdUnique
- ComponentState
- CreatedBy
- CreatedOn
- CreatedOnBehalfBy
- IsManaged
- ModifiedBy
- ModifiedOn
- ModifiedOnBehalfBy
- OverwriteTime
- OwnerIdName
- OwnerIdYomiName
- OwningBusinessUnit
- OwningTeam
- OwningUser
- SolutionId
- SupportingSolutionId
- VersionNumber
ComponentIdUnique
Property | Value |
---|---|
Description | For internal use only. |
DisplayName | Row id unique |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | componentidunique |
RequiredLevel | SystemRequired |
Type | Uniqueidentifier |
ComponentState
Property | Value |
---|---|
Description | For internal use only. |
DisplayName | Component State |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | componentstate |
RequiredLevel | SystemRequired |
Type | Picklist |
DefaultFormValue | |
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 record. |
DisplayName | Created By |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | createdby |
RequiredLevel | None |
Type | Lookup |
Targets | systemuser |
CreatedOn
Property | Value |
---|---|
Description | Date and time when the record 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 record. |
DisplayName | Created By (Delegate) |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | createdonbehalfby |
RequiredLevel | None |
Type | Lookup |
Targets | systemuser |
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 |
GlobalChoiceName | ismanaged |
DefaultValue | False |
True Label | Managed |
False Label | Unmanaged |
ModifiedBy
Property | Value |
---|---|
Description | Unique identifier of the user who modified the record. |
DisplayName | Modified By |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | modifiedby |
RequiredLevel | None |
Type | Lookup |
Targets | systemuser |
ModifiedOn
Property | Value |
---|---|
Description | Date and time when the record was 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 modified the record. |
DisplayName | Modified By (Delegate) |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | modifiedonbehalfby |
RequiredLevel | None |
Type | Lookup |
Targets | systemuser |
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 | DateAndTime |
ImeMode | Inactive |
SourceTypeMask | 0 |
OwnerIdName
Property | Value |
---|---|
Description | Name of the owner |
DisplayName | |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | owneridname |
RequiredLevel | SystemRequired |
Type | String |
Format | Text |
FormatName | Text |
ImeMode | Auto |
IsLocalizable | False |
MaxLength | 100 |
OwnerIdYomiName
Property | Value |
---|---|
Description | Yomi name of the owner |
DisplayName | |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | owneridyominame |
RequiredLevel | SystemRequired |
Type | String |
Format | Text |
FormatName | Text |
ImeMode | Auto |
IsLocalizable | False |
MaxLength | 100 |
OwningBusinessUnit
Property | Value |
---|---|
Description | Unique identifier for the business unit that owns the record |
DisplayName | Owning Business Unit |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | owningbusinessunit |
RequiredLevel | SystemRequired |
Type | Lookup |
Targets | businessunit |
OwningTeam
Property | Value |
---|---|
Description | Unique identifier for the team that owns the record. |
DisplayName | Owning Team |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | owningteam |
RequiredLevel | None |
Type | Lookup |
Targets | team |
OwningUser
Property | Value |
---|---|
Description | Unique identifier for the user that owns the record. |
DisplayName | Owning User |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | owninguser |
RequiredLevel | None |
Type | Lookup |
Targets | systemuser |
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 | Version Number |
DisplayName | Version Number |
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.
- business_unit_plugin
- customapi_plugin_CustomAPI
- lk_plugin_createdby
- lk_plugin_createdonbehalfby
- lk_plugin_modifiedby
- lk_plugin_modifiedonbehalfby
- owner_plugin
- sdkmessageprocessingstep_plugin_SdkMessageProcessingStep
- team_plugin
- user_plugin
business_unit_plugin
One-To-Many Relationship: businessunit business_unit_plugin
Property | Value |
---|---|
ReferencedEntity | businessunit |
ReferencedAttribute | businessunitid |
ReferencingAttribute | owningbusinessunit |
ReferencingEntityNavigationPropertyName | owningbusinessunit |
IsHierarchical | |
CascadeConfiguration | Archive: Restrict Assign: NoCascade Delete: Restrict Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade |
customapi_plugin_CustomAPI
One-To-Many Relationship: customapi customapi_plugin_CustomAPI
Property | Value |
---|---|
ReferencedEntity | customapi |
ReferencedAttribute | customapiid |
ReferencingAttribute | customapi |
ReferencingEntityNavigationPropertyName | CustomAPI |
IsHierarchical | |
CascadeConfiguration | Archive: RemoveLink Assign: NoCascade Delete: RemoveLink Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade |
lk_plugin_createdby
One-To-Many Relationship: systemuser lk_plugin_createdby
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_plugin_createdonbehalfby
One-To-Many Relationship: systemuser lk_plugin_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_plugin_modifiedby
One-To-Many Relationship: systemuser lk_plugin_modifiedby
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 |
lk_plugin_modifiedonbehalfby
One-To-Many Relationship: systemuser lk_plugin_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 |
owner_plugin
One-To-Many Relationship: owner owner_plugin
Property | Value |
---|---|
ReferencedEntity | owner |
ReferencedAttribute | ownerid |
ReferencingAttribute | ownerid |
ReferencingEntityNavigationPropertyName | ownerid |
IsHierarchical | |
CascadeConfiguration | Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade |
sdkmessageprocessingstep_plugin_SdkMessageProcessingStep
One-To-Many Relationship: sdkmessageprocessingstep sdkmessageprocessingstep_plugin_SdkMessageProcessingStep
Property | Value |
---|---|
ReferencedEntity | sdkmessageprocessingstep |
ReferencedAttribute | sdkmessageprocessingstepid |
ReferencingAttribute | sdkmessageprocessingstep |
ReferencingEntityNavigationPropertyName | SdkMessageProcessingStep |
IsHierarchical | |
CascadeConfiguration | Archive: RemoveLink Assign: NoCascade Delete: RemoveLink Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade |
team_plugin
One-To-Many Relationship: team team_plugin
Property | Value |
---|---|
ReferencedEntity | team |
ReferencedAttribute | teamid |
ReferencingAttribute | owningteam |
ReferencingEntityNavigationPropertyName | owningteam |
IsHierarchical | |
CascadeConfiguration | Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade |
user_plugin
One-To-Many Relationship: systemuser user_plugin
Property | Value |
---|---|
ReferencedEntity | systemuser |
ReferencedAttribute | systemuserid |
ReferencingAttribute | owninguser |
ReferencingEntityNavigationPropertyName | owninguser |
IsHierarchical | |
CascadeConfiguration | Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade |
One-to-Many relationships
These relationships are one-to-many. Listed by SchemaName.
- plugin_AsyncOperations
- plugin_BulkDeleteFailures
- plugin_MailboxTrackingFolders
- plugin_PrincipalObjectAttributeAccesses
- plugin_ProcessSession
- plugin_SyncErrors
plugin_AsyncOperations
Many-To-One Relationship: asyncoperation plugin_AsyncOperations
Property | Value |
---|---|
ReferencingEntity | asyncoperation |
ReferencingAttribute | regardingobjectid |
ReferencedEntityNavigationPropertyName | plugin_AsyncOperations |
IsCustomizable | True |
AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
plugin_BulkDeleteFailures
Many-To-One Relationship: bulkdeletefailure plugin_BulkDeleteFailures
Property | Value |
---|---|
ReferencingEntity | bulkdeletefailure |
ReferencingAttribute | regardingobjectid |
ReferencedEntityNavigationPropertyName | plugin_BulkDeleteFailures |
IsCustomizable | True |
AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
plugin_MailboxTrackingFolders
Many-To-One Relationship: mailboxtrackingfolder plugin_MailboxTrackingFolders
Property | Value |
---|---|
ReferencingEntity | mailboxtrackingfolder |
ReferencingAttribute | regardingobjectid |
ReferencedEntityNavigationPropertyName | plugin_MailboxTrackingFolders |
IsCustomizable | True |
AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
plugin_PrincipalObjectAttributeAccesses
Many-To-One Relationship: principalobjectattributeaccess plugin_PrincipalObjectAttributeAccesses
Property | Value |
---|---|
ReferencingEntity | principalobjectattributeaccess |
ReferencingAttribute | objectid |
ReferencedEntityNavigationPropertyName | plugin_PrincipalObjectAttributeAccesses |
IsCustomizable | True |
AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
plugin_ProcessSession
Many-To-One Relationship: processsession plugin_ProcessSession
Property | Value |
---|---|
ReferencingEntity | processsession |
ReferencingAttribute | regardingobjectid |
ReferencedEntityNavigationPropertyName | plugin_ProcessSession |
IsCustomizable | True |
AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
plugin_SyncErrors
Many-To-One Relationship: syncerror plugin_SyncErrors
Property | Value |
---|---|
ReferencingEntity | syncerror |
ReferencingAttribute | regardingobjectid |
ReferencedEntityNavigationPropertyName | plugin_SyncErrors |
IsCustomizable | True |
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
plugin