kris/datai-vue
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
develop
datai-vue/doc/salesforce/integration/DataiIntegrationObjectController/0006-update-incremental-status.md
Kris 1177dbde35 feat: 添加元数据变更中心和实时同步统计页面 
- 新增元数据变更中心页面 (metadatachange/index.vue)
  - 集成统计卡片显示变更数据
  - 支持按变更类型、操作类型、同步状态分组统计
  - 支持趋势统计图表展示
  - 优化查询条件布局，移至页面顶部

- 新增实时同步统计页面 (statistics/realtime/index.vue)
  - 显示实时同步服务状态和控制按钮
  - 统计启用实时同步的对象数量
  - 自动刷新统计数据（30秒间隔）

- 优化数据同步页面 (datasync/index.vue)
  - 修正字段映射以匹配API响应
  - 更新统计卡片显示实际数据

- 优化同步日志统计页面 (statistics/synclog/index.vue)
  - 更新表格列以匹配API响应结构
  - 更新查询参数和映射函数

- 更新导航栏菜单 (Navbar/index.vue)
  - 添加元数据变更中心菜单项

- 新增API接口 (realtimeservice.js)
  - 添加getStatistics函数获取实时同步统计数据

- 新增接口文档
  - DataiIntegrationRealtimeSyncController 接口文档
  - DataiIntegrationRealtimeSyncLogController 接口文档
2026-01-13 13:50:07 +08:00

3.5 KiB
Raw Permalink Blame History

接口文档

接口信息

  • 接口名称: 变更对象增量更新状态
  • 接口路径: /integration/object/{id}/incrementalStatus
  • 请求方法: PUT
  • 模块归属: 对象同步控制
  • 版本号: v1.0
  • 创建日期: 2026-01-09
  • 最后更新: 2026-01-09

功能描述

变更指定对象的增量更新状态，用于控制对象是否采用增量更新模式进行数据同步。

请求参数

路径参数

参数名 类型 必填 描述 示例
id Integer 是 对象ID 1

查询参数

参数名 类型 必填 描述 示例 默认值
isIncremental Boolean 是 是否启用增量更新 true 无

请求体

无

响应数据

成功响应

HTTP 状态码: 200 OK

{
  "code": 200,
  "message": "操作成功",
  "data": {
    "success": true,
    "message": "增量更新状态更新成功",
    "objectId": 1,
    "isIncremental": true
  }
}
字段名 类型 描述 示例
success Boolean 操作结果 true
message String 操作消息 增量更新状态更新成功
objectId Integer 对象ID 1
isIncremental Boolean 增量更新状态 true

失败响应

HTTP 状态码: 400 Bad Request

{
  "code": 400,
  "message": "增量更新状态更新失败: 对象不存在",
  "data": null
}

接口示例

请求示例

curl -X PUT "http://localhost:8080/integration/object/1/incrementalStatus?isIncremental=true" \
  -H "Authorization: Bearer [token]"

响应示例

成功:

{
  "code": 200,
  "message": "操作成功",
  "data": {
    "success": true,
    "message": "增量更新状态更新成功",
    "objectId": 1,
    "isIncremental": true
  }
}

失败:

{
  "code": 400,
  "message": "增量更新状态更新失败: 对象不存在",
  "data": null
}

错误处理

  • 对象不存在时，返回400错误
  • 参数错误时，返回400错误
  • 权限不足时，返回403错误
  • 服务器内部错误时，返回500错误

注意事项

  • 该接口需要对象同步控制的修改权限
  • 启用增量更新后，对象会采用增量方式同步数据，只同步变更的数据
  • 禁用增量更新后，对象会采用全量方式同步数据，每次同步所有数据
  • 增量更新需要依赖 Salesforce 的变更数据捕获机制

相关接口

实现细节

  • 验证对象是否存在
  • 更新对象的增量更新状态
  • 处理更新过程中的异常情况
  • 返回更新结果

测试信息

测试环境

  • 环境: 开发环境
  • 版本: v1.0

测试用例

测试场景 输入参数 预期结果 实际结果 状态
启用增量更新 id=1&isIncremental=true 返回更新成功 返回更新成功 通过
禁用增量更新 id=1&isIncremental=false 返回更新成功 返回更新成功 通过
更新不存在对象 id=999&isIncremental=true 返回对象不存在错误 返回对象不存在错误 通过
缺少isIncremental参数 id=1 返回参数错误 返回参数错误 通过