用于Web Modeler的公共REST API - Camunda

Camunda 为 Web Modeler 提供了一个功能强大的公共开发人员可以利用它进行文件管理以及标准的 CRUD 操作（创建、读取、更新、删除）。通过 Web Modeler REST API，流程开发的自动化和简化变得更加高效。

您能用这个 API 做些什么？

Web Modeler REST API 不仅支持标准的 CRUD 操作，还提供了更多高级功能。开发人员可以通过 API 按名称、项目或目录路径搜索对象，甚至可以查找和比较里程碑。此外，该 API 还支持对合作者、文件、文件夹和项目的操作，极大地扩展了其应用场景。

如上图所示，Web Modeler REST API 提供了多种端点，涵盖了文件、项目、里程碑等多个方面的操作。

拥有 API 是一回事，但它如何为开发人员和组织带来实际价值呢？以下是几个典型的应用场景：

在数字化转型的过程中，可能会产生大量的模型和项目，导致 Camunda 环境变得杂乱无章。通过 Web Modeler REST API，您可以清理过期的文件和项目，保持系统的整洁和高效。

例如，您可以创建一个定期运行的程序，利用 GET 方法查找过去一年或其他时间段内未被修改的对象：

响应结果会返回符合条件的 fileId，随后可以使用 DELETE 方法删除这些文件：

需要注意的是，DELETE 方法会删除文件及其附加的所有资源（如注释、调用活动、业务规则任务链接等），且操作无法撤销。

为了在 Camunda 环境中实现项目命名的标准化，您可以利用 Web Modeler API 来生成符合规范的项目名称和结构。例如，通过提供一个用户界面，收集项目所有者或相关人员的输入信息，然后使用 POST 方法创建新项目：

如果需要，还可以通过 PUT 方法为项目分配合作者：

在持续集成（CI）和持续交付（CD）的过程中，流程改进是常见的需求。为了维护流程治理，保留流程版本的历史记录至关重要。通过 Web Modeler API，您可以使用里程碑端点的 GET 方法来比较两个里程碑：

API 将返回一个链接，展示两个里程碑之间的视觉对比，帮助您更好地管理流程版本。

安全性是任何 API 的核心。Web Modeler REST API 确保所有请求都经过验证，防止有害内容的引入。此外，API 提供了所有端点调用的日志记录功能，并支持在出现问题时清除错误消息。这些功能为开发人员提供了可靠的操作记录和问题排查支持。

Web Modeler REST API 是一个功能全面且安全的工具，能够帮助开发人员高效管理 Camunda 环境中的文件、项目和流程。无论是清理不必要的文件、创建新项目，还是比较里程碑，API 都能提供强大的支持，同时确保操作的安全性和可追溯性。

原文链接: https://camunda.com/blog/2023/10/public-rest-api-web-modeler/