msdyn_flow_approval EntityType

An approval.

Entity set path:
[organization URI]/api/data/v9.2/msdyn_flow_approvals
Base type:
crmbaseentity
Display name:
Approval
Primary key:
msdyn_flow_approvalid
Primary key attribute:
msdyn_flow_approval_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
createdon Edm.DateTimeOffset

Date and time when the record was created.

Display name: Created On

Read only
importsequencenumber Edm.Int32

Sequence number of the import that created this record.

Display name: Import Sequence Number

modifiedon Edm.DateTimeOffset

Date and time when the record was modified.

Display name: Modified On

Read only
msdyn_flow_approval_additionalfields Edm.String

Display name: Additional Fields

msdyn_flow_approval_allowcancel Edm.Boolean

Boolean field that allows the approval owner to cancel the approval.

Display name: Allow Cancel

Default options
Values Label
1 Yes
0 No
msdyn_flow_approval_allowreassign Edm.Boolean

Boolean field that allows the approvers to reassign approval requests.

Display name: Allow Reassign

Default options
Values Label
1 Yes
0 No
msdyn_flow_approval_approvalstagekey Edm.String

Lookup key to match approval id and stage in fetch xml.

Display name: Approval Stage Key

msdyn_flow_approval_category Edm.String

User defined string that allows approval creators to categorize an approval.

Display name: Category

msdyn_flow_approval_completedon Edm.DateTimeOffset

The completion date.

Display name: Completed On

msdyn_flow_approval_currentstepnumber Edm.Int32

Display name: Current Step Number

msdyn_flow_approval_details Edm.String

The description of the approval.

Display name: Details

msdyn_flow_approval_dueon Edm.DateTimeOffset

The due date.

Display name: Due On

msdyn_flow_approval_expireson Edm.DateTimeOffset

The expiration date.

Display name: Expires On

msdyn_flow_approval_itemlink Edm.String

The optional link to the item to approve.

Display name: Item Link

msdyn_flow_approval_itemlinkdescription Edm.String

The optional description for the item link.

Display name: Item Link Description

msdyn_flow_approval_itemlinkhash Edm.String

Item link hash to enable queries.

Display name: Item Link Hash

msdyn_flow_approval_modelid Edm.String

Id of the approval model.

Display name: Approval Model Id

msdyn_flow_approval_modeltype Edm.String

Table name of the approval model.

Display name: Approval Model Type

msdyn_flow_approval_name Edm.String

The name of the approval.

Display name: Name

msdyn_flow_approval_partneridhash Edm.String

The hash of a unique partner id associated with a document. Meant for search scenarios.

Display name: Partner Id Hash

msdyn_flow_approval_partnermetadata Edm.String

Unstructured space to store extraneous information associated with the approval for partner services.

Display name: Partner Metadata

msdyn_flow_approval_priority Edm.Int32

The priority of the approval.

Display name: Priority

Default options
Values Label
192350000 Urgent
192350001 Important
192350002 Medium
192350003 Low
msdyn_flow_approval_requesttype Edm.Int32

The type of request that created the approval whether from an approval template, esignature process, etc.

Display name: Request Type

Default options
Values Label
192350000 Other
192350001 Basic
192350002 eSign
192350003 Templates
msdyn_flow_approval_result Edm.String

Final outcome of the approval.

Display name: Result

msdyn_flow_approval_sendemail Edm.Boolean

Whether to send system-generated email notifications for this approval.

Display name: Send Email Notification

Default options
Values Label
1 Yes
0 No
msdyn_flow_approval_source Edm.String

Source of the request that created the approval.

Display name: Source

msdyn_flow_approval_stage Edm.Int32

The stage.

Display name: Stage

Default options
Values Label
192350000 Not Specified
192350001 Basic
192351000 Complete
msdyn_flow_approval_tags Edm.String

Semicolon delimited list of user defined strings to help filter and search approvals.

Display name: Tags

msdyn_flow_approval_templateformid Edm.String

Base64 encoded string id of the template approval form.

Display name: Template Form Id

msdyn_flow_approval_templateid Edm.String

Base64 encoded string id of the template used to create the approval.

Display name: Template Id

msdyn_flow_approval_templateresponseid Edm.String

Base64 encoded string id of the unique templated approval response.

Display name: Template Response Id

msdyn_flow_approval_title Edm.String

The title.

Display name: Title

msdyn_flow_approvalid Edm.Guid

Unique identifier for entity instances

Display name: Approval

overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display name: Record Created On

statecode Edm.Int32

Status of the Approval

Display name: Status

Default options
Values Label
0 Active
1 Inactive
statuscode Edm.Int32

The reason for the status of the approval.

Display name: Status Reason

Default options
Values Label
192350000 Created
192350001 Pending
192350002 Suspended
192350004 Completed
192350005 Expired
192350006 Canceled
192350007 Abandoned
timezoneruleversionnumber Edm.Int32

For internal use only.

Display name: Time Zone Rule Version Number

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
_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.

_msdyn_flow_approval_basicapprovalmodel_value msdyn_flow_approval_basicapprovalmodel

The linked basic approval model data.

_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
createdby systemuser lk_msdyn_flow_approval_createdby
createdonbehalfby systemuser lk_msdyn_flow_approval_createdonbehalfby
modifiedby systemuser lk_msdyn_flow_approval_modifiedby
modifiedonbehalfby systemuser lk_msdyn_flow_approval_modifiedonbehalfby
msdyn_flow_approval_basicapprovalmodel msdyn_flow_basicapprovalmodel msdyn_flow_basicapprovalmodelrelationship_approval
ownerid principal owner_msdyn_flow_approval
owningbusinessunit businessunit business_unit_msdyn_flow_approval
owningteam team team_msdyn_flow_approval
owninguser systemuser user_msdyn_flow_approval

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
msdyn_flow_approval_Annotations annotation objectid_msdyn_flow_approval
msdyn_flow_approval_AsyncOperations asyncoperation regardingobjectid_msdyn_flow_approval
msdyn_flow_approval_BulkDeleteFailures bulkdeletefailure regardingobjectid_msdyn_flow_approval
msdyn_flow_approval_DuplicateBaseRecord duplicaterecord baserecordid_msdyn_flow_approval
msdyn_flow_approval_DuplicateMatchingRecord duplicaterecord duplicaterecordid_msdyn_flow_approval
msdyn_flow_approval_MailboxTrackingFolders mailboxtrackingfolder regardingobjectid_msdyn_flow_approval
msdyn_flow_approval_PrincipalObjectAttributeAccesses principalobjectattributeaccess objectid_msdyn_flow_approval
msdyn_flow_approval_ProcessSession processsession regardingobjectid_msdyn_flow_approval
msdyn_flow_approval_SyncErrors syncerror regardingobjectid_msdyn_flow_approval
msdyn_flow_approvalrelationship_approvalrequests msdyn_flow_approvalrequest msdyn_flow_approvalrequest_approval
msdyn_flow_approvalrelationship_approvalresponses msdyn_flow_approvalresponse msdyn_flow_approvalresponse_approval
msdyn_flow_approvalrelationship_approvalsteps msdyn_flow_approvalstep msdyn_flow_approvalstep_approval
msdyn_flow_approvalrelationship_flowapprovals msdyn_flow_flowapproval msdyn_flow_flowapproval_approval

Operations

The following operations can be used with the msdyn_flow_approval 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

See also