要通过服务发布的 REST API 接口与 Planful® 环境（前身为 Host Analytics®）进行通信（作为链的一部分），请添加一个带有 Planful 连接命令的步骤。
要启用这些命令，IT 管理员首先要 创建 Planful 连接器。
清除数据
要根据规则代码清除暂存表数据，请使用 Clear Data 命令。
等效 API 调用： https://help.planful.com/v1/docs/clear-data-1
属性
| 摘要信息 | 详细信息 |
|---|---|
| 规则 | 输入要加载数据的规则名称或代码。 |
输出
没有任何
退出代码
| 代码 | 类型 | 详细信息 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 出现错误 |
获取报告列表
要检索可用报告列表，请使用 Get Reports List 命令。
等效 API 调用： 不适用
属性
| 摘要信息 | 详细信息 |
|---|---|
| 搜索文件夹 | 输入要检索报告的文件夹。 |
| 报告类型 | 输入要筛选的报告类型。 |
输出
| 输出 | 输出类型 |
|---|---|
| 报表 | JSON |
退出代码
| 代码 | 类型 | 详细信息 |
|---|---|---|
| 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
属性
| 摘要信息 | 详细信息 |
|---|---|
| 规则 | 输入要加载数据的规则名称或代码。 |
| 数据 | 输入包含要加载到 Rule的数据的文件。每一行都应是一个单独的条目。 |
| 分隔符号 | 选择每行中使用的分隔符，将 数据 分隔成列。 |
输出
| 输出 | 输出类型 |
|---|---|
| 记录计数 | 整数 |
退出代码
| 代码 | 类型 | 详细信息 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 出现错误 |
读取 GL 数据
要根据筛选条件检索 GLData 对象集合，请使用 Retrieve GL Data 命令。返回的每个对象对应数据库中的一行 GL 数据。
等效 API 调用： https://help.planful.com/v1/docs/gldata-retrieve-api
属性
| 摘要信息 | 详细信息 |
|---|---|
| 筛选条件 | 输入测试筛选器。 |
输出
| 输出 | 输出类型 |
|---|---|
| GLData (CSV) | 文件 |
| 记录计数 | 整数 |
退出代码
| 代码 | 类型 | 详细信息 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 出现错误 |
读取分段 1 数据
要根据筛选条件检索 Segment1 对象集合，请使用 Retrieve Segment1 Data 命令。返回的每个对象对应数据库中 segment1 的一个数据行。
等效 API 调用： https://help.planful.com/v1/docs/segment1-retrieve
属性
| 摘要信息 | 详细信息 |
|---|---|
| 筛选条件 | 输入测试筛选器。 |
输出
| 输出 | 输出类型 |
|---|---|
| 分段 1 数据（CSV） | 文件 |
| 记录计数 | 整数 |
退出代码
| 代码 | 类型 | 详细信息 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 出现错误 |
检索分段 2 数据
要根据筛选条件检索 Segment2 对象集合，请使用 Retrieve Segment2 Data 命令。返回的每个对象对应数据库中 segment2 的一个数据行。
等效 API 调用： https://help.planful.com/v1/docs/segment2-retrieve
属性
| 摘要信息 | 详细信息 |
|---|---|
| 筛选条件 | 输入测试筛选器。 |
输出
| 输出 | 输出类型 |
|---|---|
| 分段 2 数据（CSV） | 文件 |
| 记录计数 | 整数 |
退出代码
| 代码 | 类型 | 详细信息 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 出现错误 |
检索分段 3 数据
要根据筛选条件检索 Segment3 对象集合，请使用 Retrieve Segment3 Data 命令。返回的每个对象对应数据库中 segment3 的一个数据行。
等效 API 调用： https://help.planful.com/v1/docs/segment3-retrieve
属性
| 摘要信息 | 详细信息 |
|---|---|
| 筛选条件 | 输入测试筛选器。 |
输出
| 输出 | 输出类型 |
|---|---|
| 分段 3 数据（CSV） | 文件 |
| 记录计数 | 整数 |
退出代码
| 代码 | 类型 | 详细信息 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 出现错误 |
检索分段 4 数据
要根据筛选条件检索 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 | 错误 | 出现错误 |
检索分段 6 数据
要根据筛选条件检索 Segment6 对象集合，请使用 Retrieve Segment6 Data 命令。返回的每个对象对应数据库中 segment6 的一个数据行。
等效 API 调用： https://help.planful.com/v1/docs/segment6-retrieve
属性
| 摘要信息 | 详细信息 |
|---|---|
| 筛选条件 | 输入测试筛选器。 |
输出
| 输出 | 输出类型 |
|---|---|
| 分段 6 数据（CSV） | 文件 |
| 记录计数 | 整数 |
退出代码
| 代码 | 类型 | 详细信息 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 出现错误 |
检索 Segment7 数据
要根据筛选条件检索 Segment7 对象集合，请使用 Retrieve Segment7 Data 命令。返回的每个对象对应数据库中 segment7 的一个数据行。
等效 API 调用： https://help.planful.com/v1/docs/segment7-retrieve
属性
| 摘要信息 | 详细信息 |
|---|---|
| 筛选条件 | 输入测试筛选器。 |
输出
| 输出 | 输出类型 |
|---|---|
| 分段 7 数据（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 | 错误 | 出现错误 |