datai/datai-scenes/datai-scene-salesforce/docs/api-docs/partner-api/index.md

Partner API 接口文档索引

概述

本文档是 datai-salesforce-partner 模块所有 API 接口文档的唯一真源索引，记录了所有已创建的接口文档及其元数据。

文档元数据

属性	值
文档名称	Partner API 接口文档索引
文档编号	PARTNER-API-INDEX-001
创建日期	2026-02-02
最后更新	2026-02-02
状态	已完成
维护者	AI Assistant

文档统计

Controller	文档数量	接口数量
PartnerAdvancedController	5	5
PartnerBatchController	4	4
PartnerConnectionController	3	3
PartnerCrudController	6	6
PartnerDescribeController	6	6
PartnerQueryController	4	4
总计	28	28

---

1. PartnerAdvancedController - 高级功能接口

接口列表

序号	文档名称	接口路径	接口名称	状态
1	001-convert-lead.md	/partner/convertLead	转换潜在客户	✅ 已完成
2	002-empty-recycle-bin.md	/partner/emptyRecycleBin	清空回收站	✅ 已完成
3	003-process-submit-request.md	/partner/processSubmitRequest	提交流程请求	✅ 已完成
4	004-get-user-info.md	/partner/getUserInfo	获取用户信息	✅ 已完成
5	005-get-server-timestamp.md	/partner/getServerTimestamp	获取服务器时间戳	✅ 已完成

功能说明

提供 Salesforce 高级功能接口，包括潜在客户转换、回收站管理、流程请求处理、用户信息获取等。

---

2. PartnerBatchController - 批量操作接口

接口列表

序号	文档名称	接口路径	接口名称	状态
1	001-batch-create.md	/partner/batchCreate	批量创建记录	✅ 已完成
2	002-batch-update.md	/partner/batchUpdate	批量更新记录	✅ 已完成
3	003-batch-delete.md	/partner/batchDelete	批量删除记录	✅ 已完成
4	004-batch-upsert.md	/partner/batchUpsert	批量 Upsert 记录	✅ 已完成

功能说明

提供批量操作接口，支持批量创建、更新、删除和 Upsert 记录，提高数据操作效率。

---

3. PartnerConnectionController - 连接管理接口

接口列表

序号	文档名称	接口路径	接口名称	状态
1	001-get-session-info.md	/partner/getSessionInfo	获取会话信息	✅ 已完成
2	002-get-user-info.md	/partner/getUserInfo	获取用户信息	✅ 已完成
3	003-change-password.md	/partner/changePassword	修改密码	✅ 已完成

功能说明

提供连接管理接口，包括会话信息获取、用户信息获取和密码修改等。

---

4. PartnerCrudController - CRUD 操作接口

接口列表

序号	文档名称	接口路径	接口名称	状态
1	001-create-record.md	/partner/createRecord	创建记录	✅ 已完成
2	002-retrieve-record.md	/partner/retrieveRecord	检索记录	✅ 已完成
3	003-update-record.md	/partner/updateRecord	更新记录	✅ 已完成
4	004-delete-record.md	/partner/deleteRecord	删除记录	✅ 已完成
5	005-upsert-record.md	/partner/upsertRecord	Upsert 记录	✅ 已完成
6	006-merge-records.md	/partner/mergeRecords	合并记录	✅ 已完成

功能说明

提供完整的 CRUD 操作接口，支持记录的创建、检索、更新、删除、Upsert 和合并操作。

---

5. PartnerDescribeController - 对象描述接口

接口列表

序号	文档名称	接口路径	接口名称	状态
1	001-describe-global.md	/partner/describeGlobal	描述所有可用对象	✅ 已完成
2	002-describe-sobject.md	/partner/describeSObject	描述特定对象	✅ 已完成
3	003-describe-sobjects.md	/partner/describeSObjects	描述多个对象	✅ 已完成
4	004-describe-layout.md	/partner/describeLayout	描述对象布局	✅ 已完成
5	005-describe-tabs.md	/partner/describeTabs	描述标签页	✅ 已完成
6	006-describe-quick-actions.md	/partner/describeQuickActions	描述快速操作	✅ 已完成

功能说明

提供对象描述接口，用于获取 Salesforce 对象的元数据信息，包括对象结构、字段定义、布局信息等。

---

6. PartnerQueryController - 查询接口

接口列表

序号	文档名称	接口路径	接口名称	状态
1	001-query.md	/partner/query	执行 SOQL 查询	✅ 已完成
2	002-query-all.md	/partner/queryAll	查询所有记录（包括已删除的）	✅ 已完成
3	003-query-more.md	/partner/queryMore	获取查询结果的下一页	✅ 已完成
4	004-search.md	/partner/search	执行 SOSL 搜索	✅ 已完成

功能说明

提供查询接口，支持 SOQL 查询、QueryAll 查询（包括已删除记录）、分页查询和 SOSL 全文搜索。

---

文档变更日志

版本	日期	变更内容	作者
1.0.0	2026-02-02	初始版本，创建所有 28 个接口文档的索引	AI Assistant

---

交叉引用

相关文档

• datai-scene-salesforce 模块文档
• Partner API 总览

外部链接

• Salesforce Partner API 官方文档

---

维护说明

文档更新规则

1. 新增接口：当添加新的接口时，必须：

   • 创建对应的接口文档
   • 更新本文档索引
   • 更新文档统计信息
   • 添加变更日志记录

2. 修改接口：当修改现有接口时，必须：

   • 更新对应的接口文档
   • 更新接口文档的版本号和变更日志
   • 在本文档中记录变更

3. 删除接口：当删除接口时，必须：

   • 标记对应的接口文档为已废弃
   • 更新本文档索引状态
   • 添加变更日志记录

文档命名规范

• Controller 文档夹：{ControllerName}
• 接口文档：{序号}-{接口名称}.md
• 序号格式：3 位数字，从 001 开始递增

文档模板

所有接口文档应遵循统一的模板格式，包含以下章节：

• 接口概述
• 基本信息
• 请求参数
• 响应参数
• 错误码
• 使用说明
• 相关接口
• 更新日志

---

附录

A. 接口分类统计

分类	接口数量	占比
高级功能	5	17.86%
批量操作	4	14.29%
连接管理	3	10.71%
CRUD 操作	6	21.43%
对象描述	6	21.43%
查询功能	4	14.29%
总计	28	100%

B. 请求方法统计

方法	接口数量	占比
POST	28	100%
GET	0	0%
PUT	0	0%
DELETE	0	0%

C. 文档完成状态

状态	文档数量	占比
✅ 已完成	28	100%
🚧 进行中	0	0%
❌ 未开始	0	0%

---

文档结束