若要透過服務發佈的 REST API 介面與 Planful®-formerly Host Analytics®-environment 進行通訊，以作為連鎖的一部分，請新增一個包含 Planful 連線指令的步驟。
若要啟用這些指令，IT 管理員首先建立 Planful 連結器 。
清除資料
若要根據規則代碼清除暫存資料表的資料，請使用Clear Data 指令。
等效 API 調用： https://help.planful.com/v1/docs/clear-data-1
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 規則 |
輸入要載入資料的規則名稱或代碼。 |
输出
無
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
發生錯誤 |
取得報告清單
要擷取可用報告清單，請使用Get Reports List 指令。
等效 API 調用： 不適用
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 搜尋資料夾 |
輸入要擷取報告的資料夾。 |
| 報表類型 |
輸入要篩選的報告類型。 |
输出
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
出現錯誤 |
取得版本
要檢索 Planful 實例的版本，請使用Get Version 指令。
等效 API 調用： https://help.planful.com/v1/docs/getversion-api
摘要資訊
無
输出
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
發生錯誤 |
載入資料
若要將資料載入 Planful 應用程式的暫存資料表，請使用Load Data 指令。
等效的 API 呼叫： https://help.planful.com/v1/docs/load-data-external-source-models
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 規則 |
輸入要載入資料的規則名稱或代碼。 |
| 資料 |
輸入要載入資料的檔案規則. 每行應為單獨的項目。 |
| 分隔符號 |
選擇每行中使用的分隔符，以將資料 分隔成列。 |
输出
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
發生錯誤 |
擷取 GL 資料
若要根據篩選條件擷取 GLData 物件集合，請使用Retrieve GL Data 指令。返回的每個物件對應資料庫中的一列 GL 資料。
等效 API 調用： https://help.planful.com/v1/docs/gldata-retrieve-api
摘要資訊
输出
| 輸出 |
輸出類型 |
| GLData (CSV) |
檔案 |
| 記錄數量 |
整數 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
發生錯誤 |
擷取 Segment1 資料
若要根據篩選條件擷取 Segment1 物件集合，請使用Retrieve Segment1 Data 指令。傳回的每個物件對應資料庫中 segment1 的資料列。
等效 API 調用： https://help.planful.com/v1/docs/segment1-retrieve
摘要資訊
输出
| 輸出 |
輸出類型 |
| Segment1 資料 (CSV) |
檔案 |
| 記錄數量 |
整數 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
出現錯誤 |
擷取 Segment2 資料
要根據篩選條件擷取 Segment2 物件集合，請使用Retrieve Segment2 Data 指令。傳回的每個物件對應資料庫中 segment2 的資料列。
等效 API 調用： https://help.planful.com/v1/docs/segment2-retrieve
摘要資訊
输出
| 輸出 |
輸出類型 |
| 段落 2 資料 (CSV) |
檔案 |
| 記錄數量 |
整數 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
發生錯誤 |
擷取 Segment3 資料
要根據篩選條件擷取 Segment3 物件集合，請使用Retrieve Segment3 Data 指令。傳回的每個物件對應資料庫中 segment3 的資料列。
等效 API 調用： https://help.planful.com/v1/docs/segment3-retrieve
摘要資訊
输出
| 輸出 |
輸出類型 |
| Segment3 資料 (CSV) |
檔案 |
| 記錄數量 |
整數 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
發生錯誤 |
擷取 Segment4 資料
要根據篩選條件擷取 Segment4 物件集合，請使用Retrieve Segment4 Data 指令。傳回的每個物件對應資料庫中 segment4 的資料列。
等效 API 調用： https://help.planful.com/v1/docs/segment4-retrieve
摘要資訊
输出
| 輸出 |
輸出類型 |
| Segment4 資料 (CSV) |
檔案 |
| 記錄數量 |
整數 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
發生錯誤 |
擷取 Segment5 資料
若要根據篩選條件擷取 Segment5 物件集合，請使用Retrieve Segment5 Data 指令。傳回的每個物件對應資料庫中 segment5 的資料列。
等效 API 調用： https://help.planful.com/v1/docs/segment5-retrieve
摘要資訊
输出
| 輸出 |
輸出類型 |
| Segment5 資料 (CSV) |
檔案 |
| 記錄數量 |
整數 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
發生錯誤 |
擷取 Segment6 資料
若要根據篩選條件擷取 Segment6 物件集合，請使用Retrieve Segment6 Data 指令。傳回的每個物件對應資料庫中 segment6 的資料列。
等效 API 調用： https://help.planful.com/v1/docs/segment6-retrieve
摘要資訊
输出
| 輸出 |
輸出類型 |
| Segment6 資料 (CSV) |
檔案 |
| 記錄數量 |
整數 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
發生錯誤 |
擷取 Segment7 資料
要根據篩選條件擷取 Segment7 物件集合，請使用Retrieve Segment7 Data 指令。傳回的每個物件對應資料庫中 segment7 的資料列。
等效 API 調用： https://help.planful.com/v1/docs/segment7-retrieve
摘要資訊
输出
| 輸出 |
輸出類型 |
| Segment7 資料 (CSV) |
檔案 |
| 記錄數量 |
整數 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
發生錯誤 |
擷取 Segment8 資料
要根據篩選條件擷取 Segment8 物件集合，請使用Retrieve Segment8 Data 指令。傳回的每個物件對應資料庫中 segment8 的資料列。
等效 API 調用： https://help.planful.com/v1/docs/segment8-retrieve
摘要資訊
输出
| 輸出 |
輸出類型 |
| Segment8 資料 (CSV) |
檔案 |
| 記錄數量 |
整數 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
出現錯誤 |
執行報告
若要執行報告並以 JSON 格式傳回其結果，請使用Run Report 指令。
等效 API 調用： 不適用
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 報告代碼 |
輸入要執行的報告名稱或代碼。 |
| 譜系 |
輸入報告在 Planful 中的位置。在路徑中使用// 作為分隔符。 |
| 立方體名稱 |
輸入與報表相關聯的立方體名稱。 |
| 篩選條件 |
輸入要套用至報表的篩選條件。 |
| 套用篩選條件 |
選擇是否套用篩選條件。 |
输出
| 輸出 |
輸出類型 |
| 報告 |
JSON |
| 報告 (CSV) |
檔案 |
| 記錄數量 |
整數 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
發生錯誤 |
傳輸資料
若要根據規則代碼將暫存資料傳輸至 Planful 中的目標資料表，請使用Transfer Data 指令。
等效 API 調用： https://help.planful.com/v1/docs/new-transfer-data-rest-api
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 規則 |
輸入要載入資料的規則名稱（代碼 |
输出
無
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
有錯誤 |