Connectors Reference

Common Data Service (current environment)

Provides access to the org-based database on Microsoft Common Data Service in current environment.

 

Status: Production

Tier: Premium

Version: 1.0

 

Actions:

Name

Summary

GetMetadataForGetEntity (string entityName, [advanced][Optional]string selectedEntityAttributes, [advanced][Optional]string expandEntityAttributes)

Get table metadata

GetActivityPartyAttributes (string entityName)

Get activity party attributes

GetMetadataForPostEntity (string entityName)

Get table metadata - Post

GetMetadataForPatchEntity (string entityName)

Get table metadata - Patch

GetEntityRelationships (string entityName)

 

GetAttributeFilters (string entityName, [advanced][Optional]array attributeTypeNames)

Get attribute filters

GetScopeFilters (string entityName)

Get scope filters

GetOptionSetMetadata (string entityName, string attributeMetadataId, string type)

Retrieves the metadata for option set attribute metadata

GetEntities ()

 

ListRecords ([internal][Optional]string prefer, [internal][Optional]string accept, string entityName, [advanced][Optional]string $select, [advanced][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]string $expand, [advanced][Optional]string fetchXml, [advanced][Optional]integer $top, [advanced][Optional]string $skiptoken, [advanced][Optional]string partitionId)

List rows

CreateRecord ([internal]string prefer, [internal]string accept, string entityName, CreateRecordParameterItem item)

Add a new row

GetItem ([internal]string prefer, [internal]string accept, string entityName, string recordId, [advanced][Optional]string $select, [advanced][Optional]string $expand, [advanced][Optional]string partitionId)

Get a row by ID

DeleteRecord (string entityName, string recordId, [advanced][Optional]string partitionId)

Delete a row

UpdateRecord ([internal]string prefer, [internal]string accept, string entityName, string recordId, UpdateRecordParameterItem item)

Update a row

Predict (string modelId, PredictRequest item)

Predict

GetPredictionSchema (string recordId, [Optional]string predictionMode)

Get schema for predict operation

PredictV2 (string recordId, PredictV2ParameterItem item)

Predict using AI Builder models

PredictByReference (string recordId, PredictByReferenceParameterItem item)

Predict By Reference

AssociateEntities (string entityName, string recordId, string associationEntityRelationship, AssociateEntityRequest item)

Relate rows

DisassociateEntities (string entityName, string recordId, string associationEntityRelationship, string $id)

Unrelate rows

GetMetadataForUnboundActionInput (string actionName)

Get metadata for unbound action input

GetMetadataForBoundActionInput (string entityName, string actionName)

Get metadata for bound action input

GetMetadataForUnboundActionResponse (string actionName)

Get metadata for unbound action response

GetMetadataForBoundActionResponse (string entityName, string actionName)

Get metadata for bound action response

GetUnboundActions ()

 

GetBoundActions (string entityName)

 

PerformUnboundAction (string actionName, [Optional]PerformUnboundActionParameterItem item)

Perform an unbound action

PerformBoundAction (string entityName, string actionName, string recordId, [Optional]PerformBoundActionParameterItem item)

Perform a bound action

ExecuteChangeset ()

Perform a changeset request

UpdateEntityFileImageFieldContent ([internal]string content-type, string entityName, string recordId, string fileImageFieldName, string item, [advanced]string x-ms-file-name)

Upload a file or an image

GetEntityFileImageFieldContent ([internal]string Range, string entityName, string recordId, string fileImageFieldName, [advanced][Optional]string size)

Download a file or an image

 

Triggers:

Name

Summary

SubscribeWebhookTrigger ([internal]string Consistency, [internal][Optional]string catalog, [internal][Optional]string category, CallbackRegistration subscriptionRequest)

When a row is added, modified or deleted

FlowStepRun ()

When a flow step is run from a business process flow

 

Objects:

Name

Summary

ActionsDynamicValuesList

 

AssociateEntityRequest

 

CallbackRegistration

 

CreateRecordParameterItem

 

CreateRecordResponse

 

DisplayCollectionName

 

EntitiesDynamicValuesList

 

EntitiesDynamicValuesListItem

 

EntityItem

 

EntityItemList

 

EntityMetadata

 

EntityRelationshipsDynamicValuesList

 

FlowStepMetadata

 

GetItemResponse

 

GetMetadataForBoundActionInputResponse

 

GetMetadataForBoundActionResponseResponse

 

GetMetadataForUnboundActionInputResponse

 

GetMetadataForUnboundActionResponseResponse

 

GetPredictionSchemaResponse

 

Object

 

PerformBoundActionParameterItem

 

PerformBoundActionResponse

 

PerformUnboundActionParameterItem

 

PerformUnboundActionResponse

 

PredictByReferenceParameterItem

 

PredictByReferenceResponse

 

PredictRequest

 

PredictResponse

 

PredictV2ParameterItem

 

PredictV2Response

 

UpdateRecordParameterItem

 

UpdateRecordResponse

 

UserLocalizedLabel

 

 

Actions:

GetMetadataForGetEntity

Summary: Get table metadata

Description: Gets table metadata

 

Syntax:

CommonDataService(currentenvironment).GetMetadataForGetEntity (string entityName, [advanced][Optional]string selectedEntityAttributes, [advanced][Optional]string expandEntityAttributes)

 

Parameters:

Name

Type

Summary

Required

Related Action

entityName

string

(Table name)

Name of the table

True

selectedEntityAttributes

string

(Select Query)

Limit the properties returned while retrieving data

False

expandEntityAttributes

string

(Expand Query)

Related entries to include with requested entries (default = none)

False

 

Returns:

          Type:EntityMetadata

          Description: Entity metadata

 

GetActivityPartyAttributes

Summary: Get activity party attributes

Description: Get activity party attributes

 

Syntax:

CommonDataService(currentenvironment).GetActivityPartyAttributes (string entityName)

 

Parameters:

Name

Type

Summary

Required

Related Action

entityName

string

(Table name)

Name of the table

True

 

Returns:

          Type:Object

 

GetMetadataForPostEntity

Summary: Get table metadata - Post

Description: Gets table metadata for post operation

 

Syntax:

CommonDataService(currentenvironment).GetMetadataForPostEntity (string entityName)

 

Parameters:

Name

Type

Summary

Required

Related Action

entityName

string

(Table name)

Name of the table

True

 

Returns:

          Type:EntityMetadata

          Description: Entity metadata

 

GetMetadataForPatchEntity

Summary: Get table metadata - Patch

Description: Gets table metadata for patch operation

 

Syntax:

CommonDataService(currentenvironment).GetMetadataForPatchEntity (string entityName)

 

Parameters:

Name

Type

Summary

Required

Related Action

entityName

string

(Table name)

Name of the table

True

 

Returns:

          Type:EntityMetadata

          Description: Entity metadata

 

GetEntityRelationships

Summary:

Description:

 

Syntax:

CommonDataService(currentenvironment).GetEntityRelationships (string entityName)

 

Parameters:

Name

Type

Summary

Required

Related Action

entityName

string

(Table name)

Name of the table

True

 

Returns:

          Type:EntityRelationshipsDynamicValuesList

          Description: List of table relationship as dynamic values.

 

GetAttributeFilters

Summary: Get attribute filters

Description: Returns list of attribute filters

 

Syntax:

CommonDataService(currentenvironment).GetAttributeFilters (string entityName, [advanced][Optional]array attributeTypeNames)

 

Parameters:

Name

Type

Summary

Required

Related Action

entityName

string

(Table name)

Name of the table

True

attributeTypeNames

array of (string)

(Attribute type names)

Enter the attribute type names

False

 

Returns:

          Type:array of (string)

 

GetScopeFilters

Summary: Get scope filters

Description: Get scope filters for a given table

 

Syntax:

CommonDataService(currentenvironment).GetScopeFilters (string entityName)

 

Parameters:

Name

Type

Summary

Required

Related Action

entityName

string

(Table name)

Name of the table

True

 

Returns:

          Type:array of (string)

 

GetOptionSetMetadata

Summary: Retrieves the metadata for option set attribute metadata

Description: Retrieves the metadata for option set attribute metadata

 

Syntax:

CommonDataService(currentenvironment).GetOptionSetMetadata (string entityName, string attributeMetadataId, string type)

 

Parameters:

Name

Type

Summary

Required

Related Action

entityName

string

(Table name)

Table name

True

attributeMetadataId

string

(The attribute)

The attribute

True

type

string

(type of option set)

type of option set

True

 

Returns:

          Type:Object

 

GetEntities

Summary:

Description:

 

Syntax:

CommonDataService(currentenvironment).GetEntities ()

 

Returns:

          Type:EntitiesDynamicValuesList

          Description: List of tables as dynamic values.

 

ListRecords

Summary: List rows

Description: This action allows you to list the rows in a Common Data Service table that match the selected options.

 

Syntax:

CommonDataService(currentenvironment).ListRecords ([internal][Optional]string prefer, [internal][Optional]string accept, string entityName, [advanced][Optional]string $select, [advanced][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]string $expand, [advanced][Optional]string fetchXml, [advanced][Optional]integer $top, [advanced][Optional]string $skiptoken, [advanced][Optional]string partitionId)

 

Parameters:

Name

Type

Summary

Required

Related Action

prefer

string

(Prefer)

The header parameter required to make CDS return the created resource

False

accept

string

(Accept)

The header parameter required to make CDS return the odata id

False

entityName

string

(Table name)

Choose a table

True

GetEntities

$select

string

(Select columns)

Enter a comma-separated list of column unique names to limit which columns are listed

False

$filter

string

(Filter rows)

Enter an OData style filter expression to limit which rows are listed

False

$orderby

string

(Sort By)

Enter an Odata style orderBy query to sort the rows

False

$expand

string

(Expand Query)

Enter an Odata style expand query to list related rows

False

fetchXml

string

(Fetch Xml Query)

Enter a Fetch XML query for advanced customization

False

$top

integer(int32)

(Row count)

Enter the number of rows to be listed (default = all)

False

$skiptoken

string

(Skip token)

Enter the skip token obtained from a previous run to list rows from the next page

False

partitionId

string

(Partition ID)

An option to specify the partitionId while retrieving data for NoSQL tables

False

 

Returns:

          Type:EntityItemList

          Description: List of tables

 

CreateRecord

Summary: Add a new row

Description: This action allows you to add a new row in the selected Common Data Service table.

 

Syntax:

CommonDataService(currentenvironment).CreateRecord ([internal]string prefer, [internal]string accept, string entityName, CreateRecordParameterItem item)

 

Parameters:

Name

Type

Summary

Required

Related Action

prefer

string

(Prefer)

The header parameter required to make CDS return the created resource

True

accept

string

(Accept)

The header parameter required to make CDS return the odata id

True

entityName

string

(Table name)

Choose a table

True

GetEntities

item

CreateRecordParameterItem

 

 

True

 

Returns:

          Type:CreateRecordResponse

 

GetItem

Summary: Get a row by ID

Description: This action allows you to get the row that matches an ID in a Common Data Service table.

 

Syntax:

CommonDataService(currentenvironment).GetItem ([internal]string prefer, [internal]string accept, string entityName, string recordId, [advanced][Optional]string $select, [advanced][Optional]string $expand, [advanced][Optional]string partitionId)

 

Parameters:

Name

Type

Summary

Required

Related Action

prefer

string

(Prefer)

The header parameter required to make CDS return the created resource

True

accept

string

(Accept)

The header parameter required to make CDS return the odata id

True

entityName

string

(Table name)

Choose a table

True

GetEntities

recordId

string

(Row ID)

Enter the row's globally unique identifier (GUID)

True

$select

string

(Select columns)

Enter a comma-separated list of column unique names to limit which columns are listed

False

$expand

string

(Expand Query)

Enter an Odata style expand query to list related rows

False

partitionId

string

(Partition Id)

An option to specify the partitionId while retrieving data for NoSQL tables

False

 

Returns:

          Type:GetItemResponse

 

DeleteRecord

Summary: Delete a row

Description: This action allows you to delete a row from a Common Data Service table.

 

Syntax:

CommonDataService(currentenvironment).DeleteRecord (string entityName, string recordId, [advanced][Optional]string partitionId)

 

Parameters:

Name

Type

Summary

Required

Related Action

entityName

string

(Table name)

Choose a table

True

GetEntities

recordId

string

(Row ID)

Enter the row's globally unique identifier (GUID)

True

partitionId

string

(Partition Id)

An option to specify the partitionId while deleting row for NoSQL tables

False

 

Returns:

 

UpdateRecord

Summary: Update a row

Description: This action allows you to modify any selected row in a Common Data Service table, or adds a new row if it doesn’t exist.

 

Syntax:

CommonDataService(currentenvironment).UpdateRecord ([internal]string prefer, [internal]string accept, string entityName, string recordId, UpdateRecordParameterItem item)

 

Parameters:

Name

Type

Summary

Required

Related Action

prefer

string

(Prefer)

The header parameter required to make CDS return the created resource

True

accept

string

(Accept)

The header parameter required to make CDS return the odata id

True

entityName

string

(Table name)

Choose a table

True

GetEntities

recordId

string

(Row ID)

Enter the row's globally unique identifier (GUID)

True

item

UpdateRecordParameterItem

 

 

True

 

Returns:

          Type:UpdateRecordResponse

 

Predict

Summary: Predict

Description: Predict

 

Syntax:

CommonDataService(currentenvironment).Predict (string modelId, PredictRequest item)

 

Parameters:

Name

Type

Summary

Required

Related Action

modelId

string

(Model)

Choose an option or add your own

True

ListRecords

item

PredictRequest

 

 

True

 

Returns:

          Type:PredictResponse

 

GetPredictionSchema

Summary: Get schema for predict operation

Description: Gets operation schema for predict operation.

 

Syntax:

CommonDataService(currentenvironment).GetPredictionSchema (string recordId, [Optional]string predictionMode)

 

Parameters:

Name

Type

Summary

Required

Related Action

recordId

string

(Model)

Model id

True

predictionMode

string

(Prediction Mode)

 

False

 

Returns:

          Type:GetPredictionSchemaResponse

 

PredictV2

Summary: Predict using AI Builder models

Description: This action allows you to use the AI Builder models in your Common Data Service environment for predictions. Common models include Form Processing, Object Detection, Text Classification or use the prebuilt Business Card Reader, Key phrase extraction, Language detection, Text recognition – OCR and Sentiment Analysis.

 

Syntax:

CommonDataService(currentenvironment).PredictV2 (string recordId, PredictV2ParameterItem item)

 

Parameters:

Name

Type

Summary

Required

Related Action

recordId

string

(Model name)

Choose a model

True

ListRecords

item

PredictV2ParameterItem

 

 

True

 

Returns:

          Type:PredictV2Response

 

PredictByReference

Summary: Predict By Reference

Description: Use AI Builder models with a CDS row Id. With the predict action you can use your custom AI Builder Models of Form Processing, Object Detection, Text Classification or use the prebuilt Business Card Reader, Key phrase extraction, Language detection, Text recognition – OCR and Sentiment Analysis.

 

Syntax:

CommonDataService(currentenvironment).PredictByReference (string recordId, PredictByReferenceParameterItem item)

 

Parameters:

Name

Type

Summary

Required

Related Action

recordId

string

(Model)

Choose an option or add your own

True

item

PredictByReferenceParameterItem

 

 

True

 

Returns:

          Type:PredictByReferenceResponse

 

AssociateEntities

Summary: Relate rows

Description: This action allows you to link a row in one Common Data Service table to another if the tables have a one-to-many or many-to-many relationship.

 

Syntax:

CommonDataService(currentenvironment).AssociateEntities (string entityName, string recordId, string associationEntityRelationship, AssociateEntityRequest item)

 

Parameters:

Name

Type

Summary

Required

Related Action

entityName

string

(Table name)

Choose a table

True

GetEntities

recordId

string

(Row ID)

Enter the row's globally unique identifier (GUID)

True

associationEntityRelationship

string

(Relationship)

Choose relationship type

True

item

AssociateEntityRequest

 

 

True

 

Returns:

 

DisassociateEntities

Summary: Unrelate rows

Description: This action allows you to remove the link between a row in one Common Data Service table to another if the tables have a one-to-many or many-to-many relationship.

 

Syntax:

CommonDataService(currentenvironment).DisassociateEntities (string entityName, string recordId, string associationEntityRelationship, string $id)

 

Parameters:

Name

Type

Summary

Required

Related Action

entityName

string

(Table name)

Choose a table

True

GetEntities

recordId

string

(Row ID)

Enter the row's globally unique identifier (GUID)

True

associationEntityRelationship

string

(Relationship)

Choose relationship type

True

$id

string

(Unrelate with)

Enter the row URL using OData ID from a previous step or typing the full URL (eg. https://org0.crm.dynamics.com/api/data/v9.0/faxes(3ce6c728-3c8a-4b55-a4ee-a251b253c3ee)

True

 

Returns:

 

GetMetadataForUnboundActionInput

Summary: Get metadata for unbound action input

Description: This operation fetches metadata for an unbound action input.

 

Syntax:

CommonDataService(currentenvironment).GetMetadataForUnboundActionInput (string actionName)

 

Parameters:

Name

Type

Summary

Required

Related Action

actionName

string

(Action Name)

Name of the action

True

 

Returns:

          Type:GetMetadataForUnboundActionInputResponse

 

GetMetadataForBoundActionInput

Summary: Get metadata for bound action input

Description: This operation fetches metadata for an bound action input.

 

Syntax:

CommonDataService(currentenvironment).GetMetadataForBoundActionInput (string entityName, string actionName)

 

Parameters:

Name

Type

Summary

Required

Related Action

entityName

string

(Table name)

Name of the Table

True

actionName

string

(Action Name)

Name of the action

True

 

Returns:

          Type:GetMetadataForBoundActionInputResponse

 

GetMetadataForUnboundActionResponse

Summary: Get metadata for unbound action response

Description: This operation fetches metadata for an unbound action response.

 

Syntax:

CommonDataService(currentenvironment).GetMetadataForUnboundActionResponse (string actionName)

 

Parameters:

Name

Type

Summary

Required

Related Action

actionName

string

(Action Name)

Name of the action

True

 

Returns:

          Type:GetMetadataForUnboundActionResponseResponse

 

GetMetadataForBoundActionResponse

Summary: Get metadata for bound action response

Description: This operation fetches metadata for a bound action response.

 

Syntax:

CommonDataService(currentenvironment).GetMetadataForBoundActionResponse (string entityName, string actionName)

 

Parameters:

Name

Type

Summary

Required

Related Action

entityName

string

(Table name)

Name of the table

True

actionName

string

(Action Name)

Name of the action

True

 

Returns:

          Type:GetMetadataForBoundActionResponseResponse

 

GetUnboundActions

Summary:

Description:

 

Syntax:

CommonDataService(currentenvironment).GetUnboundActions ()

 

Returns:

          Type:ActionsDynamicValuesList

          Description: List of actions as dynamic values

 

GetBoundActions

Summary:

Description:

 

Syntax:

CommonDataService(currentenvironment).GetBoundActions (string entityName)

 

Parameters:

Name

Type

Summary

Required

Related Action

entityName

string

(Table name)

Table name

True

 

Returns:

          Type:ActionsDynamicValuesList

          Description: List of actions as dynamic values

 

PerformUnboundAction

Summary: Perform an unbound action

Description: This action allows you to perform Common Data Service actions available in the environment that are not associated with any table.

 

Syntax:

CommonDataService(currentenvironment).PerformUnboundAction (string actionName, [Optional]PerformUnboundActionParameterItem item)

 

Parameters:

Name

Type

Summary

Required

Related Action

actionName

string

(Action Name)

Choose an action

True

GetUnboundActions

item

PerformUnboundActionParameterItem

 

 

False

 

Returns:

          Type:PerformUnboundActionResponse

 

PerformBoundAction

Summary: Perform a bound action

Description: This action allows you to perform Common Data Service actions associated with a selected table.

 

Syntax:

CommonDataService(currentenvironment).PerformBoundAction (string entityName, string actionName, string recordId, [Optional]PerformBoundActionParameterItem item)

 

Parameters:

Name

Type

Summary

Required

Related Action

entityName

string

(Table name)

Choose a table

True

GetEntities

actionName

string

(Action Name)

Choose an action

True

GetBoundActions

recordId

string

(Row ID)

Enter the row's globally unique identifier (GUID)

True

item

PerformBoundActionParameterItem

 

 

False

 

Returns:

          Type:PerformBoundActionResponse

 

ExecuteChangeset

Summary: Perform a changeset request

Description: This action allows you to perform a group of Common Data Service connector operations as a single transaction. If one of the operations fails, all the successful actions are rolled back.

 

Syntax:

CommonDataService(currentenvironment).ExecuteChangeset ()

 

Returns:

 

UpdateEntityFileImageFieldContent

Summary: Upload a file or an image

Description: This action allows you to upload a file or an image content to a Common Data Service table with a compatible column type.

 

Syntax:

CommonDataService(currentenvironment).UpdateEntityFileImageFieldContent ([internal]string content-type, string entityName, string recordId, string fileImageFieldName, string item, [advanced]string x-ms-file-name)

 

Parameters:

Name

Type

Summary

Required

Related Action

content-type

string

(Content-Type)

The header describing the content type

True

entityName

string

(Table name)

Choose a table

True

GetEntities

recordId

string

(Row ID)

Enter the row's globally unique identifier (GUID)

True

fileImageFieldName

string

(Column name)

Choose a column

True

item

string(binary)

 

 

True

x-ms-file-name

string

(Content name)

Enter a name for the file or image

True

 

Returns:

 

GetEntityFileImageFieldContent

Summary: Download a file or an image

Description: This action allows you to download a file or an image content from a Common Data Service table.

 

Syntax:

CommonDataService(currentenvironment).GetEntityFileImageFieldContent ([internal]string Range, string entityName, string recordId, string fileImageFieldName, [advanced][Optional]string size)

 

Parameters:

Name

Type

Summary

Required

Related Action

Range

string

(Range)

The header parameter required to make CDS support chunked downloads

True

entityName

string

(Table name)

Choose a table

True

GetEntities

recordId

string

(Row ID)

Enter the row's globally unique identifier (GUID)

True

fileImageFieldName

string

(Column name)

Choose a column

True

size

string

(Image size)

Enter 'full' for entire image if enabled (default = thumbnail)

False

 

Returns:

          Type:string(binary)

          Summary: File or image content

          Description: The content of the file or image

 

Triggers:

Trigger SubscribeWebhookTrigger

Summary: When a row is added, modified or deleted

Description: This trigger allows you to start a flow when a row is added, modified or deleted in a Common Data Service table, such that it matches the selected options.

 

Syntax:

CommonDataService(currentenvironment).SubscribeWebhookTrigger ([internal]string Consistency, [internal][Optional]string catalog, [internal][Optional]string category, CallbackRegistration subscriptionRequest)

 

Parameters:

Name

Type

Summary

Required

Related Action

Consistency

string

(Consistency)

The header parameter required to make CDS by pass the cache and hit DB

True

catalog

string

(catalog)

Using this header parameter to save catalog in flow definition and CDS will ignore as they don't use this info

False

category

string

(category)

Using this header parameter to save category in flow definition and CDS will ignore as they don't use this info

False

subscriptionRequest

CallbackRegistration

 

The callback registration table.

True

 

Returns:

 

Trigger FlowStepRun

Summary: When a flow step is run from a business process flow

Description: This trigger allows you to start a flow when the Run Flow button in a business process flow step is clicked.

 

Syntax:

CommonDataService(currentenvironment).FlowStepRun ()

 

Returns:

          Type:FlowStepMetadata

          Description: Flow step metadata

 


 

ActionsDynamicValuesList

Summary:

Description: List of actions as dynamic values

 

          Properties:

Name

Type

Summary

value

array of (ValueItem)

 

List of actions as dynamic values

 

ValueItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

displayName

string

 

 

value

string

 

 

 


 

AssociateEntityRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

@odata.id

string

Relate with

Enter the row URL using OData ID from a previous step or typing the full URL (eg. https://org0.crm.dynamics.com/api/data/v9.0/faxes(3ce6c728-3c8a-4b55-a4ee-a251b253c3ee)


 

CallbackRegistration

Summary:

Description: The callback registration table.

 

          Properties:

Name

Type

Summary

version

integer

Table version

The callback registration table version

url

string

Notification url

Callback url to the flow engine. Expected as part of the request and provided by Flow.

name

string

Name

Callback registration name. Value will be replaced with workflow id

message

integer

Change type

Choose when the flow triggers

entityname

string

Table name

Choose a table

sdkmessagename

string

Action name

Choose an option or add your own

scope

integer

Scope

Choose a scope to limit which rows can trigger the flow

filteringattributes

string

Column filter

Enter a comma-separated list of column unique names. The flow triggers if any of them are modified

filterexpression

string

Row filter

Enter an OData style filter expression to determine which rows can trigger the flow

postponeuntil

string

Delay until

Enter a time to delay the trigger evaluation, eg. 2020-01-01T10:10:00Z

runas

integer

Run as

Choose the running user for steps where invoker connections are used


 

CreateRecordParameterItem

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

CreateRecordResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

DisplayCollectionName

Summary:

Description: Represents collection of table display names.

 

          Properties:

Name

Type

Summary

UserLocalizedLabel

UserLocalizedLabel

 

Represents user localized label object.


 

EntitiesDynamicValuesList

Summary:

Description: List of tables as dynamic values.

 

          Properties:

Name

Type

Summary

value

array of (EntitiesDynamicValuesListItem)

 

List of tables as dynamic values.


 

EntitiesDynamicValuesListItem

Summary:

Description: Represents a table as dynamic value item.

 

          Properties:

Name

Type

Summary

MetadataId

string

 

The metadata id.

EntitySetName

string

 

The name of the table.

LogicalName

string

 

The logical name of the table.

DisplayCollectionName

DisplayCollectionName

 

Represents collection of table display names.


 

EntityItem

Summary:

Description: A Table item

 

          Properties:

Name

Type

Summary

dynamicProperties

DynamicProperties

 

 

 

DynamicProperties

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

EntityItemList

Summary:

Description: List of tables

 

          Properties:

Name

Type

Summary

value

array of (EntityItem)

 

List of Items

@odata.nextLink

string

Next link

The url to fetch next page data.


 

EntityMetadata

Summary:

Description: Entity metadata

 

          Properties:

Name

Type

Summary

schema

Object

 

 


 

EntityRelationshipsDynamicValuesList

Summary:

Description: List of table relationship as dynamic values.

 

          Properties:

Name

Type

Summary

value

array of (ValueItem)

 

List of table relationships as dynamic values.

 

ValueItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

displayName

string

 

 

value

string

 

 

 


 

FlowStepMetadata

Summary:

Description: Flow step metadata

 

          Properties:

Name

Type

Summary

entity

Entity

 

 

 

Entity

Summary:

Description:

 

          Properties:

Name

Type

Summary

FlowsWorkflowLogId

string

Flows Workflow Log Id

Flow workflow log id

BPFInstanceId

string

BPF Instance Id

Business process flow instance id

BPFInstanceEntityName

string

BPF Instance Table Name

Business process flow instance table name

BPFDefinitionId

string

BPF Definition Id

Business process flow definition id

BPFDefinitionEntityName

string

BPF Definition Table Name

Business process flow definition table name

StepId

string

Step Id

Business process flow step id

BPFDefinitionName

string

BPF Definition Name

Business process flow definition name

BPFInstanceName

string

BPF Instance Name

Business process flow instance name

BPFFlowStageLocalizedName

string

BPF Flow Stage Localized Name

Business process flow stage localized name

BPFFlowStageEntityName

string

BPF Flow Stage Table Name

Business process flow stage table name

BPFFlowStageEntityCollectionName

string

BPF Flow Stage Table Collection Name

Business process flow stage table collection name

BPFFlowStageEntityRecordId

string

BPF Flow Stage Table Row Id

Business process flow stage table row id

BPFActiveStageId

string

BPF Active Stage Id

Business process flow active stage id

BPFActiveStageEntityName

string

BPF Active Stage Table Name

Business process flow active stage table name

BPFActiveStageLocalizedName

string

BPF Active Stage Localized Name

Business process flow active stage localized name

 


 

GetItemResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

GetMetadataForBoundActionInputResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

schema

Object

 

 


 

GetMetadataForBoundActionResponseResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

schema

Object

 

 


 

GetMetadataForUnboundActionInputResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

schema

Object

 

 


 

GetMetadataForUnboundActionResponseResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

schema

Object

 

 


 

GetPredictionSchemaResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

schema

Object

 

 


 

Object

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

PerformBoundActionParameterItem

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

PerformBoundActionResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

PerformUnboundActionParameterItem

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

PerformUnboundActionResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

PredictByReferenceParameterItem

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

PredictByReferenceResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

PredictRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

version

string

Api version

The api version

request

string

Request Payload

String serialized request payload


 

PredictResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

response

string

Response Payload

String serialized response payload.


 

PredictV2ParameterItem

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

PredictV2Response

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

UpdateRecordParameterItem

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

UpdateRecordResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

UserLocalizedLabel

Summary:

Description: Represents user localized label object.

 

          Properties:

Name

Type

Summary

Label

string

 

The display name label of the table.