Edit

Share via

Approval Stage Approval (approvalstageapproval) table/entity reference (Microsoft Dataverse)

The approval stage in multi-stage approvals

Messages

The following table lists the messages for the Approval Stage Approval (approvalstageapproval) 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
Assign
Event: True		 PATCH /approvalstageapprovals(approvalstageapprovalid)
Update the ownerid property.		 AssignRequest
Associate
Event: True		 Associate records Associate records
Create
Event: True		 POST /approvalstageapprovals
See Create		 Create records
CreateMultiple
Event: True		 CreateMultiple CreateMultipleRequest
Delete
Event: True		 DELETE /approvalstageapprovals(approvalstageapprovalid)
See Delete		 Delete records
Disassociate
Event: True		 Disassociate records Disassociate records
GrantAccess
Event: True		 GrantAccess GrantAccessRequest
IsValidStateTransition
Event: False		 IsValidStateTransition IsValidStateTransitionRequest
ModifyAccess
Event: True		 ModifyAccess ModifyAccessRequest
Retrieve
Event: True		 GET /approvalstageapprovals(approvalstageapprovalid)
See Retrieve		 Retrieve records
RetrieveMultiple
Event: True		 GET /approvalstageapprovals
See Query data		 Query data
RetrievePrincipalAccess
Event: True		 RetrievePrincipalAccess RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess
Event: True		 RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess
Event: True		 RevokeAccess RevokeAccessRequest
SetState
Event: True		 PATCH /approvalstageapprovals(approvalstageapprovalid)
Update the statecode and statuscode properties.		 SetStateRequest
Update
Event: True		 PATCH /approvalstageapprovals(approvalstageapprovalid)
See Update		 Update records
UpdateMultiple
Event: True		 UpdateMultiple UpdateMultipleRequest
Upsert
Event: False		 PATCH /approvalstageapprovals(approvalstageapprovalid)
See Upsert a table row		 UpsertRequest
UpsertMultiple
Event: False		 UpsertMultiple UpsertMultipleRequest

Properties

The following table lists selected properties for the Approval Stage Approval (approvalstageapproval) table.

Property Value
DisplayName Approval Stage Approval
DisplayCollectionName Approval Stage Approvals
SchemaName approvalstageapproval
CollectionSchemaName approvalstageapprovals
EntitySetName approvalstageapprovals
LogicalName approvalstageapproval
LogicalCollectionName approvalstageapprovals
PrimaryIdAttribute approvalstageapprovalid
PrimaryNameAttribute name
TableType Standard
OwnershipType UserOwned

Writable columns/attributes

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

AllowCancel

Property Value
Description Choice to allow cancellation of approval
DisplayName Allow Cancel
IsValidForForm True
IsValidForRead True
LogicalName allowcancel
RequiredLevel None
Type Boolean
GlobalChoiceName approvalstageapproval_allowcancel
DefaultValue True
True Label Yes
False Label No

AllowReassign

Property Value
Description Choice to allow approval reassignment
DisplayName Allow Reassign
IsValidForForm True
IsValidForRead True
LogicalName allowreassign
RequiredLevel ApplicationRequired
Type Boolean
GlobalChoiceName approvalstageapproval_allowreassign
DefaultValue True
True Label Yes
False Label No

Approval

Property Value
Description The linked parent approval
DisplayName Approval
IsValidForForm True
IsValidForRead True
LogicalName approval
RequiredLevel ApplicationRequired
Type Lookup
Targets msdyn_flow_approval

approvalstageapprovalId

Property Value
Description Unique identifier for entity instances
DisplayName Approval Stage Approval
IsValidForForm False
IsValidForRead True
LogicalName approvalstageapprovalid
RequiredLevel SystemRequired
Type Uniqueidentifier

CustomFields

Property Value
Description Custom fields provided by customer
DisplayName Custom Fields
IsValidForForm False
IsValidForRead True
LogicalName customfields
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 4000

Details

Property Value
Description Description of approval
DisplayName Details
IsValidForForm False
IsValidForRead True
LogicalName details
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 4000

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
Property Value
Description Optional link to the item to approve
DisplayName Item Link
IsValidForForm False
IsValidForRead True
LogicalName itemlink
RequiredLevel None
Type String
Format Url
FormatName Url
ImeMode Auto
IsLocalizable False
MaxLength 2000

ItemLinkDescription

Property Value
Description Optional description for the item link
DisplayName Item Link Description
IsValidForForm False
IsValidForRead True
LogicalName itemlinkdescription
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 2000

ModelId

Property Value
Description The guid of the linked approval model
DisplayName Model Id
IsValidForForm False
IsValidForRead True
LogicalName modelid
RequiredLevel ApplicationRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100

ModelType

Property Value
Description The type of the linked approval model
DisplayName Model Type
IsValidForForm False
IsValidForRead True
LogicalName modeltype
RequiredLevel ApplicationRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100

Name

Property Value
Description
DisplayName Name
IsValidForForm True
IsValidForRead True
LogicalName name
RequiredLevel ApplicationRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 850

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

OwnerId

Property Value
Description Owner Id
DisplayName Owner
IsValidForForm True
IsValidForRead True
LogicalName ownerid
RequiredLevel SystemRequired
Type Owner
Targets systemuser, team

OwnerIdType

Property Value
Description Owner Id Type
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridtype
RequiredLevel SystemRequired
Type EntityName

Result

Property Value
Description The result of the approval
DisplayName Result
IsValidForForm False
IsValidForRead True
LogicalName result
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 500

SendEmailNotification

Property Value
Description Whether to send system generated emails
DisplayName Send Email Notification
IsValidForForm True
IsValidForRead True
LogicalName sendemailnotification
RequiredLevel ApplicationRequired
Type Boolean
GlobalChoiceName approvalstageapproval_sendemailnotification
DefaultValue True
True Label Yes
False Label No

statecode

Property Value
Description Status of the Approval Stage Approval
DisplayName Status
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State
DefaultFormValue
GlobalChoiceName approvalstageapproval_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 Approval Stage Approval
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status
DefaultFormValue
GlobalChoiceName approvalstageapproval_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

Title

Property Value
Description Title of the approval
DisplayName Title
IsValidForForm False
IsValidForRead True
LogicalName title
RequiredLevel ApplicationRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 2000

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.

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

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

OwnerIdName

Property Value
Description Name of the owner
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridname
RequiredLevel SystemRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100

OwnerIdYomiName

Property Value
Description Yomi name of the owner
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridyominame
RequiredLevel SystemRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100

OwningBusinessUnit

Property Value
Description Unique identifier for the business unit that owns the record
DisplayName Owning Business Unit
IsValidForForm True
IsValidForRead True
LogicalName owningbusinessunit
RequiredLevel SystemRequired
Type Lookup
Targets businessunit

OwningTeam

Property Value
Description Unique identifier for the team that owns the record.
DisplayName Owning Team
IsValidForForm False
IsValidForRead True
LogicalName owningteam
RequiredLevel None
Type Lookup
Targets team

OwningUser

Property Value
Description Unique identifier for the user that owns the record.
DisplayName Owning User
IsValidForForm False
IsValidForRead True
LogicalName owninguser
RequiredLevel None
Type Lookup
Targets systemuser

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.

approvalstageapproval_approval_msdyn_flow_approval

One-To-Many Relationship: msdyn_flow_approval approvalstageapproval_approval_msdyn_flow_approval

Property Value
ReferencedEntity msdyn_flow_approval
ReferencedAttribute msdyn_flow_approvalid
ReferencingAttribute approval
ReferencingEntityNavigationPropertyName approval
IsHierarchical
CascadeConfiguration Archive: Cascade
Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

business_unit_approvalstageapproval

One-To-Many Relationship: businessunit business_unit_approvalstageapproval

Property Value
ReferencedEntity businessunit
ReferencedAttribute businessunitid
ReferencingAttribute owningbusinessunit
ReferencingEntityNavigationPropertyName owningbusinessunit
IsHierarchical
CascadeConfiguration Archive: Restrict
Assign: NoCascade
Delete: Restrict
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_approvalstageapproval_createdby

One-To-Many Relationship: systemuser lk_approvalstageapproval_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_approvalstageapproval_createdonbehalfby

One-To-Many Relationship: systemuser lk_approvalstageapproval_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_approvalstageapproval_modifiedby

One-To-Many Relationship: systemuser lk_approvalstageapproval_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_approvalstageapproval_modifiedonbehalfby

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

owner_approvalstageapproval

One-To-Many Relationship: owner owner_approvalstageapproval

Property Value
ReferencedEntity owner
ReferencedAttribute ownerid
ReferencingAttribute ownerid
ReferencingEntityNavigationPropertyName ownerid
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

team_approvalstageapproval

One-To-Many Relationship: team team_approvalstageapproval

Property Value
ReferencedEntity team
ReferencedAttribute teamid
ReferencingAttribute owningteam
ReferencingEntityNavigationPropertyName owningteam
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

user_approvalstageapproval

One-To-Many Relationship: systemuser user_approvalstageapproval

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute owninguser
ReferencingEntityNavigationPropertyName owninguser
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.

approvalstageapproval_Annotations

Many-To-One Relationship: annotation approvalstageapproval_Annotations

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

approvalstageapproval_AsyncOperations

Many-To-One Relationship: asyncoperation approvalstageapproval_AsyncOperations

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

approvalstageapproval_BulkDeleteFailures

Many-To-One Relationship: bulkdeletefailure approvalstageapproval_BulkDeleteFailures

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

approvalstageapproval_DuplicateBaseRecord

Many-To-One Relationship: duplicaterecord approvalstageapproval_DuplicateBaseRecord

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute baserecordid
ReferencedEntityNavigationPropertyName approvalstageapproval_DuplicateBaseRecord
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

approvalstageapproval_DuplicateMatchingRecord

Many-To-One Relationship: duplicaterecord approvalstageapproval_DuplicateMatchingRecord

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute duplicaterecordid
ReferencedEntityNavigationPropertyName approvalstageapproval_DuplicateMatchingRecord
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

approvalstageapproval_MailboxTrackingFolders

Many-To-One Relationship: mailboxtrackingfolder approvalstageapproval_MailboxTrackingFolders

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

approvalstageapproval_PrincipalObjectAttributeAccesses

Many-To-One Relationship: principalobjectattributeaccess approvalstageapproval_PrincipalObjectAttributeAccesses

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

approvalstageapproval_ProcessSession

Many-To-One Relationship: processsession approvalstageapproval_ProcessSession

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

approvalstageapproval_SyncErrors

Many-To-One Relationship: syncerror approvalstageapproval_SyncErrors

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

approvalstageorder_stageapproval_approvalstageapproval

Many-To-One Relationship: approvalstageorder approvalstageorder_stageapproval_approvalstageapproval

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

See also

Dataverse table/entity reference
Dataverse Web API Reference
approvalstageapproval