协作控制和设置 REST API 参考

警告

模型驱动应用程序的协作控件将于 2024 年 5 月停用。 退休将分两个阶段进行，以确保平稳过渡。 下表详细介绍了停用过程的时间线及其影响：

Timeframe	操作	影响
2024 年 2 月	将不再可从 AppSource 安装协作控件。	- 无法在 Power Apps 环境中部署协作控件。 - 现有安装不受影响。
2024 年 5 月	为控件提供支持的内部服务将停用。	- 控件将停止支持与 Microsoft 365 集成，并将错误返回给用户。 通过控件生成和管理的数据不会受到影响。 有关详细信息，请参阅本文后面的表。

通过控件创建和管理的项目在服务停用后将继续存在。

控制	影响
审批	在“审批”控件中创建的审批将保留在“审批”应用中，但不再可在“审批”控件中访问。
Files	在“文件”控件中管理的文件将保留在 SharePoint 中，但不再可在“文件”控件中访问。
会议	在“会议”控件中创建的会议将保留在 Outlook 和 Teams 日历中，但不再可在“会议”控件中访问。
注意	在 Notes 控件中创建的备注将保留在 Dataverse 备注表中。
Tasks	在任务控件中创建的任务将保留在 Planner 中，但不再可在 Task 控件中访问。

建议从所有 Power Apps 解决方案中删除协作控件和协作连接器，并为即将停用的协作控件的用户做好准备。

开发人员可以使用协作控件和设置 REST API 来管理设置、启动、映射和检索自己的业务模型实体的协作活动。 协作控件仅在 公共开发人员预览版中可用。

REST 操作：协作 - 自定义 API

操作	说明
关联协作映射	将协作实体关联到协作会话。
开始协作会话	创建链接到业务实体、应用程序上下文和可选元数据的协作会话记录。
取消关联协作映射	取消映射实体与给定协作会话的关联。
检索协作映射	获取特定实体类型的会话的协作映射列表。
检索协作会话	根据提供的参数获取协作会话记录。
更新协作映射	更新协作映射记录及其元数据（如果提供）。
更新协作会话	更新协作会话记录及其元数据（可选）。

REST 操作：协作 - 标准 OData API

操作	说明
按 ID 获取协作映射	从协作地图记录中获取详细信息。
获取协作元数据	获取给定协作映射或协作根实体名称的协作元数据记录的列表。
获取协作根	列出创建的所有协作会话。

REST 操作：设置 - 自定义 API

操作	说明
创建和更新设置	创建或更新与组路径和设置定义名称匹配的设置。
检索 Null 设置	返回没有值的设置定义列表。
检索设置	返回组中特定设置或设置的列表。

REST 操作：设置 - 标准 OData API

操作	说明
删除设置定义	删除设置定义。
删除设置组	删除设置组。
删除设置类型	删除设置类型。
删除设置值	删除设置值。
获取设置定义	列出设置定义。
获取设置组	列出设置组。
获取设置类型	列出设置类型。
获取设置值	列出设置值。
修补程序设置定义	更新设置定义。
修补程序设置组	更新设置组。
修补程序设置类型	更新设置类型。
修补程序设置值	更新设置值。
Post 设置定义	创建新的设置定义。
Post 设置组	创建新的设置组。
发布设置类型	创建新的设置类型。
Post 设置值	创建新的设置值。