Connectors Reference

Flow management

Enables interaction with flow management service.

 

Status: Production

Tier: Standard

Version: 1.0

 

Actions:

Name

Summary

ListApis (string environmentName)

List Connectors

GetApi (string environmentName, string apiName)

Get Connector

CreateConnection (string environmentName, string apiName, [Optional]Connection connection)

Create Connection

ListConnections (string environmentName)

List My Connections

ListUserEnvironments ()

List My Environments

ListFlowOwners (string environmentName, string flowName)

List Flow Owners

ModifyFlowOwners (string environmentName, string flowName, ModifyFlowPermissionPayload permissions)

Modify Flow Owners

ListFlowUsers (string environmentName, string flowName)

List Flow Run-Only Users

ModifyRunOnlyUsers (string environmentName, string flowName, ModifyFlowPermissionPayload permissions)

Modify Run-Only Users

ListMyFlows (string environmentName)

List My Flows

CreateFlow (string environmentName, Flow Flow)

Create Flow

GetFlow (string environmentName, string flowName)

Get Flow

DeleteFlow (string environmentName, string flowName)

Delete Flow

UpdateFlow (string environmentName, string flowName, Flow Flow)

Update Flow

StopFlow (string environmentName, string flowName)

Stop Flow

StartFlow (string environmentName, string flowName)

Start Flow

ListFlowsInEnvironment (string environmentName)

List Flows as Admin

AdminModifyFlowOwners (string environmentName, string flowName, ModifyFlowPermissionPayload permissions)

Modify Flow Owners as Admin

AdminGetFlow (string environmentName, string flowName)

Get Flow as Admin

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

Api

 

ApiConnectionParameters

 

ApiProperties

 

ApiPropertiesWithoutConnectionParameters

 

ApiWithoutConnectionParameters

 

Connection

 

ConnectionProperties

 

ConnectionPropertiesWithoutConnectionParameters

 

ConnectionReference

 

ConnectionWithoutConnectionParameters

 

Environment

 

EnvironmentProperties

 

Flow

 

FlowPermission

 

FlowPermission[Add]

 

FlowPermission[Remove]

 

FlowProperties

 

ModifyFlowPermissionPayload

 

PermissionProperties

 

PermissionProperties[Add]

 

PermissionProperties[Remove]

 

Principal

 

Principal[Add]

 

Principal[Remove]

 

ResourceArray[ApiWithoutConnectionParameters]

 

ResourceArray[ConnectionWithoutConnectionParameters]

 

ResourceArray[Environment]

 

ResourceArray[FlowPermission]

 

ResourceArray[Flow]

 

 

Actions:

ListApis

Summary: List Connectors

Description: Lists all of the connectors available in the given environment. This list will include custom connectors as well as the built-in connectors.

 

Syntax:

Flowmanagement.ListApis (string environmentName)

 

Parameters:

Name

Type

Summary

Required

Related Action

environmentName

string

(Environment)

Select environment

True

ListUserEnvironments

 

Returns:

          Type:ResourceArray[ApiWithoutConnectionParameters]

 

GetApi

Summary: Get Connector

Description: Get the given connector in an environment.

 

Syntax:

Flowmanagement.GetApi (string environmentName, string apiName)

 

Parameters:

Name

Type

Summary

Required

Related Action

environmentName

string

(Environment)

Select environment

True

ListUserEnvironments

apiName

string

(Connector)

Select connector

True

ListApis

 

Returns:

          Type:Api

 

CreateConnection

Summary: Create Connection

Description: Create a connection for the given connector in an environment.

 

Syntax:

Flowmanagement.CreateConnection (string environmentName, string apiName, [Optional]Connection connection)

 

Parameters:

Name

Type

Summary

Required

Related Action

environmentName

string

(Environment)

Select environment

True

ListUserEnvironments

apiName

string

(Connector)

Select connector

True

ListApis

connection

Connection

 

 

False

 

Returns:

          Type:Connection

 

ListConnections

Summary: List My Connections

Description: Lists all your connection available in the given environment.

 

Syntax:

Flowmanagement.ListConnections (string environmentName)

 

Parameters:

Name

Type

Summary

Required

Related Action

environmentName

string

(Environment)

Select environment

True

ListUserEnvironments

 

Returns:

          Type:ResourceArray[ConnectionWithoutConnectionParameters]

 

ListUserEnvironments

Summary: List My Environments

Description: List the environments you have access to.

 

Syntax:

Flowmanagement.ListUserEnvironments ()

 

Returns:

          Type:ResourceArray[Environment]

 

ListFlowOwners

Summary: List Flow Owners

Description: List all owners of the given flow in an environment.

 

Syntax:

Flowmanagement.ListFlowOwners (string environmentName, string flowName)

 

Parameters:

Name

Type

Summary

Required

Related Action

environmentName

string

(Environment)

Select environment

True

ListUserEnvironments

flowName

string

(Flow)

Select flow

True

ListMyFlows

 

Returns:

          Type:ResourceArray[FlowPermission]

 

ModifyFlowOwners

Summary: Modify Flow Owners

Description: Modify owners of the given flow in an environment.

 

Syntax:

Flowmanagement.ModifyFlowOwners (string environmentName, string flowName, ModifyFlowPermissionPayload permissions)

 

Parameters:

Name

Type

Summary

Required

Related Action

environmentName

string

(Environment)

Select environment

True

ListUserEnvironments

flowName

string

(Flow)

Select flow

True

ListMyFlows

permissions

ModifyFlowPermissionPayload

 

 

True

 

Returns:

 

ListFlowUsers

Summary: List Flow Run-Only Users

Description: List all run only users of the given flow in an environment.

 

Syntax:

Flowmanagement.ListFlowUsers (string environmentName, string flowName)

 

Parameters:

Name

Type

Summary

Required

Related Action

environmentName

string

(Environment)

Select environment

True

ListUserEnvironments

flowName

string

(Flow)

Select flow

True

ListMyFlows

 

Returns:

          Type:ResourceArray[FlowPermission]

 

ModifyRunOnlyUsers

Summary: Modify Run-Only Users

Description: Modify run-only users of the given flow in an environment.

 

Syntax:

Flowmanagement.ModifyRunOnlyUsers (string environmentName, string flowName, ModifyFlowPermissionPayload permissions)

 

Parameters:

Name

Type

Summary

Required

Related Action

environmentName

string

(Environment)

Select environment

True

ListUserEnvironments

flowName

string

(Flow)

Select flow

True

ListMyFlows

permissions

ModifyFlowPermissionPayload

 

 

True

 

Returns:

 

ListMyFlows

Summary: List My Flows

Description: List all flows you created in the given environment.

 

Syntax:

Flowmanagement.ListMyFlows (string environmentName)

 

Parameters:

Name

Type

Summary

Required

Related Action

environmentName

string

(Environment)

Select environment

True

ListUserEnvironments

 

Returns:

          Type:ResourceArray[Flow]

 

CreateFlow

Summary: Create Flow

Description: Create flow

 

Syntax:

Flowmanagement.CreateFlow (string environmentName, Flow Flow)

 

Parameters:

Name

Type

Summary

Required

Related Action

environmentName

string

(Environment)

Select environment

True

ListUserEnvironments

Flow

Flow

 

 

True

 

Returns:

          Type:Flow

 

GetFlow

Summary: Get Flow

Description: Get the given flow in an environment.

 

Syntax:

Flowmanagement.GetFlow (string environmentName, string flowName)

 

Parameters:

Name

Type

Summary

Required

Related Action

environmentName

string

(Environment)

Select environment

True

ListUserEnvironments

flowName

string

(Flow)

Select flow

True

ListMyFlows

 

Returns:

          Type:Flow

 

DeleteFlow

Summary: Delete Flow

Description: Delete the given flow in an environment

 

Syntax:

Flowmanagement.DeleteFlow (string environmentName, string flowName)

 

Parameters:

Name

Type

Summary

Required

Related Action

environmentName

string

(Environment)

Select environment

True

ListUserEnvironments

flowName

string

(Flow)

Select flow

True

ListMyFlows

 

Returns:

 

UpdateFlow

Summary: Update Flow

Description: Update the given flow in an environment.

 

Syntax:

Flowmanagement.UpdateFlow (string environmentName, string flowName, Flow Flow)

 

Parameters:

Name

Type

Summary

Required

Related Action

environmentName

string

(Environment)

Select environment

True

ListUserEnvironments

flowName

string

(Flow)

Select flow

True

ListMyFlows

Flow

Flow

 

 

True

 

Returns:

          Type:Flow

 

StopFlow

Summary: Stop Flow

Description: Stop the given flow in an environment.

 

Syntax:

Flowmanagement.StopFlow (string environmentName, string flowName)

 

Parameters:

Name

Type

Summary

Required

Related Action

environmentName

string

(Environment)

Select environment

True

ListUserEnvironments

flowName

string

(Flow)

Select flow

True

ListMyFlows

 

Returns:

 

StartFlow

Summary: Start Flow

Description: Start the given flow in an environment.

 

Syntax:

Flowmanagement.StartFlow (string environmentName, string flowName)

 

Parameters:

Name

Type

Summary

Required

Related Action

environmentName

string

(Environment)

Select environment

True

ListUserEnvironments

flowName

string

(Flow)

Select flow

True

ListMyFlows

 

Returns:

 

ListFlowsInEnvironment

Summary: List Flows as Admin

Description: List all flows in the given environment you have admin access to.

 

Syntax:

Flowmanagement.ListFlowsInEnvironment (string environmentName)

 

Parameters:

Name

Type

Summary

Required

Related Action

environmentName

string

(Environment)

Select environment

True

ListUserEnvironments

 

Returns:

          Type:ResourceArray[Flow]

 

AdminModifyFlowOwners

Summary: Modify Flow Owners as Admin

Description: Modify owners of the given flow created in an environment you have admin access to.

 

Syntax:

Flowmanagement.AdminModifyFlowOwners (string environmentName, string flowName, ModifyFlowPermissionPayload permissions)

 

Parameters:

Name

Type

Summary

Required

Related Action

environmentName

string

(Environment)

Select environment

True

ListUserEnvironments

flowName

string

(Flow)

Select flow

True

ListFlowsInEnvironment

permissions

ModifyFlowPermissionPayload

 

 

True

 

Returns:

 

AdminGetFlow

Summary: Get Flow as Admin

Description: Get the given flow from an environment you have admin access to.

 

Syntax:

Flowmanagement.AdminGetFlow (string environmentName, string flowName)

 

Parameters:

Name

Type

Summary

Required

Related Action

environmentName

string

(Environment)

Select environment

True

ListUserEnvironments

flowName

string

(Flow)

Select flow

True

ListFlowsInEnvironment

 

Returns:

          Type:Flow

 


 

Api

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Connector Name

 

properties

ApiProperties

 

 


 

ApiConnectionParameters

Summary:

Description: API connection parameters

 

          Properties:

Name

Type

Summary


 

ApiProperties

Summary:

Description:

 

          Properties:

Name

Type

Summary

displayName

string

Connector Display Name

 

createdTime

string(date-time)

Connection Created Time

 

connectionParameters

ApiConnectionParameters

 

API connection parameters

primaryRuntimeUrl

string

Connector Runtime Url

 

iconUri

string

Connector Icon Url

 


 

ApiPropertiesWithoutConnectionParameters

Summary:

Description:

 

          Properties:

Name

Type

Summary

displayName

string

Connector Display Name

 

createdTime

string(date-time)

Connection Created Time

 

primaryRuntimeUrl

string

Connector Runtime Url

 

iconUri

string

Connector Icon Url

 


 

ApiWithoutConnectionParameters

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Connector Name

 

properties

ApiPropertiesWithoutConnectionParameters

 

 


 

Connection

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Connection Name

 

properties

ConnectionProperties

 

 


 

ConnectionProperties

Summary:

Description:

 

          Properties:

Name

Type

Summary

displayName

string

Connector Display Name

 

apiId

string

Connector Id

 

createdTime

string(date-time)

Connection Created Time

 

lastModifiedTime

string(date-time)

Connection Last Modified Time

 

connectionParameters

ApiConnectionParameters

 

API connection parameters


 

ConnectionPropertiesWithoutConnectionParameters

Summary:

Description:

 

          Properties:

Name

Type

Summary

displayName

string

Connector Display Name

 

apiId

string

Connector Id

 

createdTime

string(date-time)

Connection Created Time

 

lastModifiedTime

string(date-time)

Connection Last Modified Time

 


 

ConnectionReference

Summary:

Description:

 

          Properties:

Name

Type

Summary

connectionName

string

Connection Name

 

displayName

string

Connection Display Name

 

id

string

Connector Id

 


 

ConnectionWithoutConnectionParameters

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Connection Name

 

properties

ConnectionPropertiesWithoutConnectionParameters

 

 


 

Environment

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Environment Name

 

location

string

Environment Location

 

properties

EnvironmentProperties

 

 


 

EnvironmentProperties

Summary:

Description:

 

          Properties:

Name

Type

Summary

displayName

string

Environment Display Name

 

description

string

Environment Description

 

createdTime

string(date-time)

Environment Created Time

 

lastModifiedTime

string(date-time)

Environment Last Modified Time

 

provisioningState

string

Environment Provisioning State

Values: [NotSpecified, Succeeded, Deleting, Deleted, Failed, FailedDeleting]

creationType

string

Environment Creation Type

Values: [NotSpecified, Legacy, DefaultTenant, User, CommonDataModelLegacy, Partner, Developer]

environmentSku

string

Environment Sku

Values: [NotSpecified, Standard, Premium, Developer, Basic]

environmentType

string

Environment Type

Values: [NotSpecified, Production, Sandbox]

isDefault

boolean

Is Default Environment

 


 

Flow

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Flow Name

 

properties

FlowProperties

 

 


 

FlowPermission

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Permission Name

 

properties

PermissionProperties

 

 


 

FlowPermission[Add]

Summary:

Description:

 

          Properties:

Name

Type

Summary

properties

PermissionProperties[Add]

 

 


 

FlowPermission[Remove]

Summary:

Description:

 

          Properties:

Name

Type

Summary

properties

PermissionProperties[Remove]

 

 


 

FlowProperties

Summary:

Description:

 

          Properties:

Name

Type

Summary

displayName

string

Flow Display Name

 

definition

string

Flow Definition

 

state

string

Flow State

Values: [Started, Stopped, Suspended]

connectionReferences

array of (ConnectionReference)

 

 

createdTime

string(date-time)

Flow Created Time

 

lastModifiedTime

string(date-time)

Flow Modified Time

 

templateName

string

Flow Template Name

 

flowTriggerUri

string

Flow Trigger Uri

 

installationStatus

string

Flow Installation Status

Values: [NotApplicable, Uninstalled, Broken, Installed]


 

ModifyFlowPermissionPayload

Summary:

Description:

 

          Properties:

Name

Type

Summary

put

array of (FlowPermission[Add])

 

 

delete

array of (FlowPermission[Remove])

 

 


 

PermissionProperties

Summary:

Description:

 

          Properties:

Name

Type

Summary

roleName

string

 

Values: [Owner, CanEdit, CanView]

principal

Principal

 

 


 

PermissionProperties[Add]

Summary:

Description:

 

          Properties:

Name

Type

Summary

principal

Principal[Add]

 

 


 

PermissionProperties[Remove]

Summary:

Description:

 

          Properties:

Name

Type

Summary

principal

Principal[Remove]

 

 


 

Principal

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Object Id

 

displayName

string

Display Name

 

email

string

Email

 

type

string

Type

Values: [User, Group]

tenantId

string

Tenant Id

 

userPrincipalName

string

Principal Name

 

thumbnailPhoto

string

Owner Thumbnail Photo

 


 

Principal[Add]

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Add User Object Id

 

type

string

Add User Type

Values: [User, Group]


 

Principal[Remove]

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Remove User Object Id

 

type

string

Remove User Type

Values: [User, Group]


 

ResourceArray[ApiWithoutConnectionParameters]

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

array of (ApiWithoutConnectionParameters)

 

 


 

ResourceArray[ConnectionWithoutConnectionParameters]

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

array of (ConnectionWithoutConnectionParameters)

 

 


 

ResourceArray[Environment]

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

array of (Environment)

 

 


 

ResourceArray[FlowPermission]

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

array of (FlowPermission)

 

 


 

ResourceArray[Flow]

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

array of (Flow)