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

已于 2024-05-07 17:06:37 修改
阅读量988 收藏 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
关注
  • 23
    点赞
  • 踩
  • 32
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
custom自定义API操作返回值说明
t79036912的博客
10-09 353
应用程序接口为：“‘电脑（Operating system）’或‘’提供给应用程序调用使用的代码”。其主要目的是让应用程序开发人员得以调用一组功能，而无须考虑其底层的源代码为何、或理解其内部工作机制的细节。API本身是的，它仅定义了一个，而不涉及应用程序在实际实现过程中的具体操作。
MB-400-Microsoft-PowerApps-Dynamics-365:MB-400 Microsoft PowerApps + Dynamics 365 开发人员
05-31
MB-400 Microsoft PowerApps + Dynamics 365 开发人员你是MCT吗？ - 查看我们需要手动构建实验室说明吗？ - 存储库中提供了说明我们在做什么？ 为了支持本课程，我们需要经常更新课程内容，使其与课程中使用的 Azure...
Dynamics 365 API 获取实体记录总数
zhanglianjun518的专栏
04-28 547
Dynamics 365 API 获取实体记录总数
Dynamics 365详解
Documentlv的博客
03-14 5021
Dynamics 365是微软公司推出的一款企业资源计划（ERP）和客户关系管理（CRM）软件。它是微软旗下的云计算平台Azure上的一项服务，能够在多个设备和平台上运行。Dynamics 365结合了ERP和CRM的功能，以及人工智能、物联网等技术，为企业提供了全面的业务解决方案。Dynamics 365是一款功能强大的企业资源计划和客户关系管理软件。在开发Dynamics 365应用程序时，需要使用相应的开发工具和技术。
D365API文档
yang651158的博客
08-02 2510
前台 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
Dynamics 365: 从0到1了解如何创建Custom API(2) - Custom API与插件关联
最新发布
05-05 382
这次我们主要写一个插件，与我们之前创建的Custom API进行关联。
Level up for Dynamics 365/Power Apps-crx插件
03-28
无需书签即可在Dynamics 365 / Power Apps中快速执行高级/隐藏操作。 该扩展程序可帮助Dynamics 365 / Power Apps用户执行通常需要书签的高级操作。 可以在https://github.com/rajyraman/Levelup-for-Dynamics-CRM中...
crm-powerbi-viewer:将Power BI中的图块和报表嵌入到Dynamics CRM表单和仪表板中
05-17
**CRM Power BI Viewer** 是一个解决方案，它允许用户将Power BI的图表、仪表板和报告无缝集成到Dynamics 365的销售和服务表单以及仪表板中。这个功能极大地提升了数据分析的直观性和效率，使得业务人员在处理日常...
AssignPluginDynamics365:在Dynamics CRM 365中使用插件将案例分配给适当的团队用户
05-10
AssignPluginDynamics365... 在Dynamics CRM / 365中使用插件将案例分配给适当的团队用户 跟随随附的文章， 为 该代码是一个Dynamics CRM插件，如果您有与本文所述类似的要求，则可以直接使用或进行少量修改即可使用。
动态CRM升级：适用于Dynamics CRM365的Chrome，Edge Chromium和Firefox扩展PowerApp高级用户
01-30
适用于Dynamics CRM / 365 / Power Apps Power用户的Chrome扩展程序 用法 从Chrome商店安装扩展程序。 或来自Firefox插件。 详细功能 行动 它能做什么 逻辑名称 显示字段，选项卡和部分的逻辑名称。 清除逻辑名称 ...
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 " : [ "
Power Apps自定义组件
lisong315389的博客
04-21 710
自定义组件基础篇-Tab。
【转】Dynamics CRM 365零基础入门学习（三）Dynamics 通过Web API 来调用自定义的Action（使用插件）
sinolover的专栏
07-16 1989
今天想实现一个Search Product的功能，首先要将数据展示在页面，然后前端根据查询需求进行处理。之前是在salesforce中实现的，可以定义一个Search Product的页面，然后在页面中访问查询数据的Webservice即可。但是在Dynamic 365中并没有这种直接调用的方式，最终找到一种方式就是，前端页面通过Js调用工作流中的Action，而在Action上绑定了插件。 实现效果 （1） 实现html页面并导入系统 在设置中找到自定义项，然后进去自定义系统，选择Web资源，然
Dynamics 365 Web Api 创建与更新返回记录ID及更新后的数据记录
Vic的博客
08-17 2494
在Dynamics CRM2016中web api的创建返回的status是204，response中没有返回任何数据，所以我们在要取返回数据记录的id时必须要通过截取字符串的方式去header中取。   那Dynamics 365改进了这个问题，通过在请求头中加prefer的方式，对创建的repuest进行了改进 var entity = {}; entity["name"] = '测试
淘宝/天猫API：custom-自定义API操作
08-05 258
淘宝/天猫自定义API操作 API
Dynamics 365 Web API模拟用户
Vic的博客
06-11 1643
   在实际业务场景中，用户只能看到自己权限内的数据，比如客户数据，公司的销售员只能看到属于自己的客户数据，但有这么个场景又需要某个销售员A去读取另一个销售员B的数据(当然他是没有权限读取的)，这种场景下该怎么办，当然这个假设场景不一定合理，只是一种假设来引出本篇要讲的内容。   上述场景即可以使用模拟用户来操作，在JS中读取B的数据时，我们可以模拟B的权限而不是当前A的权限。    只需在常规的...
Dynamics 365 Web API 与Organization Services的区别及其功能深度分析
GhostHouse
11-25 6486
今天博主带小伙伴们来围观下Dynamics 365 Web API和Organization Service的区别，对于还不知道Dynamics 365是什么的小伙伴可以去思过崖面壁思过了。Dynamics 365是微软新一代的企业级应用平台，它把CRM和ERP进行了整合并作为一款统一的企业级平台软件为企业级客户提供服务，在上面我们不但能使用之前Dynamics CRM的功能，而且还能使用Dyna
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

打赏作者

Stone-hdj

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

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

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

打赏作者

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

抵扣说明：

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

余额充值