Common Data Service (current environment)

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

This connector is available in the following products and regions:

Service Class Regions
Power Automate Premium All Power Automate regions
Power Apps Premium All Power Apps regions
Contact
Name Microsoft
URL https://us.flow.microsoft.com/en-us/support/
Connector Metadata
Publisher Microsoft
Website https://flow.microsoft.com/
Privacy policy https://privacy.microsoft.com
Categories Data

Known issues and limitations

  1. In some rare cases, when the same trigger is used across multiple environments, it may fire a flow in a different environment than is expected. As a workaround, change the connector from Common Data Service (current environment) to the Common Data Service connector, which allows the environment to be specified.

Enable upsert behavior

To enable upsert behavior using the Update a row action, please visit Enable upsert behavior page.

Creating a connection

The connector supports the following authentication types:

Default Required parameters for creating connection. All regions

Default

Applicable: All regions

Required parameters for creating connection.

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Create a new row

This operation creates a new row of a table.

Delete a row

This operation deletes a row from an table collection.

Executes a changeset request

Executes a changeset request

Get a row

This operation retrieves the specified row for a table.

Get file or image content

Get file or image content

List rows

List rows for a table.

Perform a bound action

Bound actions target a single table or a set of rows for a single table.

Perform an unbound action

Unbound actions aren’t bound to a table type and are called as static operations.

Predict

Use AI Builder models. 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.

Relate rows

The relate function links two rows that have a one-to-many or many-to-many relationship in the Common Data Service.

Unrelate rows

The unrelate function removes the link between two rows that have a one-to-many or many-to-many relationship in the Common Data Service.

Update a row

This operation updates an existing row for a table.

Upload file or image content

Upload file or image content.

Create a new row

This operation creates a new row of a table.

Parameters

Name Key Required Type Description
Table name
entityName True string

Choose an option or add your own.

Returns

response
object

Delete a row

This operation deletes a row from an table collection.

Parameters

Name Key Required Type Description
Table name
entityName True string

Choose an option or add your own.

Item ID
recordId True string

Enter a globally unique identifier (GUID).

Partition Id
partitionId string

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

Executes a changeset request

Executes a changeset request

Get a row

This operation retrieves the specified row for a table.

Parameters

Name Key Required Type Description
Table name
entityName True string

Choose an option or add your own.

Item ID
recordId True string

Enter a globally unique identifier (GUID).

Select Query
$select string

Limit the properties returned while retrieving data.

Expand Query
$expand string

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

Partition Id
partitionId string

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

Returns

response
object

Get file or image content

Get file or image content

Parameters

Name Key Required Type Description
Table name
entityName True string

Choose an option or add your own.

Item ID
recordId True string

Enter a globally unique identifier (GUID).

Column name
fileImageFieldName True string

Choose an option or add your own.

Image size
size string

Get thumbnail or enter full for entire image, if enabled

Returns

The content of the file or image.

File or image content
binary

List rows

List rows for a table.

Parameters

Name Key Required Type Description
Table name
entityName True string

Choose an option or add your own.

Select Query
$select string

Limit the properties returned while retrieving data.

Filter Query
$filter string

An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).

Order By
$orderby string

An ODATA orderBy query for specifying the order of entries.

Expand Query
$expand string

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

Fetch Xml Query
fetchXml string

Fetch Xml query

Top Count
$top integer

Total number of entries to retrieve (default = all).

Skip token
$skiptoken string

The skip token.

Partition Id
partitionId string

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

Returns

List of tables

Perform a bound action

Bound actions target a single table or a set of rows for a single table.

Parameters

Name Key Required Type Description
Table name
entityName True string

Choose an option or add your own.

Action Name
actionName True string

Choose an option or add your own.

Item ID
recordId True string

Enter a globally unique identifier (GUID).

Returns

response
object

Perform an unbound action

Unbound actions aren’t bound to a table type and are called as static operations.

Parameters

Name Key Required Type Description
Action Name
actionName True string

Choose an option or add your own.

Returns

response
object

Predict

Use AI Builder models. 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.

Parameters

Name Key Required Type Description
Model
recordId True string

Choose an option or add your own.

Returns

response
object

Relate rows

The relate function links two rows that have a one-to-many or many-to-many relationship in the Common Data Service.

Parameters

Name Key Required Type Description
Table name
entityName True string

Choose an option or add your own.

Item ID
recordId True string

Enter a globally unique identifier (GUID).

Relationship
associationEntityRelationship True string

Choose an option or add your own.

URL
@odata.id True string

Enter the full resource address

Unrelate rows

The unrelate function removes the link between two rows that have a one-to-many or many-to-many relationship in the Common Data Service.

Parameters

Name Key Required Type Description
Table name
entityName True string

Choose an option or add your own.

Item ID
recordId True string

Enter a globally unique identifier (GUID).

Relationship
associationEntityRelationship True string

Choose an option or add your own.

URL
$id True string

Enter the full resource address.

Update a row

This operation updates an existing row for a table.

Parameters

Name Key Required Type Description
Table name
entityName True string

Choose an option or add your own.

Item ID
recordId True string

Enter a globally unique identifier (GUID).

Returns

response
object

Upload file or image content

Upload file or image content.

Parameters

Name Key Required Type Description
Table name
entityName True string

Choose an option or add your own.

Item ID
recordId True string

Enter a globally unique identifier (GUID).

Column name
fileImageFieldName True string

Choose an option or add your own.

Content
item True binary

Add file or image content.

Content name
x-ms-file-name True string

Enter a name for the file or image.

Triggers

When a flow step is executed

Triggers a flow when a flow step is executed from business process flow context. (Available only for Power Automate.)

When a row is created, updated or deleted

Triggers a flow when a row is created, updated, or deleted in Dynamics 365.

When a flow step is executed

Triggers a flow when a flow step is executed from business process flow context. (Available only for Power Automate.)

Returns

Name Path Type Description
Flows Workflow Log Id
entity.FlowsWorkflowLogId string

Flow workflow log id.

BPF Instance Id
entity.BPFInstanceId string

Business process flow instance id.

BPF Instance Table Name
entity.BPFInstanceEntityName string

Business process flow instance table name.

BPF Definition Id
entity.BPFDefinitionId string

Business process flow definition id.

BPF Definition Table Name
entity.BPFDefinitionEntityName string

Business process flow definition table name.

Step Id
entity.StepId string

Business process flow step id.

BPF Definition Name
entity.BPFDefinitionName string

Business process flow definition name.

BPF Instance Name
entity.BPFInstanceName string

Business process flow instance name.

BPF Flow Stage Localized Name
entity.BPFFlowStageLocalizedName string

Business process flow stage localized name.

BPF Flow Stage Table Name
entity.BPFFlowStageEntityName string

Business process flow stage table name.

BPF Flow Stage Table Collection Name
entity.BPFFlowStageEntityCollectionName string

Business process flow stage table collection name.

BPF Flow Stage Table Row Id
entity.BPFFlowStageEntityRecordId string

Business process flow stage table row id.

BPF Active Stage Id
entity.BPFActiveStageId string

Business process flow active stage id.

BPF Active Stage Table Name
entity.BPFActiveStageEntityName string

Business process flow active stage table name.

BPF Active Stage Localized Name
entity.BPFActiveStageLocalizedName string

Business process flow active stage localized name.

When a row is created, updated or deleted

Triggers a flow when a row is created, updated, or deleted in Dynamics 365.

Parameters

Name Key Required Type Description
Trigger condition
message True integer

Choose an option or add your own.

The table name
entityname True string

Choose an option or add your own.

Scope
scope True integer

Choose an option or add your own.

Filtering attributes
filteringattributes string

Comma-separated list of attributes. The trigger fires if at least one of these attributes is modified.

Filter expression
filterexpression string

Odata style filter expression. The trigger fires if the filter expression evaluates to true.

Postpone until
postponeuntil string

Time until which the trigger evaluation should be delayed.

Run as
runas integer

User whose context the Flow will run as (only applies if invoker connection is specified).

Returns

A Table item.

Definitions

EntityItemList

List of tables

Name Path Type Description
value
value array of EntityItem

List of Items

Next link
@odata.nextLink string

The url to fetch next page data.

EntityItem

A Table item

Name Path Type Description
dynamicProperties
dynamicProperties object

Object

WebhookNotificationContent

A Table item.

Name Path Type Description
schema
schema Object

object

This is the type 'object'.

binary

This is the basic data type 'binary'.