datai/datai-scenes/datai-scene-salesforce/docs/api-docs/integration/DataiIntegrationObjectController/index.md
Kris 21c82a4b36 feat: 添加定时任务功能和文档
- 新增 4 个定时任务类:
  - ObjectSyncTask: 对象自动同步任务
  - ObjectInsertTask: 对象自动插入任务
  - ObjectUpdateTask: 对象自动更新任务
  - MetadataChangeAutoSyncTask: 元数据变更自动同步任务

- 新增 2 个多对象操作接口:
  - insertMultipleObjectDataToTarget: 批量插入对象数据到目标系统
  - updateMultipleObjectDataToTarget: 批量更新对象数据到目标系统

- 新增完整的定时任务文档:
  - task/index.md: 定时任务文档索引
  - ObjectSyncTask.md: 对象自动同步任务文档
  - ObjectInsertTask.md: 对象自动插入任务文档
  - ObjectUpdateTask.md: 对象自动更新任务文档
  - MetadataChangeAutoSyncTask.md: 元数据变更自动同步任务文档
  - RateLimitResetTask.md: 每日限流重置任务文档

- 新增 API 文档索引:api-docs/index.md

- 更新唯一真源文档中心:docs/index.md

- 新增完整的项目文档:
  - REQ-005.md: 定时任务自动同步、插入和更新对象数据需求
  - REQ-006.md: 元数据变更自动同步本地数据库需求
  - 0005-scheduled-tasks-implementation.md: 定时任务架构决策
  - 0006-metadata-change-auto-sync.md: 元数据变更自动同步架构决策
  - 005-scheduled-tasks-implementation.md: 定时任务实现提示词
  - 006-metadata-change-auto-sync.md: 元数据变更自动同步实现提示词
  - 20260116-scheduled-tasks-implementation.md: 定时任务实现会话记录
  - 20260116-metadata-change-auto-sync.md: 元数据变更自动同步实现会话记录
  - 20260116-scheduled-tasks-implementation-retro.md: 定时任务实现复盘
  - 20260116-metadata-change-auto-sync-retro.md: 元数据变更自动同步实现复盘
  - 0015-scheduled-tasks-implementation.md: 定时任务变更记录
  - 0016-metadata-change-auto-sync.md: 元数据变更自动同步变更记录

- 更新 CHANGELOG.md 和 README.md
2026-01-16 16:38:35 +08:00

5.3 KiB
Raw Blame History

DataiIntegrationObjectController 接口索引

接口概述

DataiIntegrationObjectController 提供了对象同步控制相关的 REST API 接口,包括对象的增删改查、同步、统计、依赖关系查询等功能。

接口列表

对象管理

数据同步

进度查询

接口分类

按功能分类

  1. 对象管理: 对象的增删改查、状态变更、统计信息等
  2. 数据同步: 对象数据从 Salesforce 同步到本地数据库、从本地数据库同步到目标 Salesforce 系统
  3. 进度查询: 查询对象同步的实时进度信息

按权限分类

所有接口都需要登录认证,具体权限标识如下:

  • integration:object:list - 查询对象列表
  • integration:object:query - 查询对象详情
  • integration:object:add - 新增对象
  • integration:object:edit - 修改对象
  • integration:object:remove - 删除对象
  • integration:object:export - 导出对象列表
  • integration:object:statistics - 查询对象统计信息
  • integration:object:dependencies - 查询对象依赖关系
  • integration:object:createStructure - 创建对象表结构
  • integration:object:updateWorkStatus - 变更对象启用同步状态
  • integration:object:updateIncrementalStatus - 变更对象增量更新状态
  • integration:object:updateRealtimeSyncStatus - 变更对象实时同步状态
  • integration:object:syncData - 同步对象数据
  • integration:object:insertData - 插入对象数据到目标系统
  • integration:object:updateData - 更新对象数据到目标系统
  • integration:object:progress - 查询对象同步进度

接口版本

  • 当前版本: v1.0
  • 最后更新: 2026-01-16
  • 更新内容: 新增进度查询接口

使用说明

通用响应格式

所有接口都使用统一的响应格式AjaxResult

{
  "code": 200,
  "msg": "操作成功",
  "data": {}
}
  • code: 响应状态码200表示成功其他表示失败
  • msg: 响应消息,成功时返回"操作成功",失败时返回错误信息
  • data: 响应数据,具体内容根据接口而定

错误处理

所有接口都会捕获异常并返回统一的错误格式:

{
  "code": 500,
  "msg": "错误信息",
  "data": null
}

分页支持

部分接口支持分页查询,使用以下参数:

  • pageNum: 页码,从 1 开始
  • pageSize: 每页记录数

导出支持

部分接口支持数据导出,使用以下参数:

  • response: HttpServletResponse 对象
  • 查询参数: 根据接口而定

注意事项

  1. 所有接口都需要登录认证,未登录用户无法访问
  2. 部分接口需要特定的权限,请确保用户具有相应权限
  3. 同步操作可能需要较长时间,建议使用异步方式调用
  4. 进度查询接口仅在同步进行中有效,同步完成后进度信息会被清除
  5. 建议在测试环境中先验证接口功能后再部署到生产环境