SdkMessageProcessingStepImage table/entity reference

Note

Unsure about table vs. entity? See Developers: Understand terminology in Microsoft Dataverse.

Copy of an entity's attributes before or after the core system operation.

Messages

Message	Web API Operation	SDK class or method
Create	POST /sdkmessageprocessingstepimages See Create	CreateRequest or Create
Delete	DELETE /sdkmessageprocessingstepimages(sdkmessageprocessingstepimageid) See Delete	DeleteRequest or Delete
Retrieve	GET /sdkmessageprocessingstepimages(sdkmessageprocessingstepimageid) See Retrieve	RetrieveRequest or Retrieve
RetrieveMultiple	GET /sdkmessageprocessingstepimages See Query Data	RetrieveMultipleRequest or RetrieveMultiple
Update	PATCH /sdkmessageprocessingstepimages(sdkmessageprocessingstepimageid) See Update	UpdateRequest or Update

Properties

Property	Value
CollectionSchemaName	SdkMessageProcessingStepImages
DisplayCollectionName	Sdk Message Processing Step Images
DisplayName	Sdk Message Processing Step Image
EntitySetName	sdkmessageprocessingstepimages
IsBPFEntity	False
LogicalCollectionName	sdkmessageprocessingstepimages
LogicalName	sdkmessageprocessingstepimage
OwnershipType	OrganizationOwned
PrimaryIdAttribute	sdkmessageprocessingstepimageid
PrimaryNameAttribute	name
SchemaName	SdkMessageProcessingStepImage

Writable columns/attributes

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

• Attributes
• Description
• EntityAlias
• ImageType
• IntroducedVersion
• IsCustomizable
• MessagePropertyName
• Name
• RelatedAttributeName
• SdkMessageProcessingStepId
• SdkMessageProcessingStepImageId

Attributes

Property	Value
Description	Comma-separated list of attributes that are to be passed into the SDK message processing step image.
DisplayName	Attributes
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	attributes
MaxLength	100000
RequiredLevel	None
Type	String

Description

Property	Value
Description	Description of the SDK message processing step image.
DisplayName	Description
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	description
MaxLength	256
RequiredLevel	None
Type	String

EntityAlias

Property	Value
Description	Key name used to access the pre-image or post-image property bags in a step.
DisplayName	Entity Alias
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	entityalias
MaxLength	256
RequiredLevel	SystemRequired
Type	String

ImageType

Property	Value
Description	Type of image requested.
DisplayName	Image Type
IsValidForForm	False
IsValidForRead	True
LogicalName	imagetype
RequiredLevel	SystemRequired
Type	Picklist

ImageType Choices/Options

Value	Label	Description
0	PreImage
1	PostImage
2	Both

IntroducedVersion

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

IsCustomizable

Property	Value
Description	Information that specifies whether this component can be customized.
DisplayName	Customizable
IsValidForForm	False
IsValidForRead	True
LogicalName	iscustomizable
RequiredLevel	SystemRequired
Type	ManagedProperty

MessagePropertyName

Property	Value
Description	Name of the property on the Request message.
DisplayName	Message Property Name
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	messagepropertyname
MaxLength	256
RequiredLevel	SystemRequired
Type	String

Name

Property	Value
Description	Name of SdkMessage processing step image.
DisplayName	Name
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	name
MaxLength	256
RequiredLevel	SystemRequired
Type	String

RelatedAttributeName

Property	Value
Description	Name of the related entity.
DisplayName	Related Attribute Name
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	relatedattributename
MaxLength	256
RequiredLevel	None
Type	String

SdkMessageProcessingStepId

Property	Value
Description	Unique identifier of the SDK message processing step.
DisplayName	SDK Message Processing Step
IsValidForForm	False
IsValidForRead	True
LogicalName	sdkmessageprocessingstepid
RequiredLevel	None
Targets	sdkmessageprocessingstep
Type	Lookup

SdkMessageProcessingStepImageId

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

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

• ComponentState
• CreatedBy
• CreatedByName
• CreatedOn
• CreatedOnBehalfBy
• CreatedOnBehalfByName
• CreatedOnBehalfByYomiName
• CustomizationLevel
• IsManaged
• ModifiedBy
• ModifiedByName
• ModifiedOn
• ModifiedOnBehalfBy
• ModifiedOnBehalfByName
• ModifiedOnBehalfByYomiName
• OrganizationId
• OverwriteTime
• SdkMessageProcessingStepImageIdUnique
• SolutionId
• SupportingSolutionId
• VersionNumber

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 processing step image.
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 processing step image 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 sdkmessageprocessingstepimage.
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 processing step image.
DisplayName
Format	None
IsValidForForm	False
IsValidForRead	True
LogicalName	customizationlevel
MaxValue	255
MinValue	-255
RequiredLevel	SystemRequired
Type	Integer

IsManaged

Property	Value
Description
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	ismanaged
RequiredLevel	SystemRequired
Type	Boolean

IsManaged Choices/Options

Value	Label	Description
1	Managed
0	Unmanaged

DefaultValue: 0

ModifiedBy

Property	Value
Description	Unique identifier of the user who last modified the SDK message processing step.
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 processing step was last modified.
DisplayName	Modified By
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 sdkmessageprocessingstepimage.
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 processing step 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

SdkMessageProcessingStepImageIdUnique

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

VersionNumber

Property	Value
Description	Number that identifies a specific revision of the step image.
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	versionnumber
MaxValue	9223372036854775807
MinValue	-9223372036854775808
RequiredLevel	None
Type	BigInt

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.

• lk_sdkmessageprocessingstepimage_createdonbehalfby
• lk_sdkmessageprocessingstepimage_modifiedonbehalfby
• sdkmessageprocessingstepid_sdkmessageprocessingstepimage
• createdby_sdkmessageprocessingstepimage
• organization_sdkmessageprocessingstepimage
• modifiedby_sdkmessageprocessingstepimage

lk_sdkmessageprocessingstepimage_createdonbehalfby

See the lk_sdkmessageprocessingstepimage_createdonbehalfby one-to-many relationship for the systemuser table/entity.

lk_sdkmessageprocessingstepimage_modifiedonbehalfby

See the lk_sdkmessageprocessingstepimage_modifiedonbehalfby one-to-many relationship for the systemuser table/entity.

sdkmessageprocessingstepid_sdkmessageprocessingstepimage

See the sdkmessageprocessingstepid_sdkmessageprocessingstepimage one-to-many relationship for the sdkmessageprocessingstep table/entity.

createdby_sdkmessageprocessingstepimage

See the createdby_sdkmessageprocessingstepimage one-to-many relationship for the systemuser table/entity.

organization_sdkmessageprocessingstepimage

See the organization_sdkmessageprocessingstepimage one-to-many relationship for the organization table/entity.

modifiedby_sdkmessageprocessingstepimage

See the modifiedby_sdkmessageprocessingstepimage one-to-many relationship for the systemuser table/entity.

See also

Dataverse table/entity reference
Web API Reference
sdkmessageprocessingstepimage EntityType