# API 文档 - 高级功能 (004-07) ## 元数据 - **需求编号**: 004-07 - **需求名称**: 高级功能 - **创建时间**: 2026-02-06 - **创建人**: AI Assistant - **版本号**: v1.0.0 --- ## API 概述 本文档描述 Tooling API 高级功能模块的 REST API 接口,提供 12 个元数据类型的查询功能,包括聚合和计算、预测和预测、激活和应用三大类功能。 **Base URL**: `/salesforce/tooling/advanced-features` **权限要求**: 所有接口需要 `tooling:advanced:query` 权限 **Session 要求**: 需要有效的 Salesforce Session --- ## 接口列表 ### 1. 查询累积结果操作符 **功能描述**: 查询 Salesforce 累积结果操作符(AccumulateResultOperator)列表 **请求方式**: GET **请求路径**: `/salesforce/tooling/advanced-features/accumulate-result-operators` **请求参数**: 无 **响应参数**: | 参数名 | 类型 | 说明 | |--------|------|------| | code | Integer | 状态码(200 成功,其他失败) | | msg | String | 提示信息 | | data | Object | 响应数据 | | data.total | Integer | 总数 | | data.list | Array | 操作符列表 | | data.list[].name | String | 操作符名称 | | data.list[].description | String | 操作符描述 | **成功示例**: ```json { "code": 200, "msg": "查询累积结果操作符成功", "data": { "total": 5, "list": [ { "name": "SUM", "description": "求和操作符" }, { "name": "AVG", "description": "平均值操作符" }, { "name": "COUNT", "description": "计数操作符" }, { "name": "MIN", "description": "最小值操作符" }, { "name": "MAX", "description": "最大值操作符" } ] } } ``` **失败示例**: ```json { "code": 500, "msg": "Session 无效或已过期", "data": null } ``` --- ### 2. 查询累积结果条件输入类型 **功能描述**: 查询 Salesforce 累积结果条件输入类型(AccumulateResultCondInputType)列表 **请求方式**: GET **请求路径**: `/salesforce/tooling/advanced-features/accumulate-result-cond-input-types` **请求参数**: 无 **响应参数**: | 参数名 | 类型 | 说明 | |--------|------|------| | code | Integer | 状态码(200 成功,其他失败) | | msg | String | 提示信息 | | data | Object | 响应数据 | | data.total | Integer | 总数 | | data.list | Array | 输入类型列表 | | data.list[].name | String | 输入类型名称 | | data.list[].description | String | 输入类型描述 | **成功示例**: ```json { "code": 200, "msg": "查询累积结果条件输入类型成功", "data": { "total": 3, "list": [ { "name": "FIELD", "description": "字段输入" }, { "name": "VALUE", "description": "值输入" }, { "name": "EXPRESSION", "description": "表达式输入" } ] } } ``` --- ### 3. 查询聚合表达式结果列元数据 **功能描述**: 查询 Salesforce 聚合表达式结果列元数据(AggregateExpressionResultColumnMetadata)列表 **请求方式**: GET **请求路径**: `/salesforce/tooling/advanced-features/aggregate-expression-result-column-metadatas` **请求参数**: 无 **响应参数**: | 参数名 | 类型 | 说明 | |--------|------|------| | code | Integer | 状态码(200 成功,其他失败) | | msg | String | 提示信息 | | data | Object | 响应数据 | | data.total | Integer | 总数 | | data.list | Array | 列元数据列表 | | data.list[].name | String | 元数据名称 | | data.list[].description | String | 元数据描述 | **成功示例**: ```json { "code": 200, "msg": "查询聚合表达式结果列元数据成功", "data": { "total": 4, "list": [ { "name": "Alias", "description": "列别名" }, { "name": "Value", "description": "列值" }, { "name": "Type", "description": "列类型" }, { "name": "Format", "description": "列格式" } ] } } ``` --- ### 4. 查询聚合查询结果列元数据 **功能描述**: 查询 Salesforce 聚合查询结果列元数据(AggregateQueryResultColumnMetadata)列表 **请求方式**: GET **请求路径**: `/salesforce/tooling/advanced-features/aggregate-query-result-column-metadatas` **请求参数**: 无 **响应参数**: | 参数名 | 类型 | 说明 | |--------|------|------| | code | Integer | 状态码(200 成功,其他失败) | | msg | String | 提示信息 | | data | Object | 响应数据 | | data.total | Integer | 总数 | | data.list | Array | 列元数据列表 | | data.list[].name | String | 元数据名称 | | data.list[].description | String | 元数据描述 | **成功示例**: ```json { "code": 200, "msg": "查询聚合查询结果列元数据成功", "data": { "total": 3, "list": [ { "name": "ColumnName", "description": "列名" }, { "name": "DataType", "description": "数据类型" }, { "name": "AggregateFunction", "description": "聚合函数" } ] } } ``` --- ### 5. 查询高级账户预测显示组类型 **功能描述**: 查询 Salesforce 高级账户预测显示组类型(AdvAcctFrcstDisplayGroupType)列表 **请求方式**: GET **请求路径**: `/salesforce/tooling/advanced-features/adv-acct-frcst-display-group-types` **请求参数**: 无 **响应参数**: | 参数名 | 类型 | 说明 | |--------|------|------| | code | Integer | 状态码(200 成功,其他失败) | | msg | String | 提示信息 | | data | Object | 响应数据 | | data.total | Integer | 总数 | | data.list | Array | 显示组类型列表 | | data.list[].name | String | 显示组类型名称 | | data.list[].description | String | 显示组类型描述 | **成功示例**: ```json { "code": 200, "msg": "查询高级账户预测显示组类型成功", "data": { "total": 4, "list": [ { "name": "REVENUE", "description": "收入显示组" }, { "name": "EXPENSE", "description": "支出显示组" }, { "name": "PROFIT", "description": "利润显示组" }, { "name": "GROWTH", "description": "增长显示组" } ] } } ``` --- ### 6. 查询高级账户预测度量类型 **功能描述**: 查询 Salesforce 高级账户预测度量类型(AdvAcctFcstMeasureType)列表 **请求方式**: GET **请求路径**: `/salesforce/tooling/advanced-features/adv-acct-fcst-measure-types` **请求参数**: 无 **响应参数**: | 参数名 | 类型 | 说明 | |--------|------|------| | code | Integer | 状态码(200 成功,其他失败) | | msg | String | 提示信息 | | data | Object | 响应数据 | | data.total | Integer | 总数 | | data.list | Array | 度量类型列表 | | data.list[].name | String | 度量类型名称 | | data.list[].description | String | 度量类型描述 | **成功示例**: ```json { "code": 200, "msg": "查询高级账户预测度量类型成功", "data": { "total": 5, "list": [ { "name": "QUANTITY", "description": "数量度量" }, { "name": "AMOUNT", "description": "金额度量" }, { "name": "PERCENTAGE", "description": "百分比度量" }, { "name": "RATIO", "description": "比率度量" }, { "name": "COUNT", "description": "计数度量" } ] } } ``` --- ### 7. 查询高级账户预测公式类型 **功能描述**: 查询 Salesforce 高级账户预测公式类型(AdvAcctFcstFormulaType)列表 **请求方式**: GET **请求路径**: `/salesforce/tooling/advanced-features/adv-acct-fcst-formula-types` **请求参数**: 无 **响应参数**: | 参数名 | 类型 | 说明 | |--------|------|------| | code | Integer | 状态码(200 成功,其他失败) | | msg | String | 提示信息 | | data | Object | 响应数据 | | data.total | Integer | 总数 | | data.list | Array | 公式类型列表 | | data.list[].name | String | 公式类型名称 | | data.list[].description | String | 公式类型描述 | **成功示例**: ```json { "code": 200, "msg": "查询高级账户预测公式类型成功", "data": { "total": 4, "list": [ { "name": "LINEAR", "description": "线性公式" }, { "name": "EXPONENTIAL", "description": "指数公式" }, { "name": "LOGARITHMIC", "description": "对数公式" }, { "name": "POLYNOMIAL", "description": "多项式公式" } ] } } ``` --- ### 8. 查询高级账户预测计算方法 **功能描述**: 查询 Salesforce 高级账户预测计算方法(AdvAcctFcstComputationMethod)列表 **请求方式**: GET **请求路径**: `/salesforce/tooling/advanced-features/adv-acct-fcst-computation-methods` **请求参数**: 无 **响应参数**: | 参数名 | 类型 | 说明 | |--------|------|------| | code | Integer | 状态码(200 成功,其他失败) | | msg | String | 提示信息 | | data | Object | 响应数据 | | data.total | Integer | 总数 | | data.list | Array | 计算方法列表 | | data.list[].name | String | 计算方法名称 | | data.list[].description | String | 计算方法描述 | **成功示例**: ```json { "code": 200, "msg": "查询高级账户预测计算方法成功", "data": { "total": 3, "list": [ { "name": "AUTOMATIC", "description": "自动计算" }, { "name": "MANUAL", "description": "手动计算" }, { "name": "SCHEDULED", "description": "定时计算" } ] } } ``` --- ### 9. 查询激活 Flow 类型 **功能描述**: 查询 Salesforce 激活 Flow 类型(ActivationFlowType)列表 **请求方式**: GET **请求路径**: `/salesforce/tooling/advanced-features/activation-flow-types` **请求参数**: 无 **响应参数**: | 参数名 | 类型 | 说明 | |--------|------|------| | code | Integer | 状态码(200 成功,其他失败) | | msg | String | 提示信息 | | data | Object | 响应数据 | | data.total | Integer | 总数 | | data.list | Array | Flow 类型列表 | | data.list[].name | String | Flow 类型名称 | | data.list[].description | String | Flow 类型描述 | **成功示例**: ```json { "code": 200, "msg": "查询激活 Flow 类型成功", "data": { "total": 4, "list": [ { "name": "AUTOLAUNCHED", "description": "自动启动 Flow" }, { "name": "SCREEN", "description": "屏幕 Flow" }, { "name": "SCHEDULED", "description": "定时 Flow" }, { "name": "PLATFORM_EVENT", "description": "平台事件 Flow" } ] } } ``` --- ### 10. 查询激活功能类型 **功能描述**: 查询 Salesforce 激活功能类型(ActivationFeatureType)列表 **请求方式**: GET **请求路径**: `/salesforce/tooling/advanced-features/activation-feature-types` **请求参数**: 无 **响应参数**: | 参数名 | 类型 | 说明 | |--------|------|------| | code | Integer | 状态码(200 成功,其他失败) | | msg | String | 提示信息 | | data | Object | 响应数据 | | data.total | Integer | 总数 | | data.list | Array | 功能类型列表 | | data.list[].name | String | 功能类型名称 | | data.list[].description | String | 功能类型描述 | **成功示例**: ```json { "code": 200, "msg": "查询激活功能类型成功", "data": { "total": 5, "list": [ { "name": "ANALYTICS", "description": "分析功能" }, { "name": "AUTOMATION", "description": "自动化功能" }, { "name": "INTEGRATION", "description": "集成功能" }, { "name": "SECURITY", "description": "安全功能" }, { "name": "CUSTOMIZATION", "description": "自定义功能" } ] } } ``` --- ### 11. 查询激活应用类型 **功能描述**: 查询 Salesforce 激活应用类型(ActivationAppType)列表 **请求方式**: GET **请求路径**: `/salesforce/tooling/advanced-features/activation-app-types` **请求参数**: 无 **响应参数**: | 参数名 | 类型 | 说明 | |--------|------|------| | code | Integer | 状态码(200 成功,其他失败) | | msg | String | 提示信息 | | data | Object | 响应数据 | | data.total | Integer | 总数 | | data.list | Array | 应用类型列表 | | data.list[].name | String | 应用类型名称 | | data.list[].description | String | 应用类型描述 | **成功示例**: ```json { "code": 200, "msg": "查询激活应用类型成功", "data": { "total": 4, "list": [ { "name": "STANDARD", "description": "标准应用" }, { "name": "CUSTOM", "description": "自定义应用" }, { "name": "MANAGED", "description": "托管应用" }, { "name": "CONNECTED", "description": "连接应用" } ] } } ``` --- ### 12. 查询 ACP 状态 **功能描述**: 查询 Salesforce ACP 状态(ACPStatus)列表 **请求方式**: GET **请求路径**: `/salesforce/tooling/advanced-features/acp-statuses` **请求参数**: 无 **响应参数**: | 参数名 | 类型 | 说明 | |--------|------|------| | code | Integer | 状态码(200 成功,其他失败) | | msg | String | 提示信息 | | data | Object | 响应数据 | | data.total | Integer | 总数 | | data.list | Array | ACP 状态列表 | | data.list[].name | String | 状态名称 | | data.list[].description | String | 状态描述 | **成功示例**: ```json { "code": 200, "msg": "查询 ACP 状态成功", "data": { "total": 4, "list": [ { "name": "ACTIVE", "description": "已激活" }, { "name": "INACTIVE", "description": "未激活" }, { "name": "PENDING", "description": "待处理" }, { "name": "SUSPENDED", "description": "已暂停" } ] } } ``` --- ## 错误码 | 错误码 | 错误信息 | 说明 | |--------|----------|------| | TOOLING_ADVANCED_001 | Session 无效或已过期 | 用户未登录或 Session 已过期 | | TOOLING_ADVANCED_002 | 查询累积结果操作符失败 | 查询 AccumulateResultOperator 失败 | | TOOLING_ADVANCED_003 | 查询累积结果条件输入类型失败 | 查询 AccumulateResultCondInputType 失败 | | TOOLING_ADVANCED_004 | 查询聚合表达式结果列元数据失败 | 查询 AggregateExpressionResultColumnMetadata 失败 | | TOOLING_ADVANCED_005 | 查询聚合查询结果列元数据失败 | 查询 AggregateQueryResultColumnMetadata 失败 | | TOOLING_ADVANCED_006 | 查询高级账户预测显示组类型失败 | 查询 AdvAcctFrcstDisplayGroupType 失败 | | TOOLING_ADVANCED_007 | 查询高级账户预测度量类型失败 | 查询 AdvAcctFcstMeasureType 失败 | | TOOLING_ADVANCED_008 | 查询高级账户预测公式类型失败 | 查询 AdvAcctFcstFormulaType 失败 | | TOOLING_ADVANCED_009 | 查询高级账户预测计算方法失败 | 查询 AdvAcctFcstComputationMethod 失败 | | TOOLING_ADVANCED_010 | 查询激活 Flow 类型失败 | 查询 ActivationFlowType 失败 | | TOOLING_ADVANCED_011 | 查询激活功能类型失败 | 查询 ActivationFeatureType 失败 | | TOOLING_ADVANCED_012 | 查询激活应用类型失败 | 查询 ActivationAppType 失败 | | TOOLING_ADVANCED_013 | 查询 ACP 状态失败 | 查询 ACPStatus 失败 | | TOOLING_ADVANCED_014 | 权限不足 | 用户没有操作权限 | --- ## 注意事项 1. **权限要求**: 所有接口需要 `tooling:advanced:query` 权限 2. **Session 要求**: 需要有效的 Salesforce Session 3. **异步日志**: 日志记录采用异步方式,可能存在短暂延迟 4. **错误处理**: 所有错误都记录到操作日志表,便于问题排查 5. **性能考虑**: 元数据类型通常是固定的枚举值,暂不提供分页查询 6. **版本兼容性**: 部分元数据类型可能在某些 Salesforce 版本中不可用 --- ## 相关文档 - [需求文档](../requirements/sub/2026-01-28-004-07-高级功能.md) - [设计文档](../design/2026-02-03-004-07-高级功能-设计.md) - [决策记录](../decisions/2026-02-03-004-07-ADR-高级功能技术选型.md) - [SQL 脚本](../sql/2026-02-03-004-07-高级功能操作日志.sql) - [变更日志](../changelog/2026-02-06-004-07-changelog.md) - [复盘文档](../retros/2026-02-06-004-07-retro.md) - [会话记录](../sessions/2026-02-06-004-07-session.md)