Microsoft Dataverse — мощная облачная платформа данных для безопасного хранения, управления и взаимодействия со структурированными бизнес-данными. Интеграция Microsoft Dataverse позволяет программно создавать, читать, обновлять, удалять и связывать записи в таблицах Dataverse в рамках ваших воркфлоу и задач автоматизации.
Интеграция Microsoft Dataverse в AACFlow позволяет:
- Получать и запрашивать записи: получайте списки записей или выполняйте запросы с расширенными фильтрами, чтобы найти нужные данные в любой таблице Dataverse.
- Создавать и обновлять записи: добавляйте новые записи или обновляйте существующие в любой таблице для использования в Power Platform, Dynamics 365 и пользовательских приложениях.
- Удалять и управлять записями: удаляйте записи в рамках жизненного цикла данных прямо из ваших сценариев автоматизации.
- Связывать и разрывать связи между записями: объединяйте связанные элементы или удаляйте связи через сущности и навигационные свойства — это важно для отражения сложных бизнес-процессов.
- Работать с любой средой Dataverse: подключайтесь к средам вашей организации — production, sandbox или арендам Dynamics 365 — для максимальной гибкости.
- Интегрироваться с Power Platform и Dynamics 365: автоматизируйте задачи от обновлений данных продаж и маркетинга до сценариев пользовательских приложений — всё это с безопасностью и контролем Dataverse.
Интеграция Dataverse даёт разработчикам решений и бизнес-пользователям возможность автоматизировать бизнес-процессы, поддерживать актуальность данных, создавать системные интеграции, запускать действия и получать инсайты — с надёжной безопасностью и управляемостью.
Подключите Microsoft Dataverse к своим автоматизациям, чтобы открыть мощные возможности управления данными, оркестрации и бизнес-логики в ваших приложениях, командах и облачных сервисах.
Интегрируйте Microsoft Dataverse в ваш рабочий процесс. Создавайте, читайте, обновляйте, delete, upsert, associate, запрос, search, и execute actions и functions against Dataverse tables using the Web API. Supports bulk operations, FetchXML, file uploads, и relevance search. Works с Dynamics 365, Power Platform, и custom Dataverse environments.
Связать два записи in Microsoft Dataverse via a navigation property. Creates a relationship between a source record и a target record. Supports both collection-valued (POST) и 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 | Произошла ли 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 |
Создать multiple records одного типа таблицы type в одном запросе. Each record in the Targets array must include an @odata.type annotation. Recommended batch size: 100-1000 records для 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 | Да | Массив record objects to create. Each record should contain column logical names as keys. The @odata.type annotation is added automatically. |
| Параметр | Тип | Описание |
|---|
ids | array | Массив GUIDs for the created records |
count | number | Number of records created |
success | boolean | Whether all records were created successfully |
Создать новый record in a Microsoft Dataverse table. Требуется the entity set name (plural имя таблицы) и 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 | Произошла ли record was created successfully |
Удалить 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 |
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 — это 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 | Произошла ли 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 |
Загрузить a file from a file или image column on a Dataverse record. Returns the file content as a base64-encoded string along с 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 | Произошла ли file was downloaded successfully |
Выполнить a bound или unbound Dataverse action. Actions perform operations с side effects (e.g., Merge, GrantAccess, ОтправитьEmail, QualifyLead). For bound actions, provide the entity set name и 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 | Произошла ли action executed successfully |
Выполнить a bound или unbound Dataverse function. Functions are read-only operations (e.g., RetrievePrincipalAccess, RetrieveTotalRecordCount, InitializeFrom). For bound functions, provide the entity set name и 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 | Произошла ли function executed successfully |
Выполнить a FetchXML запрос against a Microsoft Dataverse table. FetchXML supports агрегация, grouping, linked-entity joins, и complex фильтрация 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 | Массив 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 |
Получить один record from a Microsoft Dataverse table by its ID. Supports $select и $expand OData запрос 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 | Произошла ли record was retrieved successfully |
Запрос и list records from a Microsoft Dataverse table. Supports OData запрос options для фильтрация, selecting columns, ordering, и постраничная выборка.
| Параметр | Тип | Обязательный | Описание |
|---|
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 | Массив 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 |
Perform a full-text relevance search across Microsoft Dataverse tables. Требуется Dataverse Поиск to be enabled on the environment. Supports simple и Lucene запрос 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 | Нет | Количество результатов для пропуска for постраничная выборка |
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 | Массив 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 |
Обновить multiple records одного типа таблицы type в одном запросе. 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 | Да | Массив 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 |
Обновитьn 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 |
Загрузить a file to a file или image column on a Dataverse record. Supports single-request upload для 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 | Произошла ли file was uploaded successfully |
Создать или update a record in a Microsoft Dataverse table. If a record с заданным ID exists, it — это updated; otherwise, a new record — это 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 | Истина если 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 |
Получить current authenticated user information from Microsoft Dataverse. Useful для testing connectivity и getting the user ID, business unit ID, и organization ID.
| Параметр | Тип | Описание |
|---|
userId | string | The authenticated user ID |
businessUnitId | string | The business unit ID |
organizationId | string | The organization ID |
success | boolean | Operation success status |
