Microsoft Dataverse

使用说明

Integrate Microsoft Dataverse into your workflow. Create, read, update, delete, upsert, associate, query, search, and execute actions and functions against Dataverse tables using the Web API. Supports bulk operations, FetchXML, file uploads, and relevance search. Works with Dynamics 365, Power Platform, and custom Dataverse environments.

工具

`microsoft_dataverse_associate`

Associate two records in Microsoft Dataverse via a navigation property. Creates a relationship between a source record and a target record. Supports both collection-valued (POST) and single-valued (PUT) navigation properties.

输入

参数	类型	必填	描述
`environmentUrl`	string	是	Dataverse environment URL (e.g., https://myorg.crm.dynamics.com\)
`entitySetName`	string	是	Source entity set name (e.g., accounts)
`recordId`	string	是	Source record GUID
`navigationProperty`	string	是	Navigation property name (e.g., contact_customer_accounts for collection-valued, or parentcustomerid_account for single-valued)
`targetEntitySetName`	string	是	Target entity set name (e.g., contacts)
`targetRecordId`	string	是	Target record GUID to associate
`navigationType`	string	否	Type of navigation property: "collection" (default, uses POST) or "single" (uses PUT for lookup fields)

输出

参数	类型	描述
`success`	boolean	Whether the association was created successfully
`entitySetName`	string	Source entity set name used in the association
`recordId`	string	Source record GUID that was associated
`navigationProperty`	string	Navigation property used for the association
`targetEntitySetName`	string	Target entity set name used in the association
`targetRecordId`	string	Target record GUID that was associated

`microsoft_dataverse_create_multiple`

Create multiple records of the same table type in a single request. Each record in the Targets array must include an @odata.type annotation. Recommended batch size: 100-1000 records for standard tables.

输入

参数	类型	必填	描述
`environmentUrl`	string	是	Dataverse environment URL (e.g., https://myorg.crm.dynamics.com\)
`entitySetName`	string	是	Entity set name (plural table name, e.g., accounts, contacts)
`entityLogicalName`	string	是	Table logical name for @odata.type annotation (e.g., account, contact). Used to set Microsoft.Dynamics.CRM.{entityLogicalName} on each record.
`records`	object	是	Array of record objects to create. Each record should contain column logical names as keys. The @odata.type annotation is added automatically.

输出

参数	类型	描述
`ids`	array	Array of GUIDs for the created records
`count`	number	Number of records created
`success`	boolean	Whether all records were created successfully

`microsoft_dataverse_create_record`

Create a new record in a Microsoft Dataverse table. Requires the entity set name (plural table name) and record data as a JSON object.

输入

参数	类型	必填	描述
`environmentUrl`	string	是	Dataverse environment URL (e.g., https://myorg.crm.dynamics.com\)
`entitySetName`	string	是	Entity set name (plural table name, e.g., accounts, contacts)
`data`	object	是	Record data as a JSON object with column names as keys

输出

参数	类型	描述
`recordId`	string	The ID of the created record
`record`	object	Dataverse record object. Contains dynamic columns based on the queried table, plus OData metadata fields.
`success`	boolean	Whether the record was created successfully

`microsoft_dataverse_delete_record`

Delete a record from a Microsoft Dataverse table by its ID.

输入

参数	类型	必填	描述
`environmentUrl`	string	是	Dataverse environment URL (e.g., https://myorg.crm.dynamics.com\)
`entitySetName`	string	是	Entity set name (plural table name, e.g., accounts, contacts)
`recordId`	string	是	The unique identifier (GUID) of the record to delete

输出

参数	类型	描述
`recordId`	string	The ID of the deleted record
`success`	boolean	Operation success status

`microsoft_dataverse_disassociate`

Remove an association between two records in Microsoft Dataverse. For collection-valued navigation properties, provide the target record ID. For single-valued navigation properties, only the navigation property name is needed.

输入

参数	类型	必填	描述
`environmentUrl`	string	是	Dataverse environment URL (e.g., https://myorg.crm.dynamics.com\)
`entitySetName`	string	是	Source entity set name (e.g., accounts)
`recordId`	string	是	Source record GUID
`navigationProperty`	string	是	Navigation property name (e.g., contact_customer_accounts for collection-valued, or parentcustomerid_account for single-valued)
`targetRecordId`	string	否	Target record GUID (required for collection-valued navigation properties, omit for single-valued)

输出

参数	类型	描述
`success`	boolean	Whether the disassociation was completed successfully
`entitySetName`	string	Source entity set name used in the disassociation
`recordId`	string	Source record GUID that was disassociated
`navigationProperty`	string	Navigation property used for the disassociation
`targetRecordId`	string	Target record GUID that was disassociated

`microsoft_dataverse_download_file`

Download a file from a file or image column on a Dataverse record. Returns the file content as a base64-encoded string along with file metadata from response headers.

输入

参数	类型	必填	描述
`environmentUrl`	string	是	Dataverse environment URL (e.g., https://myorg.crm.dynamics.com\)
`entitySetName`	string	是	Entity set name (plural table name, e.g., accounts, contacts)
`recordId`	string	是	Record GUID to download the file from
`fileColumn`	string	是	File or image column logical name (e.g., entityimage, cr_document)

输出

参数	类型	描述
`fileContent`	string	Base64-encoded file content
`fileName`	string	Name of the downloaded file
`fileSize`	number	File size in bytes
`mimeType`	string	MIME type of the file
`success`	boolean	Whether the file was downloaded successfully

`microsoft_dataverse_execute_action`

Execute a bound or unbound Dataverse action. Actions perform operations with side effects (e.g., Merge, GrantAccess, SendEmail, QualifyLead). For bound actions, provide the entity set name and record ID.

输入

参数	类型	必填	描述
`environmentUrl`	string	是	Dataverse environment URL (e.g., https://myorg.crm.dynamics.com\)
`actionName`	string	是	Action name (e.g., Merge, GrantAccess, SendEmail). Do not include the Microsoft.Dynamics.CRM. namespace prefix for unbound actions.
`entitySetName`	string	否	Entity set name for bound actions (e.g., accounts). Leave empty for unbound actions.
`recordId`	string	否	Record GUID for bound actions. Leave empty for unbound or collection-bound actions.
`parameters`	object	否	Action parameters as a JSON object. For entity references, include @odata.type annotation (e.g., {"Target": {"@odata.type": "Microsoft.Dynamics.CRM.account", "accountid": "..."}})

输出

参数	类型	描述
`result`	object	Action response data. Structure varies by action. Null for actions that return 204 No Content.
`success`	boolean	Whether the action executed successfully

`microsoft_dataverse_execute_function`

Execute a bound or unbound Dataverse function. Functions are read-only operations (e.g., RetrievePrincipalAccess, RetrieveTotalRecordCount, InitializeFrom). For bound functions, provide the entity set name and record ID.

输入

参数	类型	必填	描述
`environmentUrl`	string	是	Dataverse environment URL (e.g., https://myorg.crm.dynamics.com\)
`functionName`	string	是	Function name (e.g., RetrievePrincipalAccess, RetrieveTotalRecordCount). Do not include the Microsoft.Dynamics.CRM. namespace prefix for unbound functions.
`entitySetName`	string	否	Entity set name for bound functions (e.g., systemusers). Leave empty for unbound functions.
`recordId`	string	否	Record GUID for bound functions. Leave empty for unbound functions.
`parameters`	string	否	Function parameters as a comma-separated list of name=value pairs for the URL (e.g., "LocalizedStandardName='Pacific Standard Time\

输出

参数	类型	描述
`result`	object	Function response data. Structure varies by function.
`success`	boolean	Whether the function executed successfully

`microsoft_dataverse_fetchxml_query`

Execute a FetchXML query against a Microsoft Dataverse table. FetchXML supports aggregation, grouping, linked-entity joins, and complex filtering beyond OData capabilities.

输入

参数	类型	必填	描述
`environmentUrl`	string	是	Dataverse environment URL (e.g., https://myorg.crm.dynamics.com\)
`entitySetName`	string	是	Entity set name (plural table name, e.g., accounts, contacts)
`fetchXml`	string	是	FetchXML query string. Must include <fetch> root element and <entity> child element matching the table logical name.

输出

参数	类型	描述
`records`	array	Array of Dataverse records. Each record has dynamic columns based on the table schema.
`count`	number	Number of records returned in the current page
`fetchXmlPagingCookie`	string	Paging cookie for retrieving the next page of results
`moreRecords`	boolean	Whether more records are available beyond the current page
`success`	boolean	Operation success status

`microsoft_dataverse_get_record`

Retrieve a single record from a Microsoft Dataverse table by its ID. Supports $select and $expand OData query options.

输入

参数	类型	必填	描述
`environmentUrl`	string	是	Dataverse environment URL (e.g., https://myorg.crm.dynamics.com\)
`entitySetName`	string	是	Entity set name (plural table name, e.g., accounts, contacts)
`recordId`	string	是	The unique identifier (GUID) of the record to retrieve
`select`	string	否	Comma-separated list of columns to return (OData $select)
`expand`	string	否	Navigation properties to expand (OData $expand)

输出

参数	类型	描述
`record`	object	Dataverse record object. Contains dynamic columns based on the queried table, plus OData metadata fields.
`recordId`	string	The record primary key ID (auto-detected from response)
`success`	boolean	Whether the record was retrieved successfully

`microsoft_dataverse_list_records`

Query and list records from a Microsoft Dataverse table. Supports OData query options for filtering, selecting columns, ordering, and pagination.

输入

参数	类型	必填	描述
`environmentUrl`	string	是	Dataverse environment URL (e.g., https://myorg.crm.dynamics.com\)
`entitySetName`	string	是	Entity set name (plural table name, e.g., accounts, contacts)
`select`	string	否	Comma-separated list of columns to return (OData $select)
`filter`	string	否	OData $filter expression (e.g., statecode eq 0)
`orderBy`	string	否	OData $orderby expression (e.g., name asc, createdon desc)
`top`	number	否	Maximum number of records to return (OData $top)
`expand`	string	否	Navigation properties to expand (OData $expand)
`count`	string	否	Set to "true" to include total record count in response (OData $count)

输出

参数	类型	描述
`records`	array	Array of Dataverse records. Each record has dynamic columns based on the table schema.
`count`	number	Number of records returned in the current page
`totalCount`	number	Total number of matching records server-side (requires $count=true)
`nextLink`	string	URL for the next page of results
`success`	boolean	Operation success status

`microsoft_dataverse_search`

Perform a full-text relevance search across Microsoft Dataverse tables. Requires Dataverse Search to be enabled on the environment. Supports simple and Lucene query syntax.

输入

参数	类型	必填	描述
`environmentUrl`	string	是	Dataverse environment URL (e.g., https://myorg.crm.dynamics.com\)
`searchTerm`	string	是	Search text (1-100 chars). Supports simple syntax: + (AND), \| (OR), - (NOT), * (wildcard), "exact phrase"
`entities`	string	否	JSON array of search entity configs. Each object: {"Name":"account","SelectColumns":["name"],"SearchColumns":["name"],"Filter":"statecode eq 0"}
`filter`	string	否	Global OData filter applied across all entities (e.g., "createdon gt 2024-01-01")
`facets`	string	否	JSON array of facet specifications (e.g., ["entityname,count:100","ownerid,count:100"])
`top`	number	否	Maximum number of results (default: 50, max: 100)
`skip`	number	否	Number of results to skip for pagination
`orderBy`	string	否	JSON array of sort expressions (e.g., ["createdon desc"])
`searchMode`	string	否	Search mode: "any" (default, match any term) or "all" (match all terms)
`searchType`	string	否	Query type: "simple" (default) or "lucene" (enables regex, fuzzy, proximity, boosting)

输出

参数	类型	描述
`results`	array	Array of search result objects
↳ `Id`	string	Record GUID
↳ `EntityName`	string	Table logical name (e.g., account, contact)
↳ `ObjectTypeCode`	number	Entity type code
↳ `Attributes`	object	Record attributes matching the search. Keys are column logical names.
↳ `Highlights`	object	Highlighted search matches. Keys are column names, values are arrays of strings with {crmhit}/{/crmhit} markers.
↳ `Score`	number	Relevance score for this result
`totalCount`	number	Total number of matching records across all tables
`count`	number	Number of results returned in this page
`facets`	object	Facet results when facets were requested. Keys are facet names, values are arrays of facet value objects with count and value properties.
`success`	boolean	Operation success status

`microsoft_dataverse_update_multiple`

Update multiple records of the same table type in a single request. Each record must include its primary key. Only include columns that need to be changed. Recommended batch size: 100-1000 records.

输入

参数	类型	必填	描述
`environmentUrl`	string	是	Dataverse environment URL (e.g., https://myorg.crm.dynamics.com\)
`entitySetName`	string	是	Entity set name (plural table name, e.g., accounts, contacts)
`entityLogicalName`	string	是	Table logical name for @odata.type annotation (e.g., account, contact). Used to set Microsoft.Dynamics.CRM.{entityLogicalName} on each record.
`records`	object	是	Array of record objects to update. Each record must include its primary key (e.g., accountid) and only the columns being changed. The @odata.type annotation is added automatically.

输出

参数	类型	描述
`success`	boolean	Whether all records were updated successfully

`microsoft_dataverse_update_record`

Update an existing record in a Microsoft Dataverse table. Only send the columns you want to change.

输入

参数	类型	必填	描述
`environmentUrl`	string	是	Dataverse environment URL (e.g., https://myorg.crm.dynamics.com\)
`entitySetName`	string	是	Entity set name (plural table name, e.g., accounts, contacts)
`recordId`	string	是	The unique identifier (GUID) of the record to update
`data`	object	是	Record data to update as a JSON object with column names as keys

输出

参数	类型	描述
`recordId`	string	The ID of the updated record
`success`	boolean	Operation success status

`microsoft_dataverse_upload_file`

Upload a file to a file or image column on a Dataverse record. Supports single-request upload for files up to 128 MB. The file content must be provided as a base64-encoded string.

输入

参数	类型	必填	描述
`environmentUrl`	string	是	Dataverse environment URL (e.g., https://myorg.crm.dynamics.com\)
`entitySetName`	string	是	Entity set name (plural table name, e.g., accounts, contacts)
`recordId`	string	是	Record GUID to upload the file to
`fileColumn`	string	是	File or image column logical name (e.g., entityimage, cr_document)
`fileName`	string	是	Name of the file being uploaded (e.g., document.pdf)
`file`	file	否	File to upload (UserFile object)
`fileContent`	string	否	Base64-encoded file content (legacy)

输出

参数	类型	描述
`recordId`	string	Record GUID the file was uploaded to
`fileColumn`	string	File column the file was uploaded to
`fileName`	string	Name of the uploaded file
`success`	boolean	Whether the file was uploaded successfully

`microsoft_dataverse_upsert_record`

Create or update a record in a Microsoft Dataverse table. If a record with the given ID exists, it is updated; otherwise, a new record is created.

输入

参数	类型	必填	描述
`environmentUrl`	string	是	Dataverse environment URL (e.g., https://myorg.crm.dynamics.com\)
`entitySetName`	string	是	Entity set name (plural table name, e.g., accounts, contacts)
`recordId`	string	是	The unique identifier (GUID) of the record to upsert
`data`	object	是	Record data as a JSON object with column names as keys

输出

参数	类型	描述
`recordId`	string	The ID of the upserted record
`created`	boolean	True if the record was created, false if updated
`record`	object	Dataverse record object. Contains dynamic columns based on the queried table, plus OData metadata fields.
`success`	boolean	Operation success status

`microsoft_dataverse_whoami`

Retrieve the current authenticated user information from Microsoft Dataverse. Useful for testing connectivity and getting the user ID, business unit ID, and organization ID.

输入

参数	类型	必填	描述
`environmentUrl`	string	是	Dataverse environment URL (e.g., https://myorg.crm.dynamics.com\)

输出

参数	类型	描述
`userId`	string	The authenticated user ID
`businessUnitId`	string	The business unit ID
`organizationId`	string	The organization ID
`success`	boolean	Operation success status

Microsoft Dataverse

On this page