要通过该服务发布的 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
属性
| 摘要信息 | 细节 |
|---|---|
| 规则 | 输入要加载数据的规则名称或代码。 |
| 数据 | 输入包含要加载到 规则中的数据的文件。每行都应该单独列出。 |
| 分隔符号 | 选择每行中用于分隔 数据 的分隔符,将其分隔成列。 |
输出
| 输出 | 输出类型 |
|---|---|
| 记录计数 | 整数 |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 出现错误 |
获取GL数据
要根据筛选条件检索 GLData 对象集合,请使用 检索 GL 数据 命令。返回的每个对象都对应于数据库中的一行 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
属性
| 摘要信息 | 细节 |
|---|---|
| 筛选条件 | 输入测试过滤器。 |
输出
| 输出 | 输出类型 |
|---|---|
| 片段1数据(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
属性
| 摘要信息 | 细节 |
|---|---|
| 筛选条件 | 输入测试过滤器。 |
输出
| 输出 | 输出类型 |
|---|---|
| 第 3 段数据(CSV) | 文件 |
| 记录计数 | 整数 |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 出现错误 |
检索第 4 段数据
要根据筛选条件检索 Segment4 对象的集合,请使用 Retrieve Segment4 Data 命令。返回的每个对象都对应于数据库中 segment4 的一行数据。
等效 API 调用: https://help.planful.com/v1/docs/segment4-retrieve
属性
| 摘要信息 | 细节 |
|---|---|
| 筛选条件 | 输入测试过滤器。 |
输出
| 输出 | 输出类型 |
|---|---|
| 第 4 段数据(CSV) | 文件 |
| 记录计数 | 整数 |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 出现错误 |
检索 Segment5 数据
要根据筛选条件检索 Segment5 对象的集合,请使用 Retrieve Segment5 Data 命令。返回的每个对象都对应于数据库中 segment5 的一个数据行。
等效 API 调用: https://help.planful.com/v1/docs/segment5-retrieve
属性
| 摘要信息 | 细节 |
|---|---|
| 筛选条件 | 输入测试过滤器。 |
输出
| 输出 | 输出类型 |
|---|---|
| 第5段数据(CSV) | 文件 |
| 记录计数 | 整数 |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 出现错误 |
检索第6段数据
要根据筛选条件检索 Segment6 对象的集合,请使用 Retrieve Segment6 Data 命令。返回的每个对象都对应于数据库中 segment6 的一行数据。
等效 API 调用: https://help.planful.com/v1/docs/segment6-retrieve
属性
| 摘要信息 | 细节 |
|---|---|
| 筛选条件 | 输入测试过滤器。 |
输出
| 输出 | 输出类型 |
|---|---|
| 第6段数据(CSV) | 文件 |
| 记录计数 | 整数 |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 出现错误 |
检索第 7 段数据
要根据筛选条件检索 Segment7 对象的集合,请使用 Retrieve Segment7 Data 命令。返回的每个对象都对应于数据库中第 7 段的一行数据。
等效 API 调用: https://help.planful.com/v1/docs/segment7-retrieve
属性
| 摘要信息 | 细节 |
|---|---|
| 筛选条件 | 输入测试过滤器。 |
输出
| 输出 | 输出类型 |
|---|---|
| 第 7 段数据(CSV) | 文件 |
| 记录计数 | 整数 |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 出现错误 |
检索第 8 段数据
要根据筛选条件检索 Segment8 对象的集合,请使用 Retrieve Segment8 Data 命令。返回的每个对象都对应于数据库中第 8 段的一行数据。
等效 API 调用: https://help.planful.com/v1/docs/segment8-retrieve
属性
| 摘要信息 | 细节 |
|---|---|
| 筛选条件 | 输入测试过滤器。 |
输出
| 输出 | 输出类型 |
|---|---|
| 第 8 段数据(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 | 错误 | 出现错误 |