View a markdown version of this page

集成 - Amazon Quick
AWS 服务外部应用程序REST API 集成

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

集成

AWS 服务

Amazon S3

Amazon S3 操作允许您存储和检索文件和数据。

可用操作

  • 下载文件-从 Amazon S3 下载文件并返回文件对象句柄。

  • 上传文件-将文件对象句柄上传到 Amazon S3。

  • 复制对象-将已存储在 Amazon S3 中的对象从一个源文件创建到目标位置的副本。

  • 删除对象-从 S3 存储桶中删除指定对象。

  • 列出对象-列出给定存储桶中的所有对象。可以使用前缀进行过滤。

Amazon Bedrock

Amazon Bedrock 操作允许您通过单个 API 连接到领先的人工智能公司的基础模型 (FMs)。

  • 基础模型交谈-向 AI 模型发送提示。使用自然语言生成文本、分析内容并获得 AI 支持的响应。

  • 高级模型匡威-使用更多选项提示模型。高级选项包括自定义消息格式、工具集成和对模型行为的精细控制。

Amazon 基岩代理商

Amazon Bedrock Agent 操作允许您调用可以连接到您的数据源和后端系统的 AI 助手。 APIs

  • 基本代理调用-向 AI 代理发送请求。用于不需要文件附件、用户输入或自定义配置的简单交互。

  • 高级代理调用-使用更多选项呼叫代理。用于需要文件附件、用户输入或自定义配置的高级交互。

Amazon Bedrock 数据自动化

基岩数据自动化 (BDA) 简化了使用生成式 AI 从非结构化内容中提取宝贵见解的过程。

可用操作

  • 调用数据自动化异步-使用数据自动化项目或蓝图处理数据。启动异步数据处理并返回调用 ID。

  • 获取数据自动化状态-获取有关数据自动化调用状态和输出位置的详细信息。

Amazon Textract

Amazon Textract 可帮助您在自动化系统中添加文档文本检测和分析。

  • 基本文档查询-根据问题提取数据。每个查询都包含您要问的问题和要关联的别名。Textract 提供每个问题的文字答案和置信度分数。

  • 基础文档分析-从文档中提取数据。自动检测和提取表单（键值对）、表格（结构化数据）和文本，同时保留文档布局和数据关系。

Amazon Comprehend

Amazon Comprehend 是一项自然语言处理 (NLP) 服务，用于深入了解文档内容。它有助于分析文本以提取关键短语、识别情绪和对文档进行分类。

可用操作

  • 分类文档-创建分类请求，使用自定义模型端点实时分析单个文档。支持文本输入或文档文件（PDF、Word 或图像）。

  • 检测关键短语-检测文本中的关键名词短语，识别内容中的重要概念和主题。

外部应用程序

Microsoft Outlook

Microsoft Outlook 操作允许你的自动化来管理电子邮件和日历。

  • 电子邮件

    • 发送用户电子邮件-代表特定用户发送电子邮件。

    • 回复电子邮件-回复邮件的发件人。

    • 列出文件夹消息-获取登录用户邮箱中特定文件夹中的消息。

    • 列出用户邮件-获取已登录用户的邮箱（包括 “已删除邮件” 和 “杂乱邮件” 文件夹）中的邮件。

    • 查看电子邮件-检索特定消息对象的属性和关系。

    • 更新电子邮件-更新消息对象的属性。

    • 删除电子邮件-删除指定用户邮箱中的邮件。

    • 列出电子邮件附件-检索附加到邮件的附件对象列表。

    • 获取附件-读取附件的属性、关系或原始内容。

  • 文件夹

    • 列出邮件文件夹-直接在登录用户的根文件夹下获取邮件文件夹集。

    • 将电子邮件移至文件夹-将邮件移动到指定用户邮箱内的其他文件夹。

    • 获取邮箱设置-获取用户的邮箱设置，例如自动回复、日期格式和时区。

  • 日历

    • 列出日历事件-从 Microsoft Outlook 中获取指定用户或资源的日历事件列表。

    • 创建日历活动-在用户的默认日历或指定日历中创建活动。

    • 更新日历事件-更新现有事件对象的属性。

  • 其他

    • 列出地点-获取租户中定义的地点对象（房间或房间列表）的集合。

    • 列出用户-从 Microsoft Outlook 中检索组织中的用户列表及其基本信息。

    • 列出联系人-从登录用户的默认联系人文件夹中获取联系人集合。

Microsoft Teams

Microsoft Teams 操作允许你的自动化通过频道和聊天消息与团队成员沟通，以及管理会议。

  • 消息

    • 列出聊天记录-查看所有聊天对话

    • 创建聊天-开始新的聊天对话

    • 进行个人聊天-查看特定聊天的详细信息

    • 列出所有聊天消息-查看聊天对话中的消息

    • 发送聊天消息-在聊天中发送新消息

  • 团队

    • 列出团队-查看经过身份验证的用户可以访问的所有团队

    • Get Team-查看有关特定团队的详细信息

    • 列出所有团队成员-查看团队成员

    • 邀请用户加入团队-向团队添加新成员

  • 渠道

    • 列出所有频道-查看特定团队中的所有频道

    • 创建频道-在团队中创建新频道

    • 获取频道-查看有关特定频道的详细信息

    • 列出所有频道消息-查看频道中发布的消息

    • 发送频道消息-向频道发布新消息

    • 回复频道消息-添加对现有频道消息的回复

    • 邀请频道成员-将成员添加到特定频道

  • 会议

    • 创建在线团队会议-安排新的在线会议

    • 获取在线团队会议-查看特定会议的详细信息

    • 列出所有录音-查看会议录音

    • 列出所有笔录-查看会议记录

  • Users

    • 列出用户-查看组织中的用户列表

微软 SharePoint

Microsoft SharePoint 允许你通过自动化系统集中存储、管理和共享文档和信息。

  • 清单和项目

    • 获取列表-获取与列表关联的操作列表

    • 创建项目-在列表中创建新的列表项

    • 更新项目-更新 ListItem 上的属性

    • 删除项目-从列表中移除项目

    • Get Item-返回列表中某项的元数据

    • 列表项目-获取列表中的项目集合

  • 表格和文件

    • 添加工作表-向工作簿添加新工作表

    • 删除工作表-从工作簿中删除工作表

    • 更新工作表-编辑工作表属性（重命名、可见性）

    • 列表表格-检索工作表对象列表

    • 阅读工作表-检索工作表的属性

    • 上传文件-创建或更新工作簿文件

  • 范围和单元格

    • 读取范围-从指定范围检索值

    • 删除范围-删除指定范围内的单元格

    • 写入范围-更新指定范围内的值

    • 获取已用范围-返回给定工作表的已用范围

    • 清除范围-清除范围值，包括格式、填充和边框

    • 读取单元格-从特定单元格获取值

    • 写入单元格-设置特定单元格的值

微软 OneDrive

Microsoft OneDrive 操作允许你存储、同步和共享文件。你可以直接与保存到的 Microsoft Excel 文件进行交互以 OneDrive 进行电子表格操作。

  • 文件管理

    • 获取项目-查看特定文件或文件夹的详细信息

    • 获取云端硬盘-查看 OneDrive 账户详情和存储空间信息

    • 列表项目-查看云端硬盘中的所有文件和文件夹

    • 创建项目/创建文件夹-在中创建新文件夹或项目 OneDrive

    • 列出子项-查看特定文件夹中包含的项目

    • 删除项目-移除文件或文件夹

    • 更新项目/移动项目-更新元数据或在文件夹之间移动文件

    • 复制项目-在其他位置创建文件或文件夹的副本

    • 添加权限-配置文件的共享和访问权限

    • 上传文件-将新文件添加到 OneDrive

  • Excel

    • 添加工作表-在 Excel 工作簿中创建新工作表

    • 清除范围-从一系列单元格中移除内容和格式

    • 删除范围-从工作表中删除单元格、行或列

    • 删除工作表-从工作簿中移除工作表

    • 列表表格-查看工作簿中的所有工作表

    • 读取单元格-获取特定单元格的值

    • 读取范围-从一系列单元格中获取值

    • 阅读工作表-查看整个工作表的内容

    • 读取使用范围-获取包含数据的单元格范围

    • 更新工作表-修改工作表属性

    • 写入单元格-设置特定单元格的值

    • 写入范围-为一系列单元格设置值

Salesforce

Salesforce 操作允许您自动管理客户关系的流程，包括案例、机会、潜在客户、营销活动、联系人等。

  • 案例

    • 获取案例列表-从 Salesforce 获取客户支持案例列表，包括其元数据和最近的项目。

    • 获取案例-查看特定案例的详细信息

    • 创建案例-创建新的支持案例

    • 删除案例-移除现有案例

    • 更新案例-编辑案例详情和信息

  • 商机

    • 获取机会-查看销售机会列表

    • 获取特定机会-查看特定机会的详细信息

    • 创造机会-创造新的销售机会

    • 更新机会-编辑机会详情

    • 删除商机-删除现有商机

  • 销售线索

    • 更新潜在客户-编辑潜在客户详情和信息

  • 活动

    • 更新广告活动-编辑活动详情和信息

  • 饲料物品

    • 更新 Feed 项目-编辑 Feed 项目的内容和属性

  • Contacts

    • 获取联系人列表-查看系统中的所有联系人

    • 获取联系人-获取特定联系人的详细信息

    • 更新联系人-编辑联系人信息

  • Users

    • 获取用户列表-检索 Salesforce 用户列表

  • 系统

    • 描述 SObject-获取任何 Salesforce 对象类型的对象元数据和字段详细信息

Jira

Jira 操作允许您自动管理问题、项目、冲刺等。

  • 问题

    • 创建议题-在项目中创建议题。

    • 编辑议题-修改项目中的现有议题。

    • 更新问题状态（执行过渡）-更改议题的任务状态。

    • 删除议题-删除项目中的议题。

    • 获取问题-查看项目中问题的详细信息。

    • 搜索议题-使用 JQL 搜索议题

    • 搜索状态-搜索问题状态。

    • 下载问题附件-查看附件的内容。

    • 添加附件-为议题添加附件。

    • 获取所有标签-查看所有标签。

  • 注释

    • 添加评论-为议题添加新评论。

    • 删除评论-从议题中删除评论。

    • 更新评论-编辑对议题的现有评论。

    • 获取评论-查看问题评论。

  • Projects

    • 创建项目-在 Jira 中创建新项目。

    • 更新项目-修改项目详细信息。

    • 删除项目-从 Jira 中移除项目。

    • 获取项目-查看项目详细信息。

    • 获取项目问题类型-查看项目问题类型。

    • 搜索项目-查找可见的项目。

  • 冲刺

    • 创建 Sprin t-在项目中创建冲刺。

    • 更新 Sprint-更新冲刺详情。

    • 删除 Sprin t-删除项目中的冲刺。

    • 获取 Sprint-查看项目中冲刺的详细信息。

    • 将问题移至 Sprint 并进行排名-将议题分配给冲刺。

    • 将议题移至待办事项列表-将议题移至待办事项列表。

  • Users

    • 查找用户-搜索 Jira 用户。

    • 查找可分配用户-返回可分配给议题的用户列表。

    • 获取所有用户-列出所有 Jira 用户。

ServiceNow

ServiceNow 操作允许您自动管理事件、变更请求等 IT 服务。

  • 意外事件

    • 创建事件-创建新的事件记录。

    • 阅读事件-检索特定事件的详细信息。

    • 更新事件-修改现有的事件记录。

    • 删除事件-删除特定的事件记录。

  • 变更请求

    • 创建变更请求-创建新的变更请求记录。

    • 读取变更请求-检索特定变更请求的详细信息。

    • 更新变更请求-修改现有的变更请求记录。

    • 删除变更请求-删除特定的变更请求记录。

  • 知识库文章

    • 更新知识库文章-修改现有的知识库文章。

  • 问题记录

    • 更新问题记录-修改现有问题记录。

  • 附件

    • 上传二进制附件-将文件作为附件上传到指定记录。

    • 上传分段表单附件-将表单附件上传到记录。

    • 检索附件内容-获取特定附件的二进制内容。

    • 检索附件元数据-获取特定附件的元数据。

    • 删除附件-从系统中删除附件。

    • 检索附件的元数据-获取多个附件的元数据。

  • 系统

    • 列出用户-检索系统用户表中的所有现有记录。

    • 列表选项-从系统检索选项列表值。

SAP

借助 SAP 操作，您可以自动执行涉及业务合作伙伴数据、物料库存、物料清单、主产品和实地库存的流程。

  • SAP 业务合作伙伴

    • 获取业务合作伙伴-检索业务合作伙伴的一般数据，提供合作伙伴信息的全面视图。

    • 通过 ID 获取业务合作伙伴-使用特定的业务合作伙伴编号作为标识符检索详细的业务合作伙伴数据。

    • 获取业务合作伙伴地址-检索与业务合作伙伴关联的地址详细信息，包括邮政地址和联系信息。

    • 获取业务合作伙伴角色-检索业务合作伙伴的角色信息，显示他们在系统中的关系和职能。

    • 按 ID 获取业务合作伙伴角色-使用关键标识符字段检索业务合作伙伴的特定角色数据。

  • SAP 材料库存

    • 在账户模型集合中获取材料库存-获取材料库存水平，包括批次、存储位置和特殊库存指标等详细信息。

  • SAP 物料清单

    • 获取物料 BOM 物料-检索物料清单中使用的物料的详细信息，包括数量、类别和关系。

  • SAP 产品大师

    • 获取产品主记录-查看产品主记录一般详细信息。返回完整的产品主记录，以及用于筛选、排序和选择特定数据的选项。

    • 获取产品主记录的工厂数据-查看产品的工厂详细信息。访问给定产品的详细工厂特定信息，包括制造、存储和物流数据。

    • 按产品编号和工厂获取供应计划数据-按产品编号和工厂查看供应计划详细信息。检索详细的计划参数，包括批量、安全库存水平和采购数据。

  • SAP 实地盘点

    • 获取 Phys Inventory 文档项目-检索实地盘点文件项目，包括盘点结果和库存差异。

REST API 集成

REST API Connection 集成使 Quick Automate 能够与自定义 REST APIs 和 Web 服务进行交互，从而允许您将自动化功能扩展到外部系统。此集成支持 GET、POST、DELETE、PATCH 和 PUT HTTP 方法的操作执行。

常见用例：

  • 向外部系统发送通知

  • 从第三方服务检索数据

  • 更新外部数据库中的记录

  • 在连接的应用程序中触发工作流程

先决条件

在使用 REST API 集成创建自动化之前，请确保：

  • 配置的 REST API 集成

    • 访问快速套件控制台

    • 导航到集成 > REST API 连接

    • 使用基本网址配置你的 REST API 端点

    • 完成身份验证设置（参见下面的身份验证部分）

    • 完整细节：REST API 连接集成

  • 与自动化组的互联集成

    • 将您配置的 REST API 集成关联到您的自动化群组

    • 验证集成是否出现在可用操作中

    • Step-by-step 指南：AWS 服务操作连接器

  • 已配置身份验证

    • OAuth 从 API 提供商处获得的 2.0 凭证

身份验证

对于 Quick Automate，此集成支持 OAuth 2.0 身份验证。在创建自动化之前，必须配置 OAuth 凭据。

OAuth 2.0 安装步骤：

  • 从您的身份提供商处获取 OAuth 证书（客户端 ID 和客户端密钥）

  • 在 Quick Suite 控制台中，导航到你的 REST API 集成设置

  • 选择 OAuth 2.0 作为身份验证方法

  • 输入您的客户端 ID 和客户机密钥

  • 配置 API 提供商提供的授权网址和令牌网址

  • 完成授权 Quick Suite 的 OAuth 流程

  • 测试连接以验证身份验证

重要注意事项：

  • Quick Automate 不支持请求标头中的持有者令牌身份验证。改用 OAuth 配置。

  • 在集成级别配置身份验证，而不是按自动化操作配置身份验证

配置

设置你的 REST API 集成

步骤 1：创建基本 URL 配置

步骤 2：Connect 到自动化组

步骤 3：访问 REST API 操作

  • 在自动化系统中打开动作面板

  • 找到 REST API 操作

  • 将操作拖放到您的自动化工作流程中

  • 注意

    REST API 操作必须通过操作面板添加；它们在 “使用助手构建” 界面中不可用

属性参考

  • Q 操作连接器 ID（必填）

    • 描述：将 REST API 操作链接到您配置的集成的唯一标识符，包括基本 URL 和身份验证设置。

    • 格式：通过连接的集成自动填充

    • 示例：rest-api-connector-abc123

  • URI（可选）

    • 描述：附加到基本 URL 的路径，用于指定确切的 API 端点。

    • 格式：带或不带前导斜杠的路径字符串（取决于基本 url 格式）

    • 工作原理：

      • 基本网址：https://api.example.com

      • URI: /users/123

      • 最终网址：https://api.example.com/users/123

    • 示例：

      /users/123
prod/send-email
/v2/orders
customers/search

  • 其他标题（可选）

    • 描述：要作为键值对包含在 API 请求中的自定义 HTTP 标头。

    • 格式：

      Key: Value

    • 常见示例：

      Content-Type: application/json
Accept: application/json
X-Custom-Header: custom-value
X-API-Version: 2.0

    • 重要限制：

      • 请勿包含授权标头；身份验证通过 OAuth 配置处理

      • 每个标题必须位于单独的行上

      • 标题区分大小写

  • 请求（必填）

    • 描述：要通过 POST 或 PUT 请求发送的 JSON 格式的数据。

    • 格式：有效的 JSON 对象。{} 表示空白请求

    • POST 请求示例（创建资源）：

      {
  "title": "My New Post",
  "body": "This is the content of my new post.",
  "userId": 1,
  "tags": ["automation", "api"],
  "published": true
}

    • PUT 请求示例（更新资源）：

      {
  "status": "completed",
  "completedDate": "2026-01-27",
  "notes": "Task finished successfully"
}

  • 输出变量（可选）

    • 描述：用于存储 API 调用的 JSON 响应的变量名称，以便在后续的自动化操作中使用。

    • 格式：字母数字变量名（无空格）

    • 示例：apiResponse、userData、orderDetails

API 使用示例

示例 1：获取请求-检索票证详情

场景：从外部工单系统检索现有支持票证的详细信息

配置：

  • Q 操作连接器 ID： rest-api-connector-tickets

  • HTTP 方法：GET

  • URI: /tickets/ ticketId

  • 其他标题：

    Accept: application/json

  • 请求正文：{}（GET 请求为空）

  • 输出变量：TicketDetails

示例 2：POST 请求-创建新记录

场景：向外部票务系统提交新的支持请求

配置：

  • Q 操作连接器 ID： rest-api-connector-tickets

  • HTTP 方法：POST

  • URI: /tickets

  • 其他标题：

    Content-Type: application/json
Accept: application/json

  • 请求正文：

    {
  "title": "{{ticketTitle}}",
  "description": "{{ticketDescription}}",
  "priority": "{{ticketPriority}}",
  "requestedBy": "{{userEmail}}",
  "category": "technical_support"
}

  • 输出变量：ticketResponse