Connectors Reference

Approvals

Enables approvals in workflows.

 

Status:

Tier: Standard

Version: 1.0

 

Actions:

Name

Summary

GetApprovalTypes ()

Get approval types

GetApprovalTypeInputMetadata (string type)

Get approval type input metadata

GetApprovalTypeOutputMetadata (string type)

Get approval type output metadata

approvalSubscribeV2 (string type, DynamicApprovalSubscriptionRequest ApprovalSubscriptionRequest)

Start an approval

approvalUnsubscribeV2 (string type, string subscriptionid)

Unsubscribes approval

approvalSubscribe (ApprovalSubscriptionRequest ApprovalSubscriptionRequest)

Start an approval (V1)

approvalUnsubscribe (string subscriptionid)

Unsubscribes approval (V1)

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

ApprovalSubscriptionRequest

 

ApprovalType

 

ApprovalTypeMetadata

 

ApprovalTypesList

 

DynamicApprovalSubscriptionRequest

 

Object

 

 

Actions:

GetApprovalTypes

Summary: Get approval types

Description: Get the supported approval types.

 

Syntax:

Approvals.GetApprovalTypes ()

 

Returns:

          Type:ApprovalTypesList

 

GetApprovalTypeInputMetadata

Summary: Get approval type input metadata

Description: Get the schema information for the approval type inputs.

 

Syntax:

Approvals.GetApprovalTypeInputMetadata (string type)

 

Parameters:

Name

Type

Summary

Required

Related Action

type

string

 

 

True

GetApprovalTypes

 

Returns:

          Type:ApprovalTypeMetadata

 

GetApprovalTypeOutputMetadata

Summary: Get approval type output metadata

Description: Get the schema information for the approval type outputs.

 

Syntax:

Approvals.GetApprovalTypeOutputMetadata (string type)

 

Parameters:

Name

Type

Summary

Required

Related Action

type

string

 

 

True

GetApprovalTypes

 

Returns:

          Type:ApprovalTypeMetadata

 

approvalSubscribeV2

Summary: Start an approval

Description: Automate the approval process for documents, time off requests, and more. Choose a single or multiple approvers.

 

Syntax:

Approvals.approvalSubscribeV2 (string type, DynamicApprovalSubscriptionRequest ApprovalSubscriptionRequest)

 

Parameters:

Name

Type

Summary

Required

Related Action

type

string

(Approval type)

Select an approval type

True

GetApprovalTypes

ApprovalSubscriptionRequest

DynamicApprovalSubscriptionRequest

 

 

True

 

Returns:

 

approvalUnsubscribeV2

Summary: Unsubscribes approval

Description: Unsubscribes approval.

 

Syntax:

Approvals.approvalUnsubscribeV2 (string type, string subscriptionid)

 

Parameters:

Name

Type

Summary

Required

Related Action

type

string

(Approval type)

Select an approval type

True

subscriptionid

string

(Id of subscription to be deleted)

Id of subscription to be deleted.

True

 

Returns:

 

approvalSubscribe

Summary: Start an approval (V1)

Description: Automate the approval process for documents, time off requests, and more. Choose a single or multiple approvers.

 

Syntax:

Approvals.approvalSubscribe (ApprovalSubscriptionRequest ApprovalSubscriptionRequest)

 

Parameters:

Name

Type

Summary

Required

Related Action

ApprovalSubscriptionRequest

ApprovalSubscriptionRequest

 

Model for approval subscription.

True

 

Returns:

 

approvalUnsubscribe

Summary: Unsubscribes approval (V1)

Description: Unsubscribes approval (V1).

 

Syntax:

Approvals.approvalUnsubscribe (string subscriptionid)

 

Parameters:

Name

Type

Summary

Required

Related Action

subscriptionid

string

(Id of subscription to be deleted)

Id of subscription to be deleted.

True

 

Returns:

 


 

ApprovalSubscriptionRequest

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.

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.


 

ApprovalType

Summary:

Description:

 

          Properties:

Name

Type

Summary

Name

string

 

 

DisplayName

string

 

 


 

ApprovalTypeMetadata

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

 

 

title

string

 

 

x-ms-permission

string

 

 

schema

Object

 

 

referencedEntities

Object

 

 


 

ApprovalTypesList

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

array of (ApprovalType)

 

 


 

DynamicApprovalSubscriptionRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

Object

Summary:

Description:

 

          Properties:

Name

Type

Summary