SdkMessageFilter table/entity reference
Article 06/04/2024
5 contributors
Feedback
In this article
Filter that defines which SDK messages are valid for each type of entity.
Messages
Properties
Property
Value
CollectionSchemaName
SdkMessageFilters
DisplayCollectionName
Sdk Message Filters
DisplayName
Sdk Message Filter
EntitySetName
sdkmessagefilters
IsBPFEntity
False
LogicalCollectionName
sdkmessagefilters
LogicalName
sdkmessagefilter
OwnershipType
OrganizationOwned
PrimaryIdAttribute
sdkmessagefilterid
PrimaryNameAttribute
name
SchemaName
SdkMessageFilter
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
Format
None
IsValidForForm
False
IsValidForRead
True
LogicalName
availability
MaxValue
2147483647
MinValue
-2147483648
RequiredLevel
SystemRequired
Type
Integer
IntroducedVersion
Property
Value
Description
Version in which the component is introduced.
DisplayName
Introduced Version
FormatName
VersionNumber
IsLocalizable
False
IsValidForForm
False
IsValidForRead
True
IsValidForUpdate
False
LogicalName
introducedversion
MaxLength
48
RequiredLevel
None
Type
String
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
IsCustomProcessingStepAllowed Choices/Options
Value
Label
Description
1
Yes
0
No
DefaultValue : 0
Name
Added by : API messages extension solution Solution
Property
Value
Description
Name of the SDK message filter.
DisplayName
Name
FormatName
Text
IsLocalizable
False
IsValidForForm
True
IsValidForRead
True
LogicalName
name
MaxLength
256
RequiredLevel
None
Type
String
RestrictionLevel
Property
Value
Description
For internal use only.
DisplayName
Format
None
IsValidForForm
False
IsValidForRead
True
IsValidForUpdate
False
LogicalName
restrictionlevel
MaxValue
255
MinValue
0
RequiredLevel
SystemRequired
Type
Integer
SdkMessageFilterId
Property
Value
Description
Unique identifier of the SDK message filter entity.
DisplayName
IsValidForForm
False
IsValidForRead
True
IsValidForUpdate
False
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
IsValidForUpdate
False
LogicalName
sdkmessageid
RequiredLevel
SystemRequired
Targets
sdkmessage
Type
Lookup
Read-only columns/attributes
These columns/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 SDK message filter.
DisplayName
Created By
IsValidForForm
False
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 SDK message filter was created.
DisplayName
Created On
Format
DateAndTime
IsValidForForm
False
IsValidForRead
True
LogicalName
createdon
RequiredLevel
None
Type
DateTime
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
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 of the SDK message filter.
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
IsVisible
Property
Value
Description
Indicates whether the filter should be visible.
DisplayName
IsValidForForm
False
IsValidForRead
True
LogicalName
isvisible
RequiredLevel
SystemRequired
Type
Boolean
IsVisible Choices/Options
Value
Label
Description
1
Yes
0
No
DefaultValue : 0
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
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 SDK message filter was last modified.
DisplayName
Modified On
Format
DateAndTime
IsValidForForm
False
IsValidForRead
True
LogicalName
modifiedon
RequiredLevel
None
Type
DateTime
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
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 SDK message filter 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
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
SdkMessageIdName
Property
Value
Description
DisplayName
FormatName
Text
IsLocalizable
False
IsValidForForm
False
IsValidForRead
True
LogicalName
sdkmessageidname
MaxLength
100
RequiredLevel
None
Type
String
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
MaxValue
9223372036854775807
MinValue
-9223372036854775808
RequiredLevel
None
Type
BigInt
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
WorkflowSdkStepEnabled Choices/Options
Value
Label
Description
1
Yes
0
No
DefaultValue : 0
One-To-Many Relationships
Listed by SchemaName .
sdkmessagefilterid_sdkmessageprocessingstep
Same as the sdkmessagefilterid_sdkmessageprocessingstep many-to-one relationship for the sdkmessageprocessingstep table/entity.
Property
Value
ReferencingEntity
sdkmessageprocessingstep
ReferencingAttribute
sdkmessagefilterid
IsHierarchical
False
IsCustomizable
False
ReferencedEntityNavigationPropertyName
sdkmessagefilterid_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 table. Listed by SchemaName .
createdby_sdkmessagefilter
See the createdby_sdkmessagefilter one-to-many relationship for the systemuser table/entity.
modifiedby_sdkmessagefilter
See the modifiedby_sdkmessagefilter one-to-many relationship for the systemuser table/entity.
sdkmessageid_sdkmessagefilter
See the sdkmessageid_sdkmessagefilter one-to-many relationship for the sdkmessage table/entity.
lk_sdkmessagefilter_createdonbehalfby
See the lk_sdkmessagefilter_createdonbehalfby one-to-many relationship for the systemuser table/entity.
organization_sdkmessagefilter
See the organization_sdkmessagefilter one-to-many relationship for the organization table/entity.
lk_sdkmessagefilter_modifiedonbehalfby
See the lk_sdkmessagefilter_modifiedonbehalfby one-to-many relationship for the systemuser table/entity.
See also
Dataverse table/entity reference
Web API Reference
sdkmessagefilter EntityType