SdkMessage entity reference

Note

Effective Nov 2020, Common Data Service has been renamed to Microsoft Dataverse.

Message that is supported by the SDK.

Messages

Message Web API Operation SDK Assembly
Retrieve GET [org URI]/api/data/v9.0/sdkmessages(sdkmessageid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/sdkmessages
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple

Entity properties

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

Writable attributes

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

AutoTransact

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 Options

Value Label
1 Yes
0 No

DefaultValue: False

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

CategoryName

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

ExecutePrivilegeName

Added by: API messages extension solution Solution

Property Value
Description Name of the privilege that allows execution of the SDK message
DisplayName Execute Privilege Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName executeprivilegename
MaxLength 100
RequiredLevel None
Type String

Expand

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

Expand Options

Value Label
1 Yes
0 No

DefaultValue: False

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

IsActive

Property Value
Description Information about whether the SDK message is active.
DisplayName Is Active
IsValidForForm False
IsValidForRead True
LogicalName isactive
RequiredLevel None
Type Boolean

IsActive Options

Value Label
1 Yes
0 No

DefaultValue: True

IsPrivate

Property Value
Description Indicates whether the SDK message is private.
DisplayName Is Private
IsValidForForm False
IsValidForRead True
LogicalName isprivate
RequiredLevel None
Type Boolean

IsPrivate Options

Value Label
1 Yes
0 No

DefaultValue: False

IsReadOnly

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 Options

Value Label
1 Yes
0 No

DefaultValue: False

Name

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

SdkMessageId

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

Template

Property Value
Description Indicates whether the SDK message is a template.
DisplayName Template
IsValidForForm False
IsValidForRead True
LogicalName template
RequiredLevel None
Type Boolean

Template Options

Value Label
1 Yes
0 No

DefaultValue: False

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 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.
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 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 sdkmessage.
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.
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 Options

Value Label
1 Managed
0 Unmanaged

DefaultValue: False

IsValidForExecuteAsync

Property Value
Description For internal use only.
DisplayName Is Valid for Execute Async
IsValidForForm False
IsValidForRead True
LogicalName isvalidforexecuteasync
RequiredLevel None
Type Boolean

IsValidForExecuteAsync Options

Value Label
1 Yes
0 No

DefaultValue: False

ModifiedBy

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

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 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 sdkmessage.
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 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

SdkMessageIdUnique

Property Value
Description Unique identifier of the SDK message.
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName sdkmessageidunique
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

ThrottleSettings

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

VersionNumber

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

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 Options

Value Label
1 Yes
0 No

DefaultValue: False

One-To-Many Relationships

Listed by SchemaName.

sdkmessageid_sdkmessageprocessingstep

Same as sdkmessageprocessingstep entity sdkmessageid_sdkmessageprocessingstep Many-To-One relationship.

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 sdkmessagefilter entity sdkmessageid_sdkmessagefilter Many-To-One relationship.

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

sdkmessage_customapi

Added by: Custom API Framework Solution

Same as customapi entity sdkmessage_customapi Many-To-One relationship.

Property Value
ReferencingEntity customapi
ReferencingAttribute sdkmessageid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName CustomAPIId
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 10000
CascadeConfiguration Assign: NoCascade
Delete: RemoveLink
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 systemuser Entity lk_sdkmessage_modifiedonbehalfby One-To-Many relationship.

createdby_sdkmessage

See systemuser Entity createdby_sdkmessage One-To-Many relationship.

lk_sdkmessage_createdonbehalfby

See systemuser Entity lk_sdkmessage_createdonbehalfby One-To-Many relationship.

organization_sdkmessage

See organization Entity organization_sdkmessage One-To-Many relationship.

modifiedby_sdkmessage

See systemuser Entity modifiedby_sdkmessage One-To-Many relationship.

See also

About entity reference
Web API reference
sdkmessage EntityType

Note

Can you tell us about your documentation language preferences? Take a short survey.

The survey will take about seven minutes. No personal data is collected (privacy statement).