Microsoft Dataverse

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Provides access to the org-based database on Microsoft Dataverse 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

Creating a connection

The connector supports the following authentication types:

Default	Parameters for creating connection.	All regions	Not shareable

Default

Applicable: All regions

Parameters for creating connection.

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	6000	300 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 (current environment).
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 (current environment).
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 (current environment).
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 (current environment).
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 (current environment).
Perform a bound action	This action allows you to perform Microsoft Dataverse actions associated with a selected table. This connector was formerly known as Common Data Service (current environment).
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 (current environment).
Perform an unbound action	This action allows you to perform Microsoft Dataverse actions available in the environment that are not associated with any table. This connector was formerly known as Common Data Service (current environment).
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 (current environment).
Search rows (preview)	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 (current environment).
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 (current environment).
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 (current environment).
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 (current environment).

Add a new row

Operation ID:

CreateRecord

This action allows you to add a new row in the selected Microsoft Dataverse table. This connector was formerly known as Common Data Service (current environment).

Parameters

Name	Key	Required	Type	Description
Table name	entityName	True	string	Choose a table

Returns

response

object

Delete a row

Operation ID:

DeleteRecord

This action allows you to delete a row from a Microsoft Dataverse table. This connector was formerly known as Common Data Service (current environment).

Parameters

Name	Key	Required	Type	Description
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

Download a file or an image

Operation ID:

GetEntityFileImageFieldContent

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 (current environment).

Parameters

Name	Key	Required	Type	Description
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

Operation ID:

GetItem

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 (current environment).

Parameters

Name	Key	Required	Type	Description
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

response

object

List rows

Operation ID:

ListRecords

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 (current environment).

Parameters

Name	Key	Required	Type	Description
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

List of tables

Body

EntityItemList

Perform a bound action

Operation ID:

PerformBoundAction

This action allows you to perform Microsoft Dataverse actions associated with a selected table. This connector was formerly known as Common Data Service (current environment).

Parameters

Name	Key	Required	Type	Description
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)

Returns

response

object

Perform a changeset request

Operation ID:

ExecuteChangeset

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 (current environment).

Perform an unbound action

Operation ID:

PerformUnboundAction

This action allows you to perform Microsoft Dataverse actions available in the environment that are not associated with any table. This connector was formerly known as Common Data Service (current environment).

Parameters

Name	Key	Required	Type	Description
Action Name	actionName	True	string	Choose an action

Returns

response

object

Relate rows

Operation ID:

AssociateEntities

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 (current environment).

Parameters

Name	Key	Required	Type	Description
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 (preview)

Operation ID:

GetRelevantRows

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 (current environment).

Parameters

Name	Key	Required	Type	Description
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	Table filter		string	Enter a table unique name to be searched (default is all tables)
Sort by	Sort by		string	Enter a column unique name followed by asc or desc
Facet query	Facet query		string	Enter a facet query 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.

Body

SearchOutput

Unrelate rows

Operation ID:

DisassociateEntities

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 (current environment).

Parameters

Name	Key	Required	Type	Description
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

Operation ID:

UpdateRecord

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 (current environment).

Parameters

Name	Key	Required	Type	Description
Table name	entityName	True	string	Choose a table
Row ID	recordId	True	string	Enter the row's globally unique identifier (GUID)

Returns

response

object

Upload a file or an image

Operation ID:

UpdateEntityFileImageFieldContent

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 (current environment).

Parameters

Name	Key	Required	Type	Description
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 flow step is run from a business process flow	This trigger allows you to start a flow when the Run Flow button in a business process flow step is clicked. (Available only for Power Automate.)
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 (current environment).
When an action is performed	Triggers when a Microsoft Dataverse action has completed.

When a flow step is run from a business process flow

Operation ID:

OnFlowStepRun

This trigger allows you to start a flow when the Run Flow button in a business process flow step is clicked. (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 added, modified or deleted

Operation ID:

SubscribeWebhookTrigger

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 (current environment).

Parameters

Name	Key	Required	Type	Description
Change type	message	True	integer	Choose when the flow triggers
Table name	entityname	True	string	Choose a table
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

A Table item.

Body

WebhookNotificationContent

When an action is performed

Operation ID:

BusinessEventsTrigger

Triggers when a Microsoft Dataverse action has completed.

Parameters

Name	Key	Required	Type	Description
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

An action and table item.

Body

WebhookNotificationContentForWhenAnActionIsPerformed

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

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)

WebhookNotificationContentForWhenAnActionIsPerformed

An action and table item.

Name	Path	Type	Description
schema	schema	Object

object

This is the type 'object'.

binary

This is the basic data type 'binary'.