124 lines
5.3 KiB
Markdown
124 lines
5.3 KiB
Markdown
# DataiIntegrationObjectController 接口索引
|
||
|
||
## 接口概述
|
||
|
||
DataiIntegrationObjectController 提供了对象同步控制相关的 REST API 接口，包括对象的增删改查、同步、统计、依赖关系查询等功能。
|
||
|
||
## 接口列表
|
||
|
||
### 对象管理
|
||
|
||
- [导出对象列表](0001-export-object-list.md) - 导出对象同步控制列表
|
||
- [获取对象同步统计信息](0002-object-sync-statistics.md) - 获取指定对象的同步统计信息
|
||
- [获取对象依赖关系](0003-object-dependencies.md) - 获取指定对象的依赖关系
|
||
- [创建对象表结构](0004-create-object-structure.md) - 创建指定对象的本地表结构
|
||
- [变更对象启用同步状态](0005-update-work-status.md) - 变更指定对象的启用同步状态
|
||
- [变更对象增量更新状态](0006-update-incremental-status.md) - 变更指定对象的增量更新状态
|
||
- [变更对象实时同步状态](0007-update-realtime-sync-status.md) - 变更指定对象的实时同步状态
|
||
- [获取对象整体统计信息](0007-object-overall-statistics.md) - 获取所有对象的整体统计信息
|
||
|
||
### 数据同步
|
||
|
||
- [同步单对象数据到本地数据库](0008-sync-single-object-data.md) - 触发指定对象的单次数据同步操作
|
||
- [同步多个对象数据到本地数据库](0009-sync-multiple-object-data.md) - 触发多个对象的批量数据同步操作
|
||
- [对象数据插入目标系统](0010-insert-object-data-to-target.md) - 将本地数据库中的指定对象数据插入到目标Salesforce系统
|
||
- [对象数据更新目标系统](0011-update-object-data-to-target.md) - 将本地数据库中的指定对象数据更新到目标Salesforce系统
|
||
- [多个对象数据插入目标系统](0016-insert-multiple-object-data-to-target.md) - 将本地数据库中的多个对象数据批量插入到目标Salesforce系统
|
||
- [多个对象数据更新目标系统](0017-update-multiple-object-data-to-target.md) - 将本地数据库中的多个对象数据批量更新到目标Salesforce系统
|
||
|
||
### 进度查询
|
||
|
||
- [查询指定对象的同步进度](0010-query-progress.md) - 查询指定对象的同步进度信息
|
||
- [查询所有正在同步的对象进度](0011-query-all-progress.md) - 查询所有正在同步的对象进度列表
|
||
- [查询指定对象的插入进度](0012-query-insert-progress.md) - 查询指定对象的插入进度信息
|
||
- [查询所有正在插入的对象进度](0013-query-all-insert-progress.md) - 查询所有正在插入的对象进度列表
|
||
- [查询指定对象的更新进度](0014-query-update-progress.md) - 查询指定对象的更新进度信息
|
||
- [查询所有正在更新的对象进度](0015-query-all-update-progress.md) - 查询所有正在更新的对象进度列表
|
||
|
||
## 接口分类
|
||
|
||
### 按功能分类
|
||
|
||
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）：
|
||
|
||
```json
|
||
{
|
||
"code": 200,
|
||
"msg": "操作成功",
|
||
"data": {}
|
||
}
|
||
```
|
||
|
||
- **code**: 响应状态码，200表示成功，其他表示失败
|
||
- **msg**: 响应消息，成功时返回"操作成功"，失败时返回错误信息
|
||
- **data**: 响应数据，具体内容根据接口而定
|
||
|
||
### 错误处理
|
||
|
||
所有接口都会捕获异常并返回统一的错误格式：
|
||
|
||
```json
|
||
{
|
||
"code": 500,
|
||
"msg": "错误信息",
|
||
"data": null
|
||
}
|
||
```
|
||
|
||
### 分页支持
|
||
|
||
部分接口支持分页查询，使用以下参数：
|
||
|
||
- **pageNum**: 页码，从 1 开始
|
||
- **pageSize**: 每页记录数
|
||
|
||
### 导出支持
|
||
|
||
部分接口支持数据导出，使用以下参数：
|
||
|
||
- **response**: HttpServletResponse 对象
|
||
- **查询参数**: 根据接口而定
|
||
|
||
## 注意事项
|
||
|
||
1. 所有接口都需要登录认证，未登录用户无法访问
|
||
2. 部分接口需要特定的权限，请确保用户具有相应权限
|
||
3. 同步操作可能需要较长时间，建议使用异步方式调用
|
||
4. 进度查询接口仅在同步进行中有效，同步完成后进度信息会被清除
|
||
5. 建议在测试环境中先验证接口功能后再部署到生产环境
|