title
description
ms.date
ms.topic
ms.assetid
author
ms.author
search.audienceType
SdkMessage entity reference (Dynamics 365 Customer Engagement) | Microsoft Docs
Includes schema information and supported messages for the SdkMessage entity.
08/30/2022
reference
3948cc48-07c8-7f60-0608-71c37158ad7c
KumarVivek
matp
SdkMessage entity reference
Message that is supported by the SDK.
Message
SDK class or method
Retrieve
xref:Microsoft.Xrm.Sdk.Messages.RetrieveRequest or xref:Microsoft.Xrm.Sdk.IOrganizationService.Retrieve*
RetrieveMultiple
xref:Microsoft.Xrm.Sdk.Messages.RetrieveMultipleRequest or xref:Microsoft.Xrm.Sdk.IOrganizationService.RetrieveMultiple*
Property
Value
CollectionSchemaName
SdkMessages
DisplayCollectionName
Sdk Messages
DisplayName
Sdk Message
EntitySetName
sdkmessages
IsBPFEntity
False
LogicalCollectionName
sdkmessages
LogicalName
sdkmessage
OwnershipType
OrganizationOwned
PrimaryIdAttribute
sdkmessageid
PrimaryNameAttribute
name
SchemaName
SdkMessage
These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName .
Property
Value
Description
Information about whether the SDK message is automatically transacted.
DisplayName
Auto Transact
IsValidForForm
False
IsValidForRead
True
LogicalName
autotransact
RequiredLevel
None
Type
Boolean
AutoTransact Choices/Options
Value
Label
Description
1
Yes
0
No
DefaultValue : 0
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
Property
Value
Description
If this is a categorized method, this is the name, otherwise None.
DisplayName
Category Name
FormatName
Text
IsLocalizable
False
IsValidForForm
False
IsValidForRead
True
LogicalName
categoryname
MaxLength
25
RequiredLevel
SystemRequired
Type
String
Property
Value
Description
Indicates whether the SDK message should have its requests expanded per primary entity defined in its filters.
DisplayName
Expand
IsValidForForm
False
IsValidForRead
True
LogicalName
expand
RequiredLevel
None
Type
Boolean
Value
Label
Description
1
Yes
0
No
DefaultValue : 0
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
Property
Value
Description
Information about whether the SDK message is active.
DisplayName
Is Active
IsValidForForm
False
IsValidForRead
True
LogicalName
isactive
RequiredLevel
None
Type
Boolean
Value
Label
Description
1
Yes
0
No
DefaultValue : 1
Property
Value
Description
Indicates whether the SDK message is private.
DisplayName
Is Private
IsValidForForm
False
IsValidForRead
True
LogicalName
isprivate
RequiredLevel
None
Type
Boolean
IsPrivate Choices/Options
Value
Label
Description
1
Yes
0
No
DefaultValue : 0
Property
Value
Description
Identifies whether an SDK message will be ReadOnly or Read Write. false - ReadWrite, true - ReadOnly .
DisplayName
Intent
IsValidForForm
False
IsValidForRead
True
IsValidForUpdate
False
LogicalName
isreadonly
RequiredLevel
SystemRequired
Type
Boolean
IsReadOnly Choices/Options
Value
Label
Description
1
Yes
0
No
DefaultValue : 0
Property
Value
Description
Name of the SDK message.
DisplayName
Name
FormatName
Text
IsLocalizable
False
IsValidForForm
False
IsValidForRead
True
LogicalName
name
MaxLength
256
RequiredLevel
SystemRequired
Type
String
Property
Value
Description
Unique identifier of the SDK message entity.
DisplayName
IsValidForForm
False
IsValidForRead
True
IsValidForUpdate
False
LogicalName
sdkmessageid
RequiredLevel
SystemRequired
Type
Uniqueidentifier
Property
Value
Description
Indicates whether the SDK message is a template.
DisplayName
Template
IsValidForForm
False
IsValidForRead
True
LogicalName
template
RequiredLevel
None
Type
Boolean
Value
Label
Description
1
Yes
0
No
DefaultValue : 0
These attributes return false for both IsValidForCreate or IsValidForUpdate . Listed by SchemaName .
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
Property
Value
Description
Unique identifier of the user who created the SDK message.
DisplayName
Created By
IsValidForForm
False
IsValidForRead
True
LogicalName
createdby
RequiredLevel
None
Targets
systemuser
Type
Lookup
Property
Value
Description
DisplayName
FormatName
Text
IsLocalizable
False
IsValidForForm
False
IsValidForRead
True
LogicalName
createdbyname
MaxLength
100
RequiredLevel
None
Type
String
Property
Value
DateTimeBehavior
UserLocal
Description
Date and time when the SDK message was created.
DisplayName
Created On
Format
DateAndTime
IsValidForForm
False
IsValidForRead
True
LogicalName
createdon
RequiredLevel
None
Type
DateTime
Property
Value
Description
Unique identifier of the delegate user who created the sdkmessage.
DisplayName
Created By (Delegate)
IsValidForForm
False
IsValidForRead
True
LogicalName
createdonbehalfby
RequiredLevel
None
Targets
systemuser
Type
Lookup
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
Property
Value
Description
Customization level of the SDK message.
DisplayName
Format
None
IsValidForForm
False
IsValidForRead
True
LogicalName
customizationlevel
MaxValue
255
MinValue
-255
RequiredLevel
SystemRequired
Type
Integer
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
Property
Value
Description
For internal use only.
DisplayName
Is Valid for Execute Async
IsValidForForm
False
IsValidForRead
True
LogicalName
isvalidforexecuteasync
RequiredLevel
None
Type
Boolean
IsValidForExecuteAsync Choices/Options
Value
Label
Description
1
Yes
0
No
DefaultValue : 0
Property
Value
Description
Unique identifier of the user who last modified the SDK message.
DisplayName
Modified By
IsValidForForm
False
IsValidForRead
True
LogicalName
modifiedby
RequiredLevel
None
Targets
systemuser
Type
Lookup
Property
Value
Description
DisplayName
FormatName
Text
IsLocalizable
False
IsValidForForm
False
IsValidForRead
True
LogicalName
modifiedbyname
MaxLength
100
RequiredLevel
None
Type
String
Property
Value
DateTimeBehavior
UserLocal
Description
Date and time when the SDK message was last modified.
DisplayName
Modified On
Format
DateAndTime
IsValidForForm
False
IsValidForRead
True
LogicalName
modifiedon
RequiredLevel
None
Type
DateTime
Property
Value
Description
Unique identifier of the delegate user who last modified the sdkmessage.
DisplayName
Modified By (Delegate)
IsValidForForm
False
IsValidForRead
True
LogicalName
modifiedonbehalfby
RequiredLevel
None
Targets
systemuser
Type
Lookup
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
Property
Value
Description
Unique identifier of the organization with which the SDK message is associated.
DisplayName
IsValidForForm
False
IsValidForRead
True
LogicalName
organizationid
RequiredLevel
SystemRequired
Targets
organization
Type
Lookup
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
Property
Value
Description
Unique identifier of the SDK message.
DisplayName
IsValidForForm
False
IsValidForRead
True
LogicalName
sdkmessageidunique
RequiredLevel
SystemRequired
Type
Uniqueidentifier
Property
Value
Description
Unique identifier of the associated solution.
DisplayName
Solution
IsValidForForm
False
IsValidForRead
True
LogicalName
solutionid
RequiredLevel
SystemRequired
Type
Uniqueidentifier
Property
Value
Description
For internal use only.
DisplayName
Solution
IsValidForForm
False
IsValidForRead
False
LogicalName
supportingsolutionid
RequiredLevel
None
Type
Uniqueidentifier
Property
Value
Description
For internal use only.
DisplayName
Throttle Settings
FormatName
Text
IsLocalizable
False
IsValidForForm
False
IsValidForRead
True
LogicalName
throttlesettings
MaxLength
512
RequiredLevel
None
Type
String
Property
Value
Description
Number that identifies a specific revision of the SDK message.
DisplayName
IsValidForForm
False
IsValidForRead
True
LogicalName
versionnumber
MaxValue
9223372036854775807
MinValue
-9223372036854775808
RequiredLevel
None
Type
BigInt
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 .
sdkmessageid_sdkmessageprocessingstep
Same as the sdkmessageid_sdkmessageprocessingstep many-to-one relationship for the sdkmessageprocessingstep entity.
Property
Value
ReferencingEntity
sdkmessageprocessingstep
ReferencingAttribute
sdkmessageid
IsHierarchical
False
IsCustomizable
False
ReferencedEntityNavigationPropertyName
sdkmessageid_sdkmessageprocessingstep
AssociatedMenuConfiguration
Behavior: DoNotDisplay Group: Details Label: Order:
CascadeConfiguration
Assign: NoCascade Delete: Restrict Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade
sdkmessageid_sdkmessagefilter
Same as the sdkmessageid_sdkmessagefilter many-to-one relationship for the sdkmessagefilter entity.
Property
Value
ReferencingEntity
sdkmessagefilter
ReferencingAttribute
sdkmessageid
IsHierarchical
False
IsCustomizable
False
ReferencedEntityNavigationPropertyName
sdkmessageid_sdkmessagefilter
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 entity. Listed by SchemaName .
lk_sdkmessage_modifiedonbehalfby
See the lk_sdkmessage_modifiedonbehalfby one-to-many relationship for the systemuser entity.
See the createdby_sdkmessage one-to-many relationship for the systemuser entity.
lk_sdkmessage_createdonbehalfby
See the lk_sdkmessage_createdonbehalfby one-to-many relationship for the systemuser entity.
See the organization_sdkmessage one-to-many relationship for the organization entity.
See the modifiedby_sdkmessage one-to-many relationship for the systemuser entity.
About the Entity Reference
Web API EntityType Reference