使用表单数据请求类型将各种参数添加到请求正文中。

操作

启用了以下参数操作：

添加
将参数添加到请求正文中。
单击添加图标以添加参数。 在参数表标题上显示的参数计数会自动更新。
编辑
编辑请求正文中可用的现有参数。
在参数表中，将鼠标悬停在要编辑参数的垂直省略号图标上，然后单击编辑图标。 您可以在编辑参数模态框中编辑键、键类型和参数的值。
启用/禁用
启用或禁用请求正文中可用的参数。 您可以禁用以下场景的参数：
  • 当 API 请求使用默认值时。
  • 在推出的受控连接器软件包中引入新功能时。
  • 在测试和迭代连接器软件包中的新功能时。
  • 在排查包含错误参数的连接器软件包时。
在参数表中，将鼠标悬停在要启用或禁用参数的垂直省略号图标上，然后单击启用/禁用开关。 参数的状态会在参数表中相应更新。 已禁用的参数不包含在已发布的连接器软件包中。
复制
复制请求正文中可用的现有参数。
在参数表中，将鼠标悬停在相应参数的垂直省略号图标上，然后单击复制图标以复制所选参数。 确保您在复制模态框中输入新密钥。 原参数的所有其他属性都将被复制到新参数。 复制后，默认启用新参数。 使用启用/禁用切换按钮手动禁用参数。 在使用复制选项创建新参数时，参数表标题中的参数计数会自动更新。
您可以在复制模态框中更改重复参数的键类型和值类型。
删除
删除请求正文中可用的参数。
执行以下操作之一以删除参数：
  • 单击表头中的全选复选框，然后单击表格上方可用的删除图标以删除多个参数
  • 将鼠标悬停在每个参数的垂直省略号菜单上，然后单击删除图标以单独删除参数。

参数表

参数表标题显示操作中请求参数的总数。 此数字包括已启用和已禁用的参数。

在表中查看以下参数详细信息。

列 描述
键 显示参数键。 软件包用户无法在 机器人编辑器 或 API 任务 编辑器中查看该键。 键作为标头的一部分发送。
密钥类型 显示表单数据的类型。 它决定数据的解读和处理方式。
  • 文本： 如果键类型是简单的文本输入。 内容被视为纯文本 (text/plain)。 这类键类型适用于名称、地址或描述等数据。
  • 文件： 如果键类型是二进制文件上传。 内容是上传文件本身的原始数据。 这类键类型用于上传文档、图片或其他二进制数据。
    注： 文件类型字段始终由用户定义，用户可以通过 机器人编辑器 上传文件。
值 显示参数值。 软件包用户可以在 机器人编辑器 或 API 任务 编辑器中查看此值，并可以更新此值。
值由用户提供 显示值状态。
  • 是： 如果值是用户提供的。 在 机器人编辑器 或 API 任务 编辑器中配置此参数时，软件包用户需要提供一个适当的值。
  • 否： 如果该值是硬编码的。 软件包用户无法在 机器人编辑器 或 API 任务 编辑器中查看此值。 此值作为标头的一部分发送。
状态 显示参数状态。
  • 已启用： 如果参数启用。
  • 禁用： 如果参数禁用。
标签 显示用户提供值的标签。 软件包用户可以在 机器人编辑器 或 API 任务 编辑器中查看参数标签。
描述 显示参数描述。 软件包用户可以在 机器人编辑器 或 API 任务 编辑器中查看参数描述。

添加请求主体参数

执行以下步骤，将参数添加到表单数据请求正文：

  1. 单击配置窗格中的请求正文选项卡。
  2. 从类型下拉列表中选择表单数据。
  3. 单击表格顶部的添加参数或加号 (+) 图标，以添加参数。
  4. 在添加参数模态框中执行以下操作。
    1. 密钥： 输入适当的密钥名称。 密钥名称不会在 机器人编辑器 或 API 任务 编辑器中显示给软件包用户。 此名称作为标头的一部分发送。
    2. 密钥类型： 从下拉列表中选择适当的密钥类型。
    3. 在值将为部分选择以下选项之一：
      类型 描述
      硬编码 输入一个为该参数硬编码的值。 软件包用户无法在 机器人编辑器 或 API 任务 编辑器中查看此值。 此值作为标头的一部分发送。
      用户提供
      1. 值输入类型： 如果您想保护值输入类型，请启用此复选框。 选择保护时，您可以通过凭据、变量或不安全字符串输入参数。
      2. 该字段是否必填？： 根据参数要求选择否或是。
      3. 值（可选）： 输入值。 软件包用户可以在 机器人编辑器 或 API 任务 编辑器中查看此值，并可以更新此值。
      4. 标签： 输入参数标签。 软件包用户可以在 机器人编辑器 或 API 任务 编辑器中查看参数标签。
      5. 描述(可选)： 输入参数描述。 软件包用户可以在 机器人编辑器 或 API 任务 编辑器中查看参数描述。 描述将在编辑器中显示为帮助文本。
  5. 单击添加将参数添加到请求正文中。

    新参数在参数表中显示。

重复这些步骤以向请求正文添加更多参数。