DynamicsWebApi 使用教程

DynamicsWebApi 使用教程

1. 项目介绍

DynamicsWebApi 是一个用于 Microsoft Dataverse Web API 的 JavaScript & TypeScript 辅助库。它旨在简化与 Dynamics 365、Dynamics CRM 2016 及 Dynamics CRM Online 的交互。该项目支持多种 Dynamics 版本，并提供了丰富的 API 接口，帮助开发者更高效地进行数据操作和业务逻辑处理。

2. 项目快速启动

2.1 安装

你可以通过以下两种方式将 DynamicsWebApi 集成到你的项目中：

2.1.1 通过 Web File 上传

1. 将 DynamicsWebApi 库上传为 Web File。
2. 在模板、页面或表单中包含以下脚本：

<script type="text/javascript" src="~/dynamicsWebApi.min.js"></script>

2.1.2 通过 CDN 引入

直接在模板、页面或表单中包含以下脚本：

<script type="text/javascript" src="https://unpkg.com/dynamics-web-api@2.1.4/dist/dynamics-web-api.min.js"></script>

2.2 初始化

在浏览器中初始化 DynamicsWebApi：

var dynamicsWebApi = new DynamicsWebApi({
    webApiVersion: '9.0'
});

在 Node.js 中初始化 DynamicsWebApi：

var dynamicsWebApi = new DynamicsWebApi({
    webApiUrl: 'https://myorg.api.crm.dynamics.com/api/data/v9.0/',
    onTokenRefresh: acquireToken
});

2.3 基本操作

以下是一个简单的示例，展示如何使用 DynamicsWebApi 进行自动完成查询：

(async function() {
    const result = await dynamicsWebApi.autocomplete({
        query: {
            search: "mar"
        }
    });
    console.log(result.value);
})();

3. 应用案例和最佳实践

3.1 自动完成查询

在实际应用中，自动完成查询功能可以帮助用户快速找到所需的数据。以下是一个更复杂的自动完成查询示例：

(async function() {
    const result = await dynamicsWebApi.autocomplete({
        query: {
            search: "mar",
            filter: "account:modifiedon ge 2020-04-27T00:00:00",
            activities: {
                regardingobjecttypecode: 'account',
                annotation: {
                    objecttypecode: 'account'
                }
            }
        }
    });
    console.log(result.value);
})();

3.2 取消请求

在某些情况下，你可能需要取消正在进行的请求。DynamicsWebApi 支持通过 AbortController 对象来取消请求：

const controller = new AbortController();
const somethingHappenedMustAbort = () => controller.abort();

(async function() {
    try {
        const result = await dynamicsWebApi.autocomplete({
            query: {
                search: "mar"
            },
            signal: controller.signal
        });
        console.log(result.value);
    } catch (error) {
        if (error.name === 'AbortError') {
            console.log('请求已取消');
        } else {
            console.error(error);
        }
    }
})();

4. 典型生态项目

DynamicsWebApi 可以与其他 Microsoft Dynamics 生态系统中的项目结合使用，例如：

• Microsoft Power Apps: 用于快速构建业务应用程序。
• Microsoft Power Automate: 用于自动化业务流程。
• Microsoft Power BI: 用于数据分析和可视化。

通过这些工具的结合，你可以构建一个完整的业务解决方案，从数据收集、处理到分析和报告，全面提升业务效率。