Suggested Action (sa_SuggestedAction) table/entity reference (Microsoft Dataverse)

2025-10-31

This table contains records of suggested actions with execution details.

Messages

The following table lists the messages for the Suggested Action (sa_SuggestedAction) 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
`Associate` Event: True	Associate records	Associate records
`Create` Event: True	`POST` /sa_suggestedactions See Create	Create records
`CreateMultiple` Event: True	CreateMultiple	CreateMultipleRequest
`Delete` Event: True	`DELETE` /sa_suggestedactions(sa_suggestedactionid) See Delete	Delete records
`Disassociate` Event: True	Disassociate records	Disassociate records
`IsValidStateTransition` Event: False	IsValidStateTransition	IsValidStateTransitionRequest
`Retrieve` Event: True	`GET` /sa_suggestedactions(sa_suggestedactionid) See Retrieve	Retrieve records
`RetrieveMultiple` Event: True	`GET` /sa_suggestedactions See Query data	Query data
`SetState` Event: True	`PATCH` /sa_suggestedactions(sa_suggestedactionid) Update the `statecode` and `statuscode` properties.	SetStateRequest
`Update` Event: True	`PATCH` /sa_suggestedactions(sa_suggestedactionid) See Update	Update records
`UpdateMultiple` Event: True	UpdateMultiple	UpdateMultipleRequest
`Upsert` Event: False	`PATCH` /sa_suggestedactions(sa_suggestedactionid) See Upsert a table row	UpsertRequest
`UpsertMultiple` Event: False	UpsertMultiple	UpsertMultipleRequest

Events

The following table lists the events for the Suggested Action (sa_SuggestedAction) table. Events are messages that exist so that you can subscribe to them. Unless you added the event, you shouldn't invoke the message, only subscribe to it.

Name	Web API Operation	SDK for .NET
`BulkRetain`	BulkRetain	Learn to use messages with the SDK for .NET
`PurgeRetainedContent`	PurgeRetainedContent	Learn to use messages with the SDK for .NET
`Retain`	Retain	Learn to use messages with the SDK for .NET
`RollbackRetain`	RollbackRetain	Learn to use messages with the SDK for .NET
`ValidateRetentionConfig`	ValidateRetentionConfig	Learn to use messages with the SDK for .NET

Properties

The following table lists selected properties for the Suggested Action (sa_SuggestedAction) table.

Property	Value
DisplayName	Suggested Action
DisplayCollectionName	Suggested Actions
SchemaName	`sa_SuggestedAction`
CollectionSchemaName	`sa_SuggestedActions`
EntitySetName	`sa_suggestedactions`
LogicalName	`sa_suggestedaction`
LogicalCollectionName	`sa_suggestedactions`
PrimaryIdAttribute	`sa_suggestedactionid`
PrimaryNameAttribute	`sa_actiontitle`
TableType	`Standard`
OwnershipType	`OrganizationOwned`

Writable columns/attributes

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

CreatedBy
CreatedOn
CreatedOnBehalfBy
ImportSequenceNumber
ModifiedBy
ModifiedOn
ModifiedOnBehalfBy
OrganizationId
OverriddenCreatedOn
sa_ActionExecutionSteps
sa_ActionTitle
sa_AppId
sa_CompletedBy
sa_CompletedOn
sa_CriteriaId
sa_GeneratorTag
sa_MakerActionName
sa_Rationale
sa_RowID
sa_SuggestedActionId
sa_TableID
statecode
statuscode
TimeZoneRuleVersionNumber
UTCConversionTimeZoneCode

CreatedBy

Property	Value
Description	Unique identifier of the user who created the record.
DisplayName	Created By
IsValidForForm	True
IsValidForRead	True
LogicalName	`createdby`
RequiredLevel	None
Type	Lookup
Targets	systemuser

CreatedOn

Property	Value
Description	Date and time when the record was created.
DisplayName	Created On
IsValidForForm	True
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 record.
DisplayName	Created By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	`createdonbehalfby`
RequiredLevel	None
Type	Lookup
Targets	systemuser

ImportSequenceNumber

Property	Value
Description	Sequence number of the import that created this record.
DisplayName	Import Sequence Number
IsValidForForm	False
IsValidForRead	True
LogicalName	`importsequencenumber`
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	-2147483648

ModifiedBy

Property	Value
Description	Unique identifier of the user who modified the record.
DisplayName	Modified By
IsValidForForm	True
IsValidForRead	True
LogicalName	`modifiedby`
RequiredLevel	None
Type	Lookup
Targets	systemuser

ModifiedOn

Property	Value
Description	Date and time when the record was modified.
DisplayName	Modified On
IsValidForForm	True
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 modified the record.
DisplayName	Modified By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	`modifiedonbehalfby`
RequiredLevel	None
Type	Lookup
Targets	systemuser

OrganizationId

Property	Value
Description	Unique identifier for the organization
DisplayName	Organization Id
IsValidForForm	False
IsValidForRead	True
LogicalName	`organizationid`
RequiredLevel	None
Type	Lookup
Targets	organization

OverriddenCreatedOn

Property	Value
Description	Date and time that the record was migrated.
DisplayName	Record Created On
IsValidForForm	False
IsValidForRead	True
LogicalName	`overriddencreatedon`
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateOnly
ImeMode	Inactive
SourceTypeMask	0

sa_ActionExecutionSteps

Property	Value
Description
DisplayName	Action Execution Steps
IsValidForForm	True
IsValidForRead	True
LogicalName	`sa_actionexecutionsteps`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	1024

sa_ActionTitle

Property	Value
Description
DisplayName	Action Title
IsValidForForm	True
IsValidForRead	True
LogicalName	`sa_actiontitle`
RequiredLevel	ApplicationRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	128

sa_AppId

Property	Value
Description
DisplayName	App Id
IsValidForForm	True
IsValidForRead	True
LogicalName	`sa_appid`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

sa_CompletedBy

Property	Value
Description
DisplayName	Completed By
IsValidForForm	True
IsValidForRead	True
LogicalName	`sa_completedby`
RequiredLevel	None
Type	Lookup
Targets	systemuser

sa_CompletedOn

Property	Value
Description
DisplayName	Completed On
IsValidForForm	True
IsValidForRead	True
LogicalName	`sa_completedon`
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	True
DateTimeBehavior	UserLocal
Format	DateAndTime
ImeMode	Auto
SourceTypeMask	0

sa_CriteriaId

Property	Value
Description
DisplayName	CriteriaId
IsValidForForm	True
IsValidForRead	True
LogicalName	`sa_criteriaid`
RequiredLevel	None
Type	Lookup
Targets	sa_suggestedactioncriteria

sa_GeneratorTag

Property	Value
Description
DisplayName	Generator Tag
IsValidForForm	True
IsValidForRead	True
LogicalName	`sa_generatortag`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	200

sa_MakerActionName

Property	Value
Description
DisplayName	Maker Action Name
IsValidForForm	True
IsValidForRead	True
LogicalName	`sa_makeractionname`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	128

sa_Rationale

Property	Value
Description
DisplayName	Rationale
IsValidForForm	True
IsValidForRead	True
LogicalName	`sa_rationale`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	1024

sa_RowID

Property	Value
Description
DisplayName	Row ID
IsValidForForm	True
IsValidForRead	True
LogicalName	`sa_rowid`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

sa_SuggestedActionId

Property	Value
Description	Unique identifier for entity instances
DisplayName	SuggestedAction
IsValidForForm	False
IsValidForRead	True
LogicalName	`sa_suggestedactionid`
RequiredLevel	SystemRequired
Type	Uniqueidentifier

sa_TableID

Property	Value
Description
DisplayName	Table ID
IsValidForForm	True
IsValidForRead	True
LogicalName	`sa_tableid`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

statecode

Property	Value
Description	Status of the SuggestedAction
DisplayName	Status
IsValidForForm	True
IsValidForRead	True
LogicalName	`statecode`
RequiredLevel	SystemRequired
Type	State
DefaultFormValue
GlobalChoiceName	`sa_suggestedaction_statecode`

statecode Choices/Options

Value	Details
0	Label: Active DefaultStatus: 1 InvariantName: `Active`
1	Label: Inactive DefaultStatus: 2 InvariantName: `Inactive`

statuscode

Property	Value
Description	Reason for the status of the SuggestedAction
DisplayName	Status Reason
IsValidForForm	True
IsValidForRead	True
LogicalName	`statuscode`
RequiredLevel	None
Type	Status
DefaultFormValue
GlobalChoiceName	`sa_suggestedaction_statuscode`

statuscode Choices/Options

Value	Details
1	Label: Active State:0 TransitionData: None
2	Label: Inactive State:1 TransitionData: None

TimeZoneRuleVersionNumber

Property	Value
Description	For internal use only.
DisplayName	Time Zone Rule Version Number
IsValidForForm	False
IsValidForRead	True
LogicalName	`timezoneruleversionnumber`
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	-1

UTCConversionTimeZoneCode

Property	Value
Description	Time zone code that was in use when the record was created.
DisplayName	UTC Conversion Time Zone Code
IsValidForForm	False
IsValidForRead	True
LogicalName	`utcconversiontimezonecode`
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	-1

Read-only columns/attributes

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

VersionNumber

Property	Value
Description	Version Number
DisplayName	Version Number
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.

lk_sa_suggestedaction_createdby
lk_sa_suggestedaction_createdonbehalfby
lk_sa_suggestedaction_modifiedby
lk_sa_suggestedaction_modifiedonbehalfby
organization_sa_suggestedaction
sa_suggestedaction_CompletedBy_systemuser
sa_suggestedaction_CriteriaId_sa_suggestedactioncriteria

lk_sa_suggestedaction_createdby

One-To-Many Relationship: systemuser lk_sa_suggestedaction_createdby

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_sa_suggestedaction_createdonbehalfby

One-To-Many Relationship: systemuser lk_sa_suggestedaction_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_sa_suggestedaction_modifiedby

One-To-Many Relationship: systemuser lk_sa_suggestedaction_modifiedby

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`

lk_sa_suggestedaction_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_sa_suggestedaction_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`

organization_sa_suggestedaction

One-To-Many Relationship: organization organization_sa_suggestedaction

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`

sa_suggestedaction_CompletedBy_systemuser

One-To-Many Relationship: systemuser sa_suggestedaction_CompletedBy_systemuser

Property	Value
ReferencedEntity	`systemuser`
ReferencedAttribute	`systemuserid`
ReferencingAttribute	`sa_completedby`
ReferencingEntityNavigationPropertyName	`sa_CompletedBy`
IsHierarchical
CascadeConfiguration	Archive: `RemoveLink` Assign: `NoCascade` Delete: `RemoveLink` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

sa_suggestedaction_CriteriaId_sa_suggestedactioncriteria

One-To-Many Relationship: sa_suggestedactioncriteria sa_suggestedaction_CriteriaId_sa_suggestedactioncriteria

Property	Value
ReferencedEntity	`sa_suggestedactioncriteria`
ReferencedAttribute	`sa_suggestedactioncriteriaid`
ReferencingAttribute	`sa_criteriaid`
ReferencingEntityNavigationPropertyName	`sa_CriteriaId`
IsHierarchical
CascadeConfiguration	Archive: `RemoveLink` Assign: `NoCascade` Delete: `RemoveLink` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

One-to-Many relationships

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

sa_suggestedaction_AsyncOperations
sa_suggestedaction_BulkDeleteFailures
sa_suggestedaction_MailboxTrackingFolders
sa_suggestedaction_PrincipalObjectAttributeAccesses
sa_suggestedaction_ProcessSession
sa_suggestedaction_SyncErrors

sa_suggestedaction_AsyncOperations

Many-To-One Relationship: asyncoperation sa_suggestedaction_AsyncOperations

Property	Value
ReferencingEntity	`asyncoperation`
ReferencingAttribute	`regardingobjectid`
ReferencedEntityNavigationPropertyName	`sa_suggestedaction_AsyncOperations`
IsCustomizable	`True`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `DoNotDisplay` Group: `Details` Label: MenuId: null Order: QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

sa_suggestedaction_BulkDeleteFailures

Many-To-One Relationship: bulkdeletefailure sa_suggestedaction_BulkDeleteFailures

Property	Value
ReferencingEntity	`bulkdeletefailure`
ReferencingAttribute	`regardingobjectid`
ReferencedEntityNavigationPropertyName	`sa_suggestedaction_BulkDeleteFailures`
IsCustomizable	`True`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `DoNotDisplay` Group: `Details` Label: MenuId: null Order: QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

sa_suggestedaction_MailboxTrackingFolders

Many-To-One Relationship: mailboxtrackingfolder sa_suggestedaction_MailboxTrackingFolders

Property	Value
ReferencingEntity	`mailboxtrackingfolder`
ReferencingAttribute	`regardingobjectid`
ReferencedEntityNavigationPropertyName	`sa_suggestedaction_MailboxTrackingFolders`
IsCustomizable	`True`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `DoNotDisplay` Group: `Details` Label: MenuId: null Order: QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

sa_suggestedaction_PrincipalObjectAttributeAccesses

Many-To-One Relationship: principalobjectattributeaccess sa_suggestedaction_PrincipalObjectAttributeAccesses

Property	Value
ReferencingEntity	`principalobjectattributeaccess`
ReferencingAttribute	`objectid`
ReferencedEntityNavigationPropertyName	`sa_suggestedaction_PrincipalObjectAttributeAccesses`
IsCustomizable	`True`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `DoNotDisplay` Group: `Details` Label: MenuId: null Order: QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

sa_suggestedaction_ProcessSession

Many-To-One Relationship: processsession sa_suggestedaction_ProcessSession

Property	Value
ReferencingEntity	`processsession`
ReferencingAttribute	`regardingobjectid`
ReferencedEntityNavigationPropertyName	`sa_suggestedaction_ProcessSession`
IsCustomizable	`True`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `DoNotDisplay` Group: `Details` Label: MenuId: null Order: QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

sa_suggestedaction_SyncErrors

Many-To-One Relationship: syncerror sa_suggestedaction_SyncErrors

Property	Value
ReferencingEntity	`syncerror`
ReferencingAttribute	`regardingobjectid`
ReferencedEntityNavigationPropertyName	`sa_suggestedaction_SyncErrors`
IsCustomizable	`True`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `DoNotDisplay` Group: `Details` Label: MenuId: null Order: QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

Feedback

Was this page helpful?