自定义表单中的外部查找字段示例
自定义表单中的外部查找字段调用外部API，并在下拉字段中作为选项返回值。 使用自定义表单附加到的对象的用户可以从下拉菜单中选择一个或多个选项。
本文提供了使用外部查找字段调用Workfront或公共API的相同实例的示例。 您还可以使用外部查找与外部系统（如Jira、Salesforce或ServiceNow）通信。
外部查找字段仅在新的表单设计器中可用，在旧版表单生成器中不可用。 有关将外部查找字段添加到自定义表单以及外部查找组件的其他定义的详细信息，请参阅使用表单设计器设计表单。
为同一Workfront实例设置外部查找字段
您可以使用外部查找将Workfront实例中的数据纳入自定义表单。
此示例说明如何调用Workfront API，并将现有“状态查询”字段中的数据引入外部查找字段。
-
打开自定义表单。
-
在屏幕左侧，找到 外部查找 并将其拖动到画布上的某个部分。
-
输入字段的 标签 和 名称。
-
为字段选择 格式。
-
在 基本API URL 字段中输入API URL调用。
- 您可以添加$$HOST以引用同一实例。
- 可添加$$QUERY以根据查询其他字段来筛选结果。
示例
$$HOST/attask/api/v15.0/project/search?status={DE:StatusQuery}&$$QUERY -
查看 依赖项，了解此查找字段在API中引用的字段。
依赖项字段可以是对象详细信息页面中存在的任何自定义或本机字段。
在此示例中，
{DE:StatusQuery}将替换为StatusQuery自定义字段的值。 -
选择 HTTP方法。
这很可能是 Get。
-
输入 JSON路径 以获取API调用结果。
示例
$.data[*].namenote note NOTE 调用同一Workfront实例不需要 标头 信息。 -
单击 应用。
将自定义表单添加到Workfront对象（在本例中是项目）时，它类似于此。
为公共API设置外部查找字段
您可以使用外部查找来调用外部公共API并检索数据。
此示例说明如何调用国家/地区的API（如https://api.first.org/data/v1/countries），以便您不必在下拉选项中对所有国家/地区名称进行硬编码。
-
打开自定义表单。
-
在屏幕左侧，找到 外部查找 并将其拖动到画布上的某个部分。
-
输入字段的 标签 和 名称。
-
为字段选择 格式。
-
在 基本API URL 字段中输入API URL调用。
- 您可以添加$$QUERY来实施最终用户的查询筛选。
示例
列出所有国家/地区： https://api.first.org/data/v1/countries允许用户在下拉字段中搜索任何国家/地区： https://api.first.org/data/v1/countries?q=$$QUERY
允许用户搜索区域中的国家/地区： https://api.first.org/data/v1/countries?region={DE:Region}&q=$$QUERY
- 可用的区域在Workfront中的单独自定义字段中定义。
- 当用户在表单上选择区域时，外部查找字段仅显示该区域中的国家（API中定义了该区域的国家/地区）。 用户还可以在所选区域中搜索国家/地区。
-
查看 依赖项，了解此查找字段在API中引用的字段。
依赖项字段可以是对象详细信息页面中存在的任何自定义或本机字段。
在此示例中，
{DE:Region}将被替换为区域自定义字段的值。 -
选择 HTTP方法。
这很可能是 Get。
-
输入 JSON路径 以获取API调用结果。
此选项允许从API URL返回的JSON中提取数据。 它提供了一种方法，用于选择哪些值将从JSON内部显示在下拉选项中。
示例
$.data[*].country -
（可选）单击 添加标头，然后键入或粘贴使用API进行身份验证所需的密钥值对。
note note NOTE 标头字段不是存储凭据的安全位置，您应该小心输入和保存的内容。 -
（可选）选择 多选下拉列表 以允许用户在下拉列表中选择多个值。
-
单击 应用。
将自定义表单添加到Workfront对象（在本例中是项目）时，它类似于此。
根据地区
