Edit

Share via

Sdk Message Filter (SdkMessageFilter) table/entity reference (Microsoft Dataverse)

Filter that defines which SDK messages are valid for each type of entity.

Messages

The following table lists the messages for the Sdk Message Filter (SdkMessageFilter) 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
Disassociate
Event: True		 Disassociate records Disassociate records
Retrieve
Event: False		 GET /sdkmessagefilters(sdkmessagefilterid)
See Retrieve		 Retrieve records
RetrieveMultiple
Event: False		 GET /sdkmessagefilters
See Query data		 Query data

Properties

The following table lists selected properties for the Sdk Message Filter (SdkMessageFilter) table.

Property Value
DisplayName Sdk Message Filter
DisplayCollectionName Sdk Message Filters
SchemaName SdkMessageFilter
CollectionSchemaName SdkMessageFilters
EntitySetName sdkmessagefilters
LogicalName sdkmessagefilter
LogicalCollectionName sdkmessagefilters
PrimaryIdAttribute sdkmessagefilterid
PrimaryNameAttribute name
TableType Standard
OwnershipType OrganizationOwned

Writable columns/attributes

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

Availability

Property Value
Description Identifies where a method will be exposed. 0 - Server, 1 - Client, 2 - both.
DisplayName Availability
IsValidForForm False
IsValidForRead True
LogicalName availability
RequiredLevel SystemRequired
Type Integer
MaxValue 2147483647
MinValue -2147483648

IntroducedVersion

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

IsCustomProcessingStepAllowed

Property Value
Description Indicates whether a custom SDK message processing step is allowed.
DisplayName Custom Processing Step Allowed
IsValidForForm True
IsValidForRead True
LogicalName iscustomprocessingstepallowed
RequiredLevel SystemRequired
Type Boolean
GlobalChoiceName sdkmessagefilter_iscustomprocessingstepallowed
DefaultValue False
True Label Yes
False Label No

Name

Property Value
Description Name of the SDK message filter.
DisplayName Name
IsValidForForm True
IsValidForRead True
LogicalName name
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 256

RestrictionLevel

Property Value
Description For internal use only.
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName restrictionlevel
RequiredLevel SystemRequired
Type Integer
MaxValue 255
MinValue 0

SdkMessageFilterId

Property Value
Description Unique identifier of the SDK message filter entity.
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName sdkmessagefilterid
RequiredLevel SystemRequired
Type Uniqueidentifier

SdkMessageId

Property Value
Description Unique identifier of the related SDK message.
DisplayName SDK Message ID
IsValidForForm False
IsValidForRead True
LogicalName sdkmessageid
RequiredLevel SystemRequired
Type Lookup
Targets sdkmessage

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate and 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
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 SDK message filter.
DisplayName Created By
IsValidForForm False
IsValidForRead True
LogicalName createdby
RequiredLevel None
Type Lookup
Targets systemuser

CreatedOn

Property Value
Description Date and time when the SDK message filter was created.
DisplayName Created On
IsValidForForm False
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 sdkmessagefilter.
DisplayName Created By (Delegate)
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Type Lookup
Targets systemuser

CustomizationLevel

Property Value
Description Customization level of the SDK message filter.
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName customizationlevel
RequiredLevel SystemRequired
Type Integer
MaxValue 255
MinValue -255

IsManaged

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

IsVisible

Property Value
Description Indicates whether the filter should be visible.
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName isvisible
RequiredLevel SystemRequired
Type Boolean
GlobalChoiceName sdkmessagefilter_isvisible
DefaultValue False
True Label Yes
False Label No

ModifiedBy

Property Value
Description Unique identifier of the user who last modified the SDK message filter.
DisplayName Modified By
IsValidForForm False
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Type Lookup
Targets systemuser

ModifiedOn

Property Value
Description Date and time when the SDK message filter was last modified.
DisplayName Modified On
IsValidForForm False
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 sdkmessagefilter.
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 SDK message filter 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

PrimaryObjectTypeCode

Property Value
Description Type of entity with which the SDK message filter is primarily associated.
DisplayName Primary Object Type Code
IsValidForForm False
IsValidForRead True
LogicalName primaryobjecttypecode
RequiredLevel SystemRequired
Type EntityName

SdkMessageFilterIdUnique

Property Value
Description Unique identifier of the SDK message filter.
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName sdkmessagefilteridunique
RequiredLevel SystemRequired
Type Uniqueidentifier

SecondaryObjectTypeCode

Property Value
Description Type of entity with which the SDK message filter is secondarily associated.
DisplayName Secondary Object Type Code
IsValidForForm False
IsValidForRead True
LogicalName secondaryobjecttypecode
RequiredLevel SystemRequired
Type EntityName

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
RequiredLevel None
Type BigInt
MaxValue 9223372036854775807
MinValue -9223372036854775808

WorkflowSdkStepEnabled

Property Value
Description Whether or not the SDK message can be called from a workflow.
DisplayName WorkflowSdkStepEnabled
IsValidForForm False
IsValidForRead True
LogicalName workflowsdkstepenabled
RequiredLevel None
Type Boolean
GlobalChoiceName sdkmessagefilter_workflowsdkstepenabled
DefaultValue False
True Label Yes
False Label No

Many-to-One relationships

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

createdby_sdkmessagefilter

One-To-Many Relationship: systemuser createdby_sdkmessagefilter

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_sdkmessagefilter_createdonbehalfby

One-To-Many Relationship: systemuser lk_sdkmessagefilter_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_sdkmessagefilter_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_sdkmessagefilter_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_sdkmessagefilter

One-To-Many Relationship: systemuser modifiedby_sdkmessagefilter

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_sdkmessagefilter

One-To-Many Relationship: organization organization_sdkmessagefilter

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

sdkmessageid_sdkmessagefilter

One-To-Many Relationship: sdkmessage sdkmessageid_sdkmessagefilter

Property Value
ReferencedEntity sdkmessage
ReferencedAttribute sdkmessageid
ReferencingAttribute sdkmessageid
ReferencingEntityNavigationPropertyName sdkmessageid
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: Restrict
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

One-to-Many relationships

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

sdkmessagefilterid_sdkmessageprocessingstep

Many-To-One Relationship: sdkmessageprocessingstep sdkmessagefilterid_sdkmessageprocessingstep

Property Value
ReferencingEntity sdkmessageprocessingstep
ReferencingAttribute sdkmessagefilterid
ReferencedEntityNavigationPropertyName sdkmessagefilterid_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
sdkmessagefilter