Muokkaa

Jaa

Sdk Message (SdkMessage) table/entity reference

  • Artikkeli

Message that is supported by the SDK.

Messages

The following table lists the messages for the Sdk Message (SdkMessage) 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
Retrieve
Event: False		 GET /sdkmessages(sdkmessageid)
See Retrieve		 Retrieve records
RetrieveMultiple
Event: False		 GET /sdkmessages
See Query data		 Query data

Properties

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

Property Value
DisplayName Sdk Message
DisplayCollectionName Sdk Messages
SchemaName SdkMessage
CollectionSchemaName SdkMessages
EntitySetName sdkmessages
LogicalName sdkmessage
LogicalCollectionName sdkmessages
PrimaryIdAttribute sdkmessageid
PrimaryNameAttribute name
TableType Standard
OwnershipType OrganizationOwned

Writable columns/attributes

These columns/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
GlobalChoiceName sdkmessage_autotransact
DefaultValue False
True Label Yes
False Label No

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

CategoryName

Property Value
Description If this is a categorized method, this is the name, otherwise None.
DisplayName Category Name
IsValidForForm False
IsValidForRead True
LogicalName categoryname
RequiredLevel SystemRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 25

ExecutePrivilegeName

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

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
GlobalChoiceName sdkmessage_expand
DefaultValue False
True Label Yes
False Label No

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

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
GlobalChoiceName sdkmessage_isactive
DefaultValue True
True Label Yes
False Label No

IsPrivate

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

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
LogicalName isreadonly
RequiredLevel SystemRequired
Type Boolean
GlobalChoiceName isoperationintentreadonly
DefaultValue False
True Label Yes
False Label No

Name

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

SdkMessageId

Property Value
Description Unique identifier of the SDK message entity.
DisplayName
IsValidForForm False
IsValidForRead True
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
GlobalChoiceName sdkmessage_template
DefaultValue False
True Label Yes
False Label No

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

IsValidForExecuteAsync

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

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
Type Lookup
Targets systemuser

ModifiedOn

Property Value
Description Date and time when the SDK message 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 sdkmessage.
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 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

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
IsValidForForm False
IsValidForRead True
LogicalName throttlesettings
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 512

VersionNumber

Property Value
Description Number that identifies a specific revision of the SDK message.
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 sdkmessage_workflowsdkstepenabled
DefaultValue False
True Label Yes
False Label No

Many-to-One relationships

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

createdby_sdkmessage

One-To-Many Relationship: systemuser createdby_sdkmessage

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_sdkmessage_createdonbehalfby

One-To-Many Relationship: systemuser lk_sdkmessage_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_sdkmessage_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_sdkmessage_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_sdkmessage

One-To-Many Relationship: systemuser modifiedby_sdkmessage

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_sdkmessage

One-To-Many Relationship: organization organization_sdkmessage

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

One-to-Many relationships

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

sdkmessage_customapi

Many-To-One Relationship: customapi sdkmessage_customapi

Property Value
ReferencingEntity customapi
ReferencingAttribute sdkmessageid
ReferencedEntityNavigationPropertyName CustomAPIId
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: UseCollectionName
Group: Details
Label:
MenuId: null
Order: 10000
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

sdkmessage_serviceplanmapping

Many-To-One Relationship: serviceplanmapping sdkmessage_serviceplanmapping

Property Value
ReferencingEntity serviceplanmapping
ReferencingAttribute sdkmessage
ReferencedEntityNavigationPropertyName sdkmessage_serviceplanmapping
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: UseCollectionName
Group: Details
Label:
MenuId: null
Order: 10000
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

sdkmessageid_sdkmessagefilter

Many-To-One Relationship: sdkmessagefilter sdkmessageid_sdkmessagefilter

Property Value
ReferencingEntity sdkmessagefilter
ReferencingAttribute sdkmessageid
ReferencedEntityNavigationPropertyName sdkmessageid_sdkmessagefilter
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

sdkmessageid_sdkmessageprocessingstep

Many-To-One Relationship: sdkmessageprocessingstep sdkmessageid_sdkmessageprocessingstep

Property Value
ReferencingEntity sdkmessageprocessingstep
ReferencingAttribute sdkmessageid
ReferencedEntityNavigationPropertyName sdkmessageid_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
sdkmessage