Microsoft Dataverse

Provides access to the environment database in Microsoft Dataverse.

This connector is available in the following products and regions:

Service Class Regions
Copilot Studio Premium All Power Automate regions
Logic Apps Standard All Logic Apps regions
Power Apps - Not available
Power Automate Premium All Power Automate regions
Contact
Name Microsoft
URL Microsoft LogicApps Support
Microsoft Power Automate Support
Connector Metadata
Publisher Microsoft
Website https://powerapps.microsoft.com/common-data-service/

Note

Microsoft Dataverse (legacy) connector will be supported by Microsoft until the Microsoft Dataverse connector supports Logic Apps.

To use this connector in Power Apps, Learn more about how to use this connector in Power Apps..

Known issues and limitations

  1. There are occurrences when CDS triggers do not work in Production environment with Administrative Mode set to "on". If you experience this issue, a workaround would be to turn off the Admin Mode in the Power Platforms Admin Center.
  2. If the administration mode is enabled for used Environment (either a sandbox or production), the Power Automate flow with When a record is modified trigger will not fire when a record is modified. For more details on how to set administration mode, please refer to this page.
  3. When you use the "When a record is selected" trigger in a flow and have an If Condition step right after, you will receive an error if the attribute in the condition has a null value. The error message you will see is "'Invalid type. Expected String but got Null.". The suggested workaround is to insert a "Get Row" action between the "When the record is selected" and the If Condition step. By using the output of the "Get Row" action in your condition, you will be able to avoid this error.

Power Apps data type mappings

Power Apps Microsoft Dataverse (legacy)
Choice Choice, Yes/No
DateTime Date Time, Date and Time, Date Only
Image Image
Number Floating Point Number, Currency, Decimal Number, Duration, Language, TimeZone, Whole Number
Text Email, Multiline Text, Phone, Text, Text Area, Ticker Symbol, URL
Guid Unique Identifier

Power Apps delegable functions and operations for Dataverse

These Power Apps operations, for a given data type, may be delegated to Dataverse for processing (rather than processing locally within Power Apps).

Item Number [1] Text [2] Choice DateTime [3] Guid
Filter Yes Yes Yes Yes Yes
Sort Yes Yes No Yes -
SortByColumns Yes Yes No Yes -
Lookup Yes Yes Yes Yes Yes
=, <> Yes Yes Yes Yes Yes
<, <=, >, >= Yes Yes No Yes -
And/Or/Not Yes Yes Yes Yes Yes
StartsWith - Yes - - -
IsBlank Yes [4] Yes [4] No [4] Yes [4] Yes
Sum, Min, Max, Avg Yes [5] - - No -
  1. Numeric with arithmetic expressions (for example, Filter(table, field + 10 > 100) ) aren't delegable. Language and TimeZone aren't delegable.
  2. Doesn't support Trim[Ends] or Len. Does support other functions such as Left, Mid, Right, Upper, Lower, Replace, Substitute, etc.
  3. DateTime is generally delegatable except for DateTime functions Now() and Today().
  4. Supports comparisons. For example, Filter(TableName, MyCol = Blank()).
  5. The aggregate functions are limited to a collection of 50,000 rows. If needed, use the Filter function to select 50,000 rows from a larger set before using the aggregate function.

Note

Choices, Guids, and Aggregate functions for Dataverse are supported only with the new version of the connector. Depending on the version of Power Apps that you're using, enable this connector with either the Preview switch titled:

  • Relational data, choices, and other new features for Dataverse
    or this Experimental switch:
  • Use the Dataverse connector
    To find these switches, open the File menu, and then select App settings > Advanced settings.

Connector in-depth

For more information about the connector, see the in-depth section.

Creating a connection

The connector supports the following authentication types:

Client Certificate Auth Provide Microsoft Entra ID credentials using PFX certificate and password All regions Shareable
Oauth Oauth All regions Shareable
Service Principal Provide Microsoft Entra ID credentials using Client Id and Secret All regions Shareable
Default [DEPRECATED] This option is only for older connections without an explicit authentication type, and is only provided for backward compatibility. All regions Not shareable

Client Certificate Auth

Auth ID: CertOauth

Applicable: All regions

Provide Microsoft Entra ID credentials using PFX certificate and password

This is shareable connection. If the power app is shared with another user, connection is shared as well. For more information, please see the Connectors overview for canvas apps - Power Apps | Microsoft Docs

Name Type Description Required
Tenant string True
Client ID string The client ID of for the Microsoft Entra ID application True
Client certificate secret clientCertificate The client certificate secret allowed by this application True

Oauth

Auth ID: Oauth

Applicable: All regions

Oauth

This is shareable connection. If the power app is shared with another user, connection is shared as well. For more information, please see the Connectors overview for canvas apps - Power Apps | Microsoft Docs

Service Principal

Auth ID: ServicePrincipalOauth

Applicable: All regions

Provide Microsoft Entra ID credentials using Client Id and Secret

This is shareable connection. If the power app is shared with another user, connection is shared as well. For more information, please see the Connectors overview for canvas apps - Power Apps | Microsoft Docs

Name Type Description Required
Client ID string Client (or Application) ID of the Microsoft Entra ID application. True
Client Secret securestring Client secret of the Microsoft Entra ID application. True
Tenant string The tenant ID of for the Microsoft Entra ID application. True

Default [DEPRECATED]

Applicable: All regions

This option is only for older connections without an explicit authentication type, and is only provided for backward compatibility.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Throttling Limits

Name Calls Renewal Period
API calls per connection 1000 60 seconds

Actions

Add a new row

This action allows you to add a new row in the selected Microsoft Dataverse table. This connector was formerly known as Common Data Service (legacy) and replaces the Dynamics 365 connector.

Add a new row (legacy) [DEPRECATED]

This operation adds a new row of a table

Add a new row [DEPRECATED]

This operation adds a new row of a table

Delete a row

This action allows you to delete a row from a Microsoft Dataverse table. This connector was formerly known as Common Data Service (legacy) and replaces the Dynamics 365 connector.

Delete a row (legacy) [DEPRECATED]

This operation deletes a row from a table collection

Download a file or an image

This action allows you to download a file or an image content from a Microsoft Dataverse table. This connector was formerly known as Common Data Service (legacy) and replaces the Dynamics 365 connector.

Get a row by ID

This action allows you to get the row that matches an ID in a Microsoft Dataverse table. This connector was formerly known as Common Data Service (legacy) and replaces the Dynamics 365 connector.

Get row (legacy) [DEPRECATED]

This operation retrieves the specified row for a table

Gets a row from table [DEPRECATED]

Gets a row from table

List rows

This action allows you to list the rows in a Microsoft Dataverse table that match the selected options. This connector was formerly known as Common Data Service (legacy) and replaces the Dynamics 365 connector.

List rows (legacy) [DEPRECATED]

This operation gets rows for a table

List rows [DEPRECATED]

This operation gets rows for a table

Perform a bound action

This action allows you to perform Microsoft Dataverse actions associated with a selected table.

Perform a changeset request

This action allows you to perform a group of Microsoft Dataverse connector operations as a single transaction. If one of the operations fails, all the successful actions are rolled back. This connector was formerly known as Common Data Service (legacy) and replaces the Dynamics 365 connector.

Perform an unbound action

This action allows you to perform Microsoft Dataverse actions available in the environment that are not associated with any table.

Relate rows

This action allows you to link a row in one Microsoft Dataverse table to another if the tables have a one-to-many or many-to-many relationship. This connector was formerly known as Common Data Service (legacy) and replaces the Dynamics 365 connector.

Search rows

This action allows you to search a Microsoft Dataverse environment using Relevance Search, and returns the rows that match the search term most closely. This connector was formerly known as Common Data Service (legacy) and replaces the Dynamics 365 connector.

Unrelate rows

This action allows you to remove the link between a row in one Microsoft Dataverse table to another if the tables have a one-to-many or many-to-many relationship. This connector was formerly known as Common Data Service (legacy) and replaces the Dynamics 365 connector.

Update a row

This action allows you to modify any selected row in a Microsoft Dataverse table, or adds a new row if it doesn�t exist. This connector was formerly known as Common Data Service (legacy) and replaces the Dynamics 365 connector.

Update a row (legacy) [DEPRECATED]

This operation updates an existing row for a table

Update a row [DEPRECATED]

This operation updates an existing row for a table

Upload a file or an image

This action allows you to upload a file or an image content to a Microsoft Dataverse table with a compatible column type. This connector was formerly known as Common Data Service (legacy) and replaces the Dynamics 365 connector.

Add a new row

This action allows you to add a new row in the selected Microsoft Dataverse table. This connector was formerly known as Common Data Service (legacy) and replaces the Dynamics 365 connector.

Parameters

Name Key Required Type Description
Environment
organization True string

Select an Environment

Table name
entityName True string

Choose a table

Row Item
item True dynamic

Row to create

Returns

The outputs of this operation are dynamic.

Add a new row (legacy) [DEPRECATED]

This operation adds a new row of a table

Parameters

Name Key Required Type Description
Environment
dataset True string

Select an Environment

Table Name
table True string

Select a table

Row Item
item True dynamic

Row to create

Returns

The outputs of this operation are dynamic.

Add a new row [DEPRECATED]

This operation adds a new row of a table

Parameters

Name Key Required Type Description
Environment
dataset True string

Select an Environment

Table Name
table True string

Select a table

Row Item
item True dynamic

Row to create

Returns

The outputs of this operation are dynamic.

Delete a row

This action allows you to delete a row from a Microsoft Dataverse table. This connector was formerly known as Common Data Service (legacy) and replaces the Dynamics 365 connector.

Parameters

Name Key Required Type Description
Org Url
organization True string

URL of the organization

Table name
entityName True string

Choose a table

Row ID
recordId True string

Enter the row's globally unique identifier (GUID)

Partition Id
partitionId string

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

Delete a row (legacy) [DEPRECATED]

This operation deletes a row from a table collection

Parameters

Name Key Required Type Description
Environment
dataset True string

Select an Environment

Table Name
table True string

Select a table

Item identifier
id True string

Identifier for the row

Download a file or an image

This action allows you to download a file or an image content from a Microsoft Dataverse table. This connector was formerly known as Common Data Service (legacy) and replaces the Dynamics 365 connector.

Parameters

Name Key Required Type Description
Environment
organization True string

Select an Environment

Table name
entityName True string

Choose a table

Row ID
recordId True string

Enter the row's globally unique identifier (GUID)

Column name
fileImageFieldName True string

Choose a column

Image size
size string

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

Returns

The content of the file or image

File or image content
binary

Get a row by ID

This action allows you to get the row that matches an ID in a Microsoft Dataverse table. This connector was formerly known as Common Data Service (legacy) and replaces the Dynamics 365 connector.

Parameters

Name Key Required Type Description
Org Url
organization True string

URL of the organization

Table name
entityName True string

Choose a table

Row ID
recordId True string

Enter the row's globally unique identifier (GUID)

Select columns
$select string

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

Expand Query
$expand string

Enter an Odata style expand query to list related rows

Partition Id
partitionId string

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

Returns

The outputs of this operation are dynamic.

Get row (legacy) [DEPRECATED]

This operation retrieves the specified row for a table

Parameters

Name Key Required Type Description
Environment
dataset True string

Select an Environment

Table Name
table True string

Select a table

Item identifier
id True string

Identifier for the row

Returns

The outputs of this operation are dynamic.

Gets a row from table [DEPRECATED]

Gets a row from table

Parameters

Name Key Required Type Description
Environment
dataset True string

Select an Environment

Table Name
table True string

Select a table

Item identifier
id True string

Identifier for the row

Returns

The outputs of this operation are dynamic.

List rows

This action allows you to list the rows in a Microsoft Dataverse table that match the selected options. This connector was formerly known as Common Data Service (legacy) and replaces the Dynamics 365 connector.

Parameters

Name Key Required Type Description
Environment
organization True string

Select an Environment

Table name
entityName True string

Choose a table

Select columns
$select string

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

Filter rows
$filter string

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

Sort By
$orderby string

Columns to sort by in OData orderBy style (excluding lookups)

Expand Query
$expand string

Enter an Odata style expand query to list related rows

Fetch Xml Query
fetchXml string

Enter a Fetch XML query for advanced customization

Row count
$top integer

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

Skip token
$skiptoken string

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

Partition ID
partitionId string

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

Returns

The outputs of this operation are dynamic.

List rows (legacy) [DEPRECATED]

This operation gets rows for a table

Parameters

Name Key Required Type Description
Environment
dataset True string

Select an Environment

Table Name
table True string

Select a table

Aggregation transformation
$apply string

A sequence of OData aggregation transformations

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.

Top Count
$top integer

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

Expand Query
$expand string

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

Returns

The outputs of this operation are dynamic.

List rows [DEPRECATED]

This operation gets rows for a table

Parameters

Name Key Required Type Description
Environment
dataset True string

Select an Environment

Table Name
table True string

Select a table

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.

Top Count
$top integer

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

Expand Query
$expand string

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

Returns

The outputs of this operation are dynamic.

Perform a bound action

This action allows you to perform Microsoft Dataverse actions associated with a selected table.

Parameters

Name Key Required Type Description
Environment
organization True string

Select an Environment

Table name
entityName True string

Choose a table

Action Name
actionName True string

Choose an action

Row ID
recordId True string

Enter the row's globally unique identifier (GUID)

Action parameters
item dynamic

Action parameters

Returns

The outputs of this operation are dynamic.

Perform a changeset request

This action allows you to perform a group of Microsoft Dataverse connector operations as a single transaction. If one of the operations fails, all the successful actions are rolled back. This connector was formerly known as Common Data Service (legacy) and replaces the Dynamics 365 connector.

Perform an unbound action

This action allows you to perform Microsoft Dataverse actions available in the environment that are not associated with any table.

Parameters

Name Key Required Type Description
Environment
organization True string

Select an Environment

Action Name
actionName True string

Choose an action

Action parameters
item dynamic

Action parameters

Returns

The outputs of this operation are dynamic.

Relate rows

This action allows you to link a row in one Microsoft Dataverse table to another if the tables have a one-to-many or many-to-many relationship. This connector was formerly known as Common Data Service (legacy) and replaces the Dynamics 365 connector.

Parameters

Name Key Required Type Description
Environment
organization True string

Select an Environment

Table name
entityName True string

Choose a table

Row ID
recordId True string

Enter the row's globally unique identifier (GUID)

Relationship
associationEntityRelationship True string

Choose relationship type

Relate with
@odata.id True string

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)

Search rows

This action allows you to search a Microsoft Dataverse environment using Relevance Search, and returns the rows that match the search term most closely. This connector was formerly known as Common Data Service (legacy) and replaces the Dynamics 365 connector.

Parameters

Name Key Required Type Description
Org Url
organization True string

URL of the organization

Search term
search True string

Enter a search term, eg. Contoso. Searches modifiers like boolean operators, wildcards, fuzzy search, proximity search etc. require the search type full

Search type
searchtype string

Enter whether simple or full search syntax should be used (default is simple)

Search mode
searchmode string

Enter whether any or all of the search terms must be matched (default is any)

Row count
top integer

Enter the number of search results to be listed (default = 50)

Row filter
filter string

Enter an Odata style filter expression to narrow the search

Table filter
entities array of string

Enter a comma-separated list of tables to be searched (default is all tables)

Sort by
orderby array of string

Enter a comma-separated list of column unique names followed by asc or desc

Facet query
facets array of string

Enter a comma-separated list of facet queries to narrow the search

Skip rows
skip integer

Enter the number of search results to be skipped

Return row count
returntotalrecordcount boolean

Choose an option

Returns

The search output.

Unrelate rows

This action allows you to remove the link between a row in one Microsoft Dataverse table to another if the tables have a one-to-many or many-to-many relationship. This connector was formerly known as Common Data Service (legacy) and replaces the Dynamics 365 connector.

Parameters

Name Key Required Type Description
Environment
organization True string

Select an Environment

Table name
entityName True string

Choose a table

Row ID
recordId True string

Enter the row's globally unique identifier (GUID)

Relationship
associationEntityRelationship True string

Choose relationship type

Unrelate with
$id True string

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)

Update a row

This action allows you to modify any selected row in a Microsoft Dataverse table, or adds a new row if it doesn�t exist. This connector was formerly known as Common Data Service (legacy) and replaces the Dynamics 365 connector.

Parameters

Name Key Required Type Description
Org Url
organization True string

URL of the organization

Table name
entityName True string

Choose a table

Row ID
recordId True string

Enter the row's globally unique identifier (GUID)

Row Item
item True dynamic

Row to update

Returns

The outputs of this operation are dynamic.

Update a row (legacy) [DEPRECATED]

This operation updates an existing row for a table

Parameters

Name Key Required Type Description
Environment
dataset True string

Select an Environment

Table Name
table True string

Select a table

Row identifier
id True string

Identifier for the row

Row Item
item True dynamic

Row to update

Returns

The outputs of this operation are dynamic.

Update a row [DEPRECATED]

This operation updates an existing row for a table

Parameters

Name Key Required Type Description
Environment
dataset True string

Select an Environment

Table Name
table True string

Select a table

Row identifier
id True string

Identifier for the row

Row Item
item True dynamic

Row to update

Returns

The outputs of this operation are dynamic.

Upload a file or an image

This action allows you to upload a file or an image content to a Microsoft Dataverse table with a compatible column type. This connector was formerly known as Common Data Service (legacy) and replaces the Dynamics 365 connector.

Parameters

Name Key Required Type Description
Environment
organization True string

Select an Environment

Table name
entityName True string

Choose a table

Row ID
recordId True string

Enter the row's globally unique identifier (GUID)

Column name
fileImageFieldName True string

Choose a column

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 row is added, modified or deleted

This trigger allows you to start a flow when a row is added, modified or deleted in a Microsoft Dataverse table, such that it matches the selected options. This connector was formerly known as Common Data Service (legacy) and replaces the Dynamics 365 connector.

When a row is added (Admin Only) [DEPRECATED]

Triggers a flow when a row is added in Dataverse

When a row is added (Admin Only) [DEPRECATED]

Triggers a flow when a row is added in Dataverse

When a row is added [DEPRECATED]

Triggers a flow when a row is added in Dataverse.

When a row is deleted (Admin Only) [DEPRECATED]

Triggers a flow when a row is deleted in Dataverse

When a row is deleted [DEPRECATED]

Triggers a flow when a row is deleted in Dataverse.

When a row is modified (Admin Only) [DEPRECATED]

Triggers a flow when a row is modified in Dataverse

When a row is modified (Admin Only) [DEPRECATED]

Triggers a flow when a row is modified in Dataverse

When a row is modified [DEPRECATED]

Triggers a flow when a row is modified in Dataverse.

When an action is performed

Triggers when a Microsoft Dataverse action has completed.

When a row is added, modified or deleted

This trigger allows you to start a flow when a row is added, modified or deleted in a Microsoft Dataverse table, such that it matches the selected options. This connector was formerly known as Common Data Service (legacy) and replaces the Dynamics 365 connector.

Parameters

Name Key Required Type Description
Environment
organization True string

Select an Environment

Table name
entityname True string

Choose a table

Change type
message True integer

Choose when the flow triggers

Scope
scope True integer

Choose a scope to limit which rows can trigger the flow

Select columns
filteringattributes string

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

Filter rows
filterexpression string

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

Delay until
postponeuntil string

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

Run as
runas integer

Choose the running user for steps where invoker connections are used

Returns

The outputs of this operation are dynamic.

When a row is added (Admin Only) [DEPRECATED]

Triggers a flow when a row is added in Dataverse

Parameters

Name Key Required Type Description
Environment
dataset True string

Select an Environment

Table Name
table True string

Select a table

Returns

The outputs of this operation are dynamic.

When a row is added (Admin Only) [DEPRECATED]

Triggers a flow when a row is added in Dataverse

Parameters

Name Key Required Type Description
Environment
dataset True string

Select an Environment

Table Name
table True string

Select a table

Returns

The outputs of this operation are dynamic.

When a row is added [DEPRECATED]

Triggers a flow when a row is added in Dataverse.

Parameters

Name Key Required Type Description
Environment
dataset True string

Select an Environment.

Table Name
table True string

Select a table.

Scope
scope True string

Scope.

Returns

The outputs of this operation are dynamic.

When a row is deleted (Admin Only) [DEPRECATED]

Triggers a flow when a row is deleted in Dataverse

Parameters

Name Key Required Type Description
Environment
dataset True string

Select an Environment

Table Name
table True string

Select a table

Returns

The outputs of this operation are dynamic.

When a row is deleted [DEPRECATED]

Triggers a flow when a row is deleted in Dataverse.

Parameters

Name Key Required Type Description
Environment
dataset True string

Select an Environment.

Table Name
table True string

Select a table.

Scope
scope True string

Scope.

Returns

The outputs of this operation are dynamic.

When a row is modified (Admin Only) [DEPRECATED]

Triggers a flow when a row is modified in Dataverse

Parameters

Name Key Required Type Description
Environment
dataset True string

Select an Environment

Table Name
table True string

Select a table

Returns

The outputs of this operation are dynamic.

When a row is modified (Admin Only) [DEPRECATED]

Triggers a flow when a row is modified in Dataverse

Parameters

Name Key Required Type Description
Environment
dataset True string

Select an Environment

Table Name
table True string

Select a table

Returns

The outputs of this operation are dynamic.

When a row is modified [DEPRECATED]

Triggers a flow when a row is modified in Dataverse.

Parameters

Name Key Required Type Description
Environment
dataset True string

Select an Environment.

Table Name
table True string

Select a table.

Scope
scope True string

Scope.

Column Filters
AttributeFilters array of string

Column filters

Returns

The outputs of this operation are dynamic.

When an action is performed

Triggers when a Microsoft Dataverse action has completed.

Parameters

Name Key Required Type Description
Environment
organization True string

Select an Environment

Catalog
catalog True string

Choose an option to filter tables and actions.

Category
category True string

Choose an option to filter tables and actions.

Table name
entityname True string

Choose a table to filter actions.

Action name
sdkmessagename True string

Choose an action.

Returns

The outputs of this operation are dynamic.

Definitions

SearchOutput

The search output.

Name Path Type Description
List of rows
value array of object

List of rows

Row search score
value.@search.score number

Search score of row

Row table name
value.@search.entityname string

Table that contains the row

Row object id
value.@search.objectid string

Objectid of row

Row object type code
value.@search.objecttypecode integer

Objecttypecode of row

Total row count
totalrecordcount integer

Total count of results (-1 if returntotalrecordcount is set to false)

binary

This is the basic data type 'binary'.