Sdk Message Processing Step Image (SdkMessageProcessingStepImage) table/entity reference

Article
08/31/2024

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

Messages

The following table lists the messages for the Sdk Message Processing Step Image (SdkMessageProcessingStepImage) 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
`Create` Event: False	`POST` /sdkmessageprocessingstepimages See Create	Create records
`Delete` Event: False	`DELETE` /sdkmessageprocessingstepimages(sdkmessageprocessingstepimageid) See Delete	Delete records
`Retrieve` Event: False	`GET` /sdkmessageprocessingstepimages(sdkmessageprocessingstepimageid) See Retrieve	Retrieve records
`RetrieveMultiple` Event: False	`GET` /sdkmessageprocessingstepimages See Query data	Query data
`Update` Event: False	`PATCH` /sdkmessageprocessingstepimages(sdkmessageprocessingstepimageid) See Update	Update records
`Upsert` Event: False	`PATCH` /sdkmessageprocessingstepimages(sdkmessageprocessingstepimageid) See Upsert a table row	UpsertRequest

Properties

The following table lists selected properties for the Sdk Message Processing Step Image (SdkMessageProcessingStepImage) table.

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

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

Description

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

EntityAlias

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

ImageType

Property	Value
Description	Type of image requested.
DisplayName	Image Type
IsValidForForm	False
IsValidForRead	True
LogicalName	`imagetype`
RequiredLevel	SystemRequired
Type	Picklist
DefaultFormValue	0
GlobalChoiceName	`sdkmessageprocessingstepimage_imagetype`

ImageType Choices/Options

Value	Label
0	PreImage
1	PostImage
2	Both

IntroducedVersion

Property	Value
Description	Version in which the form 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

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
IsValidForForm	False
IsValidForRead	True
LogicalName	`messagepropertyname`
RequiredLevel	SystemRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	256

Name

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

RelatedAttributeName

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

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

SdkMessageProcessingStepImageId

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

Read-only columns/attributes

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

ComponentState
CreatedBy
CreatedOn
CreatedOnBehalfBy
CustomizationLevel
IsManaged
ModifiedBy
ModifiedOn
ModifiedOnBehalfBy
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
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 processing step image.
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 processing step image 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 sdkmessageprocessingstepimage.
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 processing step image.
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	`customizationlevel`
RequiredLevel	SystemRequired
Type	Integer
MaxValue	255
MinValue	-255

IsManaged

Property	Value
Description
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	`ismanaged`
RequiredLevel	SystemRequired
Type	Boolean
GlobalChoiceName	`ismanaged`
DefaultValue	False
True Label	Managed
False Label	Unmanaged

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

ModifiedOn

Property	Value
Description	Date and time when the SDK message processing step was last modified.
DisplayName	Modified By
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 sdkmessageprocessingstepimage.
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 processing step 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

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`
RequiredLevel	None
Type	BigInt
MaxValue	9223372036854775807
MinValue	-9223372036854775808

Many-to-One relationships

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

createdby_sdkmessageprocessingstepimage
lk_sdkmessageprocessingstepimage_createdonbehalfby
lk_sdkmessageprocessingstepimage_modifiedonbehalfby
modifiedby_sdkmessageprocessingstepimage
organization_sdkmessageprocessingstepimage
sdkmessageprocessingstepid_sdkmessageprocessingstepimage

createdby_sdkmessageprocessingstepimage

One-To-Many Relationship: systemuser createdby_sdkmessageprocessingstepimage

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_sdkmessageprocessingstepimage_createdonbehalfby

One-To-Many Relationship: systemuser lk_sdkmessageprocessingstepimage_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_sdkmessageprocessingstepimage_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_sdkmessageprocessingstepimage_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_sdkmessageprocessingstepimage

One-To-Many Relationship: systemuser modifiedby_sdkmessageprocessingstepimage

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_sdkmessageprocessingstepimage

One-To-Many Relationship: organization organization_sdkmessageprocessingstepimage

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`

sdkmessageprocessingstepid_sdkmessageprocessingstepimage

One-To-Many Relationship: sdkmessageprocessingstep sdkmessageprocessingstepid_sdkmessageprocessingstepimage

Property	Value
ReferencedEntity	`sdkmessageprocessingstep`
ReferencedAttribute	`sdkmessageprocessingstepid`
ReferencingAttribute	`sdkmessageprocessingstepid`
ReferencingEntityNavigationPropertyName	`sdkmessageprocessingstepid`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `Cascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

Share via