Dynamics 365: 从0到1了解如何创建Custom API(1) - 在Power Apps中创建

已于 2024-05-07 17:06:37 修改
阅读量1.1k 收藏 32
点赞数 23
分类专栏： Dynamics CRM Dynamics 365 文章标签： Dynamics 365 Dynamics CRM
于 2024-05-04 21:51:20 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/djstone/article/details/138399176
版权

今天介绍一下如果创建Custom API，我们首先需要知道它和action有什么区别，什么时候使用Custom API或者Action?

  • Custom API和Action的区别

Create your own messages (Microsoft Dataverse) - Power Apps | Microsoft Learn

  • 什么时候使用Custom API或者Action?

Custom API与Action在参数较少的情况下，性能类似，但随着参数的增加，action的性能会开始下降。并且Custom API相较于Action更易于维护，比如在参数维护这块。对于新开发的API，只要不是有特殊需求的，我们都可以使用Custom API；对于老的action，我们可以根据它目前的性能来决定是否转成Custom API。

如果需要将Action转成Custom API的话，可以使用XrmToolBox里的Custom Action to Custom API Converter工具。

我们使用Power Apps创建一个custom api需要通常需要创建创建三条记录在解决方案中：自定义 API, 自定义API请求参数，自定义API响应参数 

1. 创建自定义API
  • 我们需要有一个新的解决方案，或者使用已有的解决方案，这里我们创建一个新的解决方案来用来存放Custom API。
  • 进入解决方案，新建 -> 更多 -> 其他 -> 自定义API（New > More > Other > custom API ）

  • 按照下面的截图去填写：
    • 负责人：可以填写user或者team的引用
    • 唯一名称：这个有填写规则，可以看我最后的注意事项
    • 描述：描述该custom api
    • 绑定类型：全局，实体，实体集合三种；如果想只针对某一个实体可用则选实体，并且在“绑定的实体逻辑名称”字段中填入实体的逻辑名称，比如:account; 全局的话“绑定的实体逻辑名称”字段为空。
    • 是否为功能：如果为是则走http get请求不会改变数据，并且url的长度不能超过32768个字符；如果为否则走http post请求，可以修改数据。
    • 允许的自定义处理步骤类型：这个我们选成"同步和异步"
    • 插件类型：这个字段虽然不是必填的，但是当我们创建完成Custom API，并且为我们的Custom API写好了插件代码后，我们需要把这个插件填入进去，这个我会在之后的帖子里进行演示。

2.  创建自定义API请求参数

解决方案，新建 -> 更多 -> 其他 -> 自定义API请求参数（New > More > Other > Custom API Request Parameter）

建议自定义API请求参数的名称和显示名称前加上自定义API的名称来进行区分，这样在解决方案中看起来会更加直观。

有几个输入参数就需要创建几条自定义API请求参数记录。

3. 创建自定义API响应属性

解决方案，新建 -> 更多 -> 其他 -> 自定义API响应属性(New > More > Other > Custom API Response Property)

自定义API响应属性也一样建议在名称和显示名称前加上自定义API的名称来进行区分，这样在解决方案中看起来会更加直观。

有几个响应参数就需要创建几条自定义API响应属性记录。

4. 创建完成上面的几步之后，我们就可以通过查看元数据来检查我们创建的这个API了，但前提是我们没有在创建自定义API的时候将"为专用"字段设为是。

查看元数据的方法：https://<yourorg>.<yourcrm>.dynamics.com/api/data/v9.1/$metadata

需要注意上面查看元数据的方法只适用于Global的D365,如果你的D365是21V的，也就是中国区的，那和这个地址是不一样的。

上面这些步骤完成后，接下来就是为Custom API编写插件代码，并与Custom API进行关联了，这一步我会在之后的帖子里去说明。

注意
  • 一旦Custom API创建后，有些字段就不可更改了，所以创建前需要谨慎填写
  • 对于自定义API中的唯一名称：它的值必须包含与解决方案发布者的前缀相匹配的自定义前缀，并且必须以字母开头，而且只能由字母数字和_.{}!字符。比如后面的这几个都是不可以的：djgetaccountbyid, djgetaccountbyid@
  • 对于自定义API中中的允许的自定义处理步骤类型，如果这个选为"无"，我们在后续创建step步骤的时候是会失败的，而如果没有步骤我们是不能使用插件注册工具这种方式来进行调试的。

  • 对于自定义API请求参数和自定义API响应属性：唯一名称不需要加前缀，并且调用api时的参数名称就是它
参考链接

Create and use custom APIs (Microsoft Dataverse) - Power Apps | Microsoft Learn

CustomAPI tables (Microsoft Dataverse) - Power Apps | Microsoft Learn

Create a custom API in Power Apps (Microsoft Dataverse) - Power Apps | Microsoft Learn

Stone-hdj
关注
专栏目录
通过Power Platform自定义D365 CE 业务需求 - 3. 使用Microsoft Power Apps
Martin-Mei的博客
09-12 561
Power应用程序和无代码、无代码平台的概念详细使用Canvas应用程序适用于Power应用程序的PowerFX使用模型驱动的应用程序Power Portal的概念和部署设计管理Power Apps业务场景和实施Power Automate 概念Power Automate中的连接器Flow的使用和类型流中的动态值和表达式使用变量、循环和条件在Power Automate中处理审批业务场景、用例和实现。
Microsoft Dynamics 365软件二次开发：Dynamics365部署与版本控制策略
最新发布
kkchenjj的博客
08-23 1573
在Microsoft Dynamics 365中，自定义实体允许开发者扩展系统以满足特定业务需求。自定义实体可以包含字段、选项集、关系和其他属性，与标准实体类似，但完全由用户定义。1. 登录到Dynamics 365环境。2. 转到“解决方案”区域，选择“自定义”。3. 在“自定义”菜单中，选择“实体”。4. 点击“新建”，输入实体名称，例如“客户反馈”。5. 添加字段，如“反馈类型”、“反馈日期”、“描述”等。6. 设置主键和唯一标识符。7. 定义关系，如与“客户”实体的关联。
D365API文档
yang651158的博客
08-02 2958
前台 1.访问后台方法 var rest = new fwREST(); var objStr = "accounts?$select=hms_sapcustomerid&$filter=accountid eq (" + customerid + ")"; rest.get(objStr).then(function (ob) { if (ob.value.error != undefined || ob.val
custom自定义API操作返回值说明
t79036912的博客
10-09 393
应用程序接口为：“‘电脑（Operating system）’或‘’提供给应用程序调用使用的代码”。其主要目的是让应用程序开发人员得以调用一组功能，而无须考虑其底层的源代码为何、或理解其内部工作机制的细节。API本身是的，它仅定义了一个，而不涉及应用程序在实际实现过程中的具体操作。
Dynamics 365 API 获取实体记录总数
zhanglianjun518的专栏
04-28 573
Dynamics 365 API 获取实体记录总数
Dynamics 365 支持使用Web Api 通过名称来检索元数据
Vic的博客
02-15 1880
关键检索元数据我在之前的一篇博文中稍有提及，当时是为了取实体的picklist字段的属性，但当时的版本只支持通过metadataid检索，而在365中又增加了名称的检索，方便了很多。   本篇依旧用之前博文中的例子来查询accout的实体的picklist元数据，下图是365online的查询结果，直接通过localname='account'进行查询picklist元数据，而不需要再去先抓取me
Dynamics 365: 从0到1了解如何创建Custom API(2) - Custom API与插件关联
05-05 474
这次我们主要写一个插件，与我们之前创建的Custom API进行关联。
淘宝/天猫API：custom-自定义API操作
08-05 444
淘宝/天猫自定义API操作 API
Dynamics 365: 从0到1了解如何创建Custom API(3) - Custom API的调试之插件调试
05-07 411
从0到1了解如何创建Custom API(3) - Custom API的调试之插件调试
Create Custom APIs in Dynamics 365 CRM | Power Platform
Vic的博客
12-17 732
Custom API，系统间集成的新方法，本质上来说和之前的Custom Action区别不大，但从定义到注册整套更规范化，UI配置更明了了。
PCF-Builder-VSCode:更快地构建Power Apps Component Framework自定义控件。 无需记住PCF CLI命令。 在一个选择列表中提供的所有命令供您执行。 https
05-17
更快地构建Power Apps Component Framework自定义控件。 无需记住PCF CLI命令。 在一个选择列表中提供的所有命令供您执行。 用法 通过Ctrl+Shift+P查看命令列表，然后键入PCF Builder 要求 您的计算机上需要具备以下...
Microsoft Dynamics 365软件二次开发：Dynamics365集成开发：连接外部系统
kkchenjj的博客
08-23 636
Dynamics 365允许创建自定义连接器，以封装和简化与外部系统的集成。自定义API可以是HTTP触发的函数，用于处理与外部系统的通信。在Power Platform中创建连接器，定义其参数、操作和响应。],使用Azure Functions或Power Automate实现自定义API的逻辑。// Azure Functions示例// Azure Functions示例 using Microsoft . AspNetCore . Mvc;
Microsoft Dynamics 365软件二次开发：Dynamics365开发环境搭建与配置
kkchenjj的博客
08-22 878
在Microsoft Dynamics 365中，自定义页面是实现业务需求的关键步骤。这包括创建自定义实体、调整现有实体的视图、以及构建完全自定义的Web资源。假设我们有一个销售订单实体，我们想要添加一个自定义按钮来计算订单的总金额。首先，我们需要在实体上添加一个按钮，然后编写JavaScript代码来调用Web API。
custom - 自定义API操作订单，商品接口
weixin_49929204的博客
09-23 309
custom2.0 - 自定义API操作 详情文档：https://open.taobao.com/api.htm?docId=46&docType=2 测试链接：订单和商品同步
测试Java调用Dynamics 365 CRM的API并实现CURD
weixin_44136823的博客
08-25 666
import com.microsoft.aad.adal4j.AuthenticationResult; import com.microsoft.aad.adal4j.AuthenticationContext; import io.vertx.core.json.JsonObject; import netscape.javascript.JSObject; import org.apache.http.HttpResponse; import org.apache.http.client.Htt
Power Apps自定义组件
lisong315389的博客
04-21 870
自定义组件基础篇-Tab。
custom-api
03-16
下载 git clone custom_api 获取实体 开机自检到网址： / api / {entity_type} / get / {id} 查询参数主题[自愿]：主题名称，用于获取区域的可见块。 身体： 模式[必须] 主体具有您需要返回的数据的架构： { " schema " : { " title " : [] } } { " schema " : { " title " : [], " field_image " :[ " large " ] } } { " schema " : { " title " : [], " field_image " :[ " large " ], " field_media " : { " field_media_image " : [ "
Designing-and-Building-Custom-Apps-using-Dynamics-365:由Packt发布，使用Dynamics 365设计和构建自定义应用程序
05-28
使用Dynamics 365设计和构建自定义应用程序[视频] 这是出版的的代码存储库。 它包含从头到尾完成视频课程所需的所有支持项目文件。 关于视频课程 本课程演示了Microsoft Dynamics 365客户参与发布的新功能。 本课程使用新的统一用户界面，使用示例应用程序来演示如何使用C＃插件/工作流活动以及TypeScript生成的Web资源来构建Dynamics 365 for Customer Engagement平台的复杂扩展。 一开始，本课程将确保您使用Microsoft Team Services，npm，Nuget和Gulp进行快速有效的协作开发所需的一切设置，以及成熟的持续集成管道。 这包括服务器端和客户端代码的自动化单元测试，以及解决方案的打包和部署。 然后，它教您一个用于在Dynamics 365中对实体进行有效数据建模的框架，以及如何使用用户故事映射在迭代中建
Dynamics 365: 如何在Azure AD中创建用户并添加到Dynamics 365 Online中
05-31 1024
我这里主要讲的是Dynamics 365 Online如何来添加用户。对于on-premise版本和online版本最大的区别就在于Online版本是在Azure Active Directory中添加，而OP版本是在你自己的AD中添加。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Stone-hdj

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值