Connectors Reference
Enables approvals in workflows.
|
Status: Production |
Tier: Standard |
Version: 2.0 |
|
Name |
Summary |
|
|
|
|
GetApprovalTypeMetadataV2 (string approvalType, string metadataType) |
|
|
|
|
|
Start and wait for an approval |
|
|
Create an approval |
|
|
Wait for an approval |
|
|
UnsubscribeStartAnApproval (string approvalType, string subscriptionid) |
|
|
UnsubscribeWaitForAnApproval (string approvalName, string subscriptionid) |
|
|
GetApprovalTypeMetadata (string approvalType, string metadataType) |
|
|
Start and wait for an approval (Deprecated) |
|
|
approvalUnsubscribeV2 (string approvalType, string subscriptionid) |
|
|
approvalSubscribe (ApprovalCreationInputV0 ApprovalCreationInput) |
Start and wait for an Approve or Reject - First to respond approval (Deprecated) |
|
|
|
Name |
Summary |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
StartAndWaitForAnApprovalParameterWebhookApprovalCreationInput |
|
|
|
Summary:
Description: Get the list of approval types.
Syntax:
Approvals.GetApprovalTypes ()
Returns:
Type:ApprovalTypesList
Summary:
Description: Get the dynamic schema for operation inputs based on approval type.
Syntax:
Approvals.GetApprovalTypeMetadataV2 (string approvalType, string metadataType)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
approvalType |
string (Approval type) |
Select an approval type. |
True |
|
|
metadataType |
string (Metadata type) |
The metadata type. |
True |
Returns:
Summary:
Description: Get the dynamic schema for webhook operation inputs for subscribing to an approval.
Syntax:
Approvals.GetSubscriptionMetadata (string metadataType)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
metadataType |
string (Metadata type) |
The metadata type. |
True |
Returns:
Summary: Start and wait for an approval
Description: Starts an automated approval process and then waits for it to complete. The approval is cancelable.
Syntax:
Approvals.StartAndWaitForAnApproval (string approvalType, StartAndWaitForAnApprovalParameterWebhookApprovalCreationInput WebhookApprovalCreationInput)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
approvalType |
string (Approval type) |
Select an approval type. |
True |
|
|
WebhookApprovalCreationInput |
StartAndWaitForAnApprovalParameterWebhookApprovalCreationInput
|
|
True |
Returns:
Summary: Create an approval
Description: Starts an automated approval process, but does not wait for the approval to complete. The approval is cancelable.
Syntax:
Approvals.CreateAnApproval (string approvalType, CreateAnApprovalParameterApprovalCreationInput ApprovalCreationInput)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
approvalType |
string (Approval type) |
Select an approval type. |
True |
|
|
ApprovalCreationInput |
CreateAnApprovalParameterApprovalCreationInput
|
|
True |
Returns:
Summary: Wait for an approval
Description: Waits for a specified approval to complete.
Syntax:
Approvals.WaitForAnApproval (string approvalName, WaitForAnApprovalParameterApprovalSubscriptionInput ApprovalSubscriptionInput)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
approvalName |
string (Approval ID) |
The ID of the approval. |
True |
|
|
ApprovalSubscriptionInput |
WaitForAnApprovalParameterApprovalSubscriptionInput
|
|
True |
Returns:
Summary:
Description: Unsubscribe route for operation: StartAndWaitForAnApproval
Syntax:
Approvals.UnsubscribeStartAnApproval (string approvalType, string subscriptionid)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
approvalType |
string (Approval type) |
The approval type. |
True |
|
|
subscriptionid |
string (Subscription Id) |
Id of the webhook subscription. |
True |
Returns:
Summary:
Description: Unsubscribe route for operation: WaitForAnApproval
Syntax:
Approvals.UnsubscribeWaitForAnApproval (string approvalName, string subscriptionid)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
approvalName |
string (Approval ID) |
The ID of the approval. |
True |
|
|
subscriptionid |
string (Subscription Id) |
Id of the webhook subscription. |
True |
Returns:
Summary:
Description: Get the dynamic schema for operation inputs based on approval type. (Deprecated)
Syntax:
Approvals.GetApprovalTypeMetadata (string approvalType, string metadataType)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
approvalType |
string (Approval type) |
Select an approval type. |
True |
|
|
metadataType |
string (Metadata type) |
The metadata type. |
True |
Returns:
Summary: Start and wait for an approval (Deprecated)
Description: Starts an automated approval process and then waits for it to complete. The approval is only canceled on timeout. (Deprecated)
Syntax:
Approvals.approvalSubscribeV2 (string approvalType, approvalSubscribeV2ParameterApprovalCreationInput ApprovalCreationInput)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
approvalType |
string (Approval type) |
Select an approval type. |
True |
|
|
ApprovalCreationInput |
approvalSubscribeV2ParameterApprovalCreationInput
|
|
True |
Returns:
Summary:
Description: Unsubscribe route for operation: approvalSubscribeV2 (Deprecated)
Syntax:
Approvals.approvalUnsubscribeV2 (string approvalType, string subscriptionid)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
approvalType |
string (Approval type) |
The approval type. |
True |
|
|
subscriptionid |
string (Subscription Id) |
Id of the webhook subscription. |
True |
Returns:
Summary: Start and wait for an Approve or Reject - First to respond approval (Deprecated)
Description: Starts an automated approval process and then waits for it to complete. The approval is only canceled on timeout. (Deprecated)
Syntax:
Approvals.approvalSubscribe (ApprovalCreationInputV0 ApprovalCreationInput)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
ApprovalCreationInput |
|
Model for approval subscription. |
True |
Returns:
Summary:
Description: Unsubscribe route for operation: approvalSubscribe (Deprecated)
Syntax:
Approvals.approvalUnsubscribe (string subscriptionid)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscriptionid |
string (Subscription Id) |
Id of the webhook subscription. |
True |
Returns:
Summary:
Description: Model for approval subscription.
Properties:
|
Name |
Type |
Summary |
|
NotificationUrl |
string
|
Gets or sets callback url to flow engine. It is expected as part of the webhook request. |
|
title |
string Title |
Specify the title of the approval. |
|
details |
string Details |
Specify the details of the approval request. Markdown syntax is supported, see https://aka.ms/approvaldetails for more information. |
|
itemLink |
string Item Link |
Specify a link to the item to approve. |
|
itemLinkDescription |
string Item Link Description |
Specify a description for the item to approve. |
|
assignedTo |
string(email) Assigned To |
Specify to whom the approval should be assigned. This should be a semi-colon (;) delimited collection of either email addresses, UPNs, or AAD user ids. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
value |
array of (ValueItem)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Name |
string
|
|
|
DisplayName |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |