自訂表單中的外部查詢欄位範例

Last update: Wed Oct 23 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

建立對象：

自訂表單中的外部查詢欄位會呼叫外部API，並在下拉欄位中傳回值作為選項。使用自訂表單附加至之物件的使用者可以從下拉式清單中選取一個或多個選項。

本文提供使用外部查詢欄位來呼叫Workfront或公用API的相同例項的範例。您也可以使用外部查詢與外部系統(例如Jira、Salesforce或ServiceNow)通訊。

如需將外部查詢欄位新增至自訂表單的詳細資訊，以及外部查詢元件的其他定義，請參閱建立自訂表單。

為相同的Workfront執行個體設定外部查詢欄位

您可以使用外部查詢功能，將Workfront例項的資料匯入自訂表單中。

此範例說明如何呼叫Workfront API，並將現有「狀態查詢」欄位的資料匯入外部查詢欄位。

開啟自訂表單。
在熒幕左側，尋找 外部查詢 並將其拖曳至畫布上的區段。
輸入欄位的標籤和名稱。
選取欄位的格式。
在 基本API URL 欄位中輸入API呼叫。
- 若要參照自訂表單所在的相同Workfront例項，請在URL使用$$HOST。
- 若要根據查詢其他欄位來篩選結果，請新增$$QUERY。
範例
$$HOST/attask/api/v15.0/project/search?status={DE:StatusQuery}&$$QUERY
檢閱此查詢欄位在API中參考的欄位的 相依性。

相依性欄位可以是物件詳細資訊頁面中的任何自訂或原生欄位。

在此範例中，{DE:StatusQuery}將由StatusQuery自訂欄位的值取代。
選取 HTTP方法。

這很可能是 Get。

輸入 JSON路徑 以取得API呼叫的結果。

範例
$.data[*].name

note note
NOTE
標題資訊不是呼叫相同Workfront執行個體的必要專案。

此範例顯示如何呼叫Workfront API，並將自訂欄位的資料匯入外部查詢欄位。範例自訂欄位稱為「自訂顏色」。

開啟自訂表單。
在熒幕左側，尋找 外部查詢 並將其拖曳至畫布上的區段。
輸入欄位的標籤和名稱。
選取欄位的格式。
在 基本API URL 欄位中輸入API URL呼叫。

範例
$$HOST/attask/api/v18.0/PORT/search?ID={portfolioID}&fields=parameterValues
檢閱此查詢欄位在API中參考的欄位的 相依性。

相依性欄位可以是物件詳細資訊頁面中的任何自訂或原生欄位。
選取 HTTP方法。

這很可能是 Get。

輸入 JSON路徑 以取得API呼叫的結果。

範例
$.data[*].parameterValues.["DE:Combo Colors"]

note note
NOTE
標題資訊不是呼叫相同Workfront執行個體的必要專案。

Workfront Planning API中的端點可透過Get方法，依記錄型別ID搜尋記錄。您可以使用此端點來參考外部查閱欄位中的Planning記錄。

基礎API URL： $$HOST/maestro/api/v1/records/search?recordTypeId={recordTypeID}
HTTP方法： Get
JSON路徑： $.records[*].data.{fieldID}

{fieldID} 是要在使用者自訂表單的外部查詢搜尋結果中顯示的欄位。

如需詳細資訊，請參閱Workfront Planning 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
標題欄位不是儲存認證的安全位置，您應該注意輸入和儲存的內容。

建立外部查詢有許多其他使用案例。

使用案例： 取代自動提示欄位，因為這些欄位可能會導致報表發生問題。
解決方案： 使用系統現有物件的API呼叫。

範本的基礎API URL範例，取代預先輸入欄位：
$$HOST/attask/api/v17.0/tmpl/search?isActive=true&name_Sort=asc

使用案例： 建立包含更多功能的下拉式欄位（例如，外部eookup欄位中有換行字元）。
解決方案： 使用系統中現有物件的API呼叫，或建立新物件並使用這個物件的API呼叫。

使用案例： 定義使用者在自訂表格區域外維護其欄位的方法。設定「外部查詢」欄位，您可以將使用者指定給組成該欄位的物件。此選項適合用於高維護欄位和團隊。
解決方案： 建立新物件並使用這個物件的API呼叫。

使用案例： 與Workfront外部的物件整合。例如，存取另一個系統以取得每個使用者的名稱，而不是被限制在預先輸入欄位中。
解決方案： Webhook/Fusion Automation連線到其他系統。

recommendation-more-help

5f00cc6b-2202-40d6-bcd0-3ee0c2316b43