approvalstageapproval EntityType
The approval stage in multi-stage approvals
- Entity set path:
- [organization URI]/api/data/v9.2/approvalstageapprovals
- Base type:
- crmbaseentity
- Display name:
- Approval Stage Approval
- Primary key:
- approvalstageapprovalid
- Primary name column:
- name
- Operations supported:
- POST GET PATCH DELETE
Properties
Properties represent fields of data stored in the entity. Some properties are read-only.
| Name | Type | Details | ||||||
|---|---|---|---|---|---|---|---|---|
| allowcancel | Edm.Boolean |
Choice to allow cancellation of approval Display name: Allow Cancel
Default options
|
||||||
| allowreassign | Edm.Boolean |
Choice to allow approval reassignment Display name: Allow Reassign
Default options
|
||||||
| approvalstageapprovalid | Edm.Guid |
Unique identifier for entity instances Display name: Approval Stage Approval |
||||||
| createdon | Edm.DateTimeOffset |
Date and time when the record was created. Display name: Created On Read only
|
||||||
| customfields | Edm.String |
Custom fields provided by customer Display name: Custom Fields |
||||||
| details | Edm.String |
Description of approval Display name: Details |
||||||
| importsequencenumber | Edm.Int32 |
Sequence number of the import that created this record. Display name: Import Sequence Number |
||||||
| itemlink | Edm.String |
Optional link to the item to approve Display name: Item Link |
||||||
| itemlinkdescription | Edm.String |
Optional description for the item link Display name: Item Link Description |
||||||
| modelid | Edm.String |
The guid of the linked approval model Display name: Model Id |
||||||
| modeltype | Edm.String |
The type of the linked approval model Display name: Model Type |
||||||
| modifiedon | Edm.DateTimeOffset |
Date and time when the record was modified. Display name: Modified On Read only
|
||||||
| name | Edm.String |
Display name: Name |
||||||
| overriddencreatedon | Edm.DateTimeOffset |
Date and time that the record was migrated. Display name: Record Created On |
||||||
| result | Edm.String |
The result of the approval Display name: Result |
||||||
| sendemailnotification | Edm.Boolean |
Whether to send system generated emails Display name: Send Email Notification
Default options
|
||||||
| statecode | Edm.Int32 |
Status of the Approval Stage Approval Display name: Status
Default options
|
||||||
| statuscode | Edm.Int32 |
Reason for the status of the Approval Stage Approval Display name: Status Reason
Default options
|
||||||
| timezoneruleversionnumber | Edm.Int32 |
For internal use only. Display name: Time Zone Rule Version Number |
||||||
| title | Edm.String |
Title of the approval Display name: Title |
||||||
| utcconversiontimezonecode | Edm.Int32 |
Time zone code that was in use when the record was created. Display name: UTC Conversion Time Zone Code |
||||||
| versionnumber | Edm.Int64 |
Version Number Display name: Version Number Read only
|
Lookup properties
Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Lookup property data.
| Name | Single-valued navigation property | Description |
|---|---|---|
| _approval_value | approval |
The linked parent approval |
| _createdby_value | createdby |
Unique identifier of the user who created the record. |
| _createdonbehalfby_value | createdonbehalfby |
Unique identifier of the delegate user who created the record. |
| _modifiedby_value | modifiedby |
Unique identifier of the user who modified the record. |
| _modifiedonbehalfby_value | modifiedonbehalfby |
Unique identifier of the delegate user who modified the record. |
| _ownerid_value | ownerid |
Owner Id |
| _owningbusinessunit_value | owningbusinessunit |
Unique identifier for the business unit that owns the record |
| _owningteam_value | owningteam |
Unique identifier for the team that owns the record. |
| _owninguser_value | owninguser |
Unique identifier for the user that owns the record. |
Single-valued navigation properties
Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.
| Name | Type | Partner |
|---|---|---|
| approval | msdyn_flow_approval | approvalstageapproval_approval_msdyn_flow_approval |
| createdby | systemuser | lk_approvalstageapproval_createdby |
| createdonbehalfby | systemuser | lk_approvalstageapproval_createdonbehalfby |
| modifiedby | systemuser | lk_approvalstageapproval_modifiedby |
| modifiedonbehalfby | systemuser | lk_approvalstageapproval_modifiedonbehalfby |
| ownerid | principal | owner_approvalstageapproval |
| owningbusinessunit | businessunit | business_unit_approvalstageapproval |
| owningteam | team | team_approvalstageapproval |
| owninguser | systemuser | user_approvalstageapproval |
Collection-valued navigation properties
Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.
| Name | Type | Partner |
|---|---|---|
| approvalstageapproval_Annotations | annotation | objectid_approvalstageapproval |
| approvalstageapproval_AsyncOperations | asyncoperation | regardingobjectid_approvalstageapproval |
| approvalstageapproval_BulkDeleteFailures | bulkdeletefailure | regardingobjectid_approvalstageapproval |
| approvalstageapproval_DuplicateBaseRecord | duplicaterecord | baserecordid_approvalstageapproval |
| approvalstageapproval_DuplicateMatchingRecord | duplicaterecord | duplicaterecordid_approvalstageapproval |
| approvalstageapproval_MailboxTrackingFolders | mailboxtrackingfolder | regardingobjectid_approvalstageapproval |
| approvalstageapproval_PrincipalObjectAttributeAccesses | principalobjectattributeaccess | objectid_approvalstageapproval |
| approvalstageapproval_ProcessSession | processsession | regardingobjectid_approvalstageapproval |
| approvalstageapproval_SyncErrors | syncerror | regardingobjectid_approvalstageapproval |
| approvalstageorder_stageapproval_approvalstageapproval | approvalstageorder | stageapproval |
Operations
The following operations can be used with the approvalstageapproval entity type.
| Name | Binding |
|---|---|
| CreateMultiple | Not Bound |
| DeleteMultiple | Not Bound |
| GrantAccess | Not Bound |
| IsValidStateTransition | Not Bound |
| ModifyAccess | Not Bound |
| RetrievePrincipalAccess | Not Bound |
| RetrieveSharedPrincipalsAndAccess | Not Bound |
| RevokeAccess | Not Bound |
| UpdateMultiple | Not Bound |