Изменить

Поделиться через

Approval Process (approvalprocess) table/entity reference (Microsoft Dataverse)

  • Статья

Approval Process for Multi-Stage Approvals

Messages

The following table lists the messages for the Approval Process (approvalprocess) 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 /approvalprocesses(approvalprocessid)
Update the ownerid property.		 AssignRequest
Associate
Event: True		 Associate records Associate records
Create
Event: True		 POST /approvalprocesses
See Create		 Create records
CreateMultiple
Event: True		 CreateMultiple CreateMultipleRequest
Delete
Event: True		 DELETE /approvalprocesses(approvalprocessid)
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 /approvalprocesses(approvalprocessid)
See Retrieve		 Retrieve records
RetrieveMultiple
Event: True		 GET /approvalprocesses
See Query data		 Query data
RetrievePrincipalAccess
Event: True		 RetrievePrincipalAccess RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess
Event: True		 RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess
Event: True		 RevokeAccess RevokeAccessRequest
SetState
Event: True		 PATCH /approvalprocesses(approvalprocessid)
Update the statecode and statuscode properties.		 SetStateRequest
Update
Event: True		 PATCH /approvalprocesses(approvalprocessid)
See Update		 Update records
UpdateMultiple
Event: True		 UpdateMultiple UpdateMultipleRequest
Upsert
Event: False		 PATCH /approvalprocesses(approvalprocessid)
See Upsert a table row		 UpsertRequest
UpsertMultiple
Event: False		 UpsertMultiple UpsertMultipleRequest

Events

The following table lists the events for the Approval Process (approvalprocess) 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 Approval Process (approvalprocess) table.

Property Value
DisplayName Approval Process
DisplayCollectionName Approval Processes
SchemaName approvalprocess
CollectionSchemaName approvalprocesses
EntitySetName approvalprocesses
LogicalName approvalprocess
LogicalCollectionName approvalprocesses
PrimaryIdAttribute approvalprocessid
PrimaryNameAttribute name
TableType Standard
OwnershipType UserOwned

Writable columns/attributes

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

approvalprocessId

Property Value
Description Unique identifier for approval process
DisplayName Approval Process
IsValidForForm False
IsValidForRead True
LogicalName approvalprocessid
RequiredLevel SystemRequired
Type Uniqueidentifier

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

IsCustomizable

Property Value
Description For internal use only.
DisplayName Is Customizable
IsValidForForm False
IsValidForRead True
LogicalName iscustomizable
RequiredLevel SystemRequired
Type ManagedProperty

MetadataVersion

Property Value
Description Metadata version for parsing.
DisplayName Metadata Version
IsValidForForm True
IsValidForRead True
LogicalName metadataversion
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue 0

name

Property Value
Description The name of the approval process.
DisplayName Name
IsValidForForm True
IsValidForRead True
LogicalName name
RequiredLevel None
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

statecode

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

UniqueName

Property Value
Description Unique Name for the entity.
DisplayName Unique Name
IsValidForForm True
IsValidForRead True
LogicalName uniquename
RequiredLevel SystemRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 128

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.

ComponentIdUnique

Property Value
Description For internal use only.
DisplayName Row id unique
IsValidForForm False
IsValidForRead True
LogicalName componentidunique
RequiredLevel SystemRequired
Type Uniqueidentifier

ComponentState

Property Value
Description For internal use only.
DisplayName Component State
IsValidForForm False
IsValidForRead True
LogicalName componentstate
RequiredLevel SystemRequired
Type Picklist
DefaultFormValue
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 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

Inputs

Property Value
Description The input variables for the multi-stage approvals.
DisplayName Inputs
IsValidForForm True
IsValidForRead True
LogicalName inputs
RequiredLevel None
Type File
MaxSizeInKB 32768

Inputs_Name

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName inputs_name
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Disabled
IsLocalizable False
MaxLength 200

IsManaged

Property Value
Description Indicates whether the solution component is part of a managed solution.
DisplayName Is Managed
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 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

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 DateAndTime
ImeMode Inactive
SourceTypeMask 0

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

SolutionId

Property Value
Description Unique identifier of the associated solution.
DisplayName Solution
IsValidForForm False
IsValidForRead True
LogicalName solutionid
RequiredLevel SystemRequired
Type Uniqueidentifier

Stages

Property Value
Description The stages for the multi-stage approvals.
DisplayName Stages
IsValidForForm True
IsValidForRead True
LogicalName stages
RequiredLevel ApplicationRequired
Type File
MaxSizeInKB 32768

Stages_Name

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName stages_name
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Disabled
IsLocalizable False
MaxLength 200

SupportingSolutionId

Property Value
Description For internal use only.
DisplayName Solution
IsValidForForm False
IsValidForRead False
LogicalName supportingsolutionid
RequiredLevel None
Type Uniqueidentifier

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.

business_unit_approvalprocess

One-To-Many Relationship: businessunit business_unit_approvalprocess

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

FileAttachment_approvalprocess_Inputs

One-To-Many Relationship: fileattachment FileAttachment_approvalprocess_Inputs

Property Value
ReferencedEntity fileattachment
ReferencedAttribute fileattachmentid
ReferencingAttribute inputs
ReferencingEntityNavigationPropertyName inputs
IsHierarchical
CascadeConfiguration Archive: RemoveLink
Assign: NoCascade
Delete: RemoveLink
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

FileAttachment_approvalprocess_Stages

One-To-Many Relationship: fileattachment FileAttachment_approvalprocess_Stages

Property Value
ReferencedEntity fileattachment
ReferencedAttribute fileattachmentid
ReferencingAttribute stages
ReferencingEntityNavigationPropertyName stages
IsHierarchical
CascadeConfiguration Archive: RemoveLink
Assign: NoCascade
Delete: RemoveLink
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_approvalprocess_createdby

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

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

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

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

One-To-Many Relationship: owner owner_approvalprocess

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_approvalprocess

One-To-Many Relationship: team team_approvalprocess

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_approvalprocess

One-To-Many Relationship: systemuser user_approvalprocess

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.

approvalprocess_Annotations

Many-To-One Relationship: annotation approvalprocess_Annotations

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

approvalprocess_AsyncOperations

Many-To-One Relationship: asyncoperation approvalprocess_AsyncOperations

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

approvalprocess_BulkDeleteFailures

Many-To-One Relationship: bulkdeletefailure approvalprocess_BulkDeleteFailures

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

approvalprocess_DuplicateBaseRecord

Many-To-One Relationship: duplicaterecord approvalprocess_DuplicateBaseRecord

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

approvalprocess_DuplicateMatchingRecord

Many-To-One Relationship: duplicaterecord approvalprocess_DuplicateMatchingRecord

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

approvalprocess_FileAttachments

Many-To-One Relationship: fileattachment approvalprocess_FileAttachments

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

approvalprocess_MailboxTrackingFolders

Many-To-One Relationship: mailboxtrackingfolder approvalprocess_MailboxTrackingFolders

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

approvalprocess_PrincipalObjectAttributeAccesses

Many-To-One Relationship: principalobjectattributeaccess approvalprocess_PrincipalObjectAttributeAccesses

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

approvalprocess_ProcessSession

Many-To-One Relationship: processsession approvalprocess_ProcessSession

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

approvalprocess_SyncErrors

Many-To-One Relationship: syncerror approvalprocess_SyncErrors

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName approvalprocess_SyncErrors
IsCustomizable True
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