datai/datai-scenes/datai-scene-salesforce/docs/api-docs/integration/DataiIntegrationObjectController/0005-update-work-status.md

接口文档

接口信息

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

功能描述

变更指定对象的启用同步状态，用于控制对象是否参与数据同步。

请求参数

路径参数

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

查询参数

参数名	类型	必填	描述	示例	默认值
isWork	Boolean	是	是否启用同步	true	无

请求体

无

响应数据

成功响应

HTTP 状态码: 200 OK

{
  "code": 200,
  "message": "操作成功",
  "data": {
    "success": true,
    "message": "同步状态更新成功",
    "objectId": 1,
    "isWork": true
  }
}

字段名	类型	描述	示例
success	Boolean	操作结果	true
message	String	操作消息	同步状态更新成功
objectId	Integer	对象ID	1
isWork	Boolean	同步状态	true

失败响应

HTTP 状态码: 400 Bad Request

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

接口示例

请求示例

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

响应示例

成功:

{
  "code": 200,
  "message": "操作成功",
  "data": {
    "success": true,
    "message": "同步状态更新成功",
    "objectId": 1,
    "isWork": true
  }
}

失败:

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

错误处理

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

注意事项

• 该接口需要对象同步控制的修改权限
• 启用同步状态后，对象会参与后续的数据同步操作
• 禁用同步状态后，对象不会参与后续的数据同步操作

相关接口

• 变更对象增量更新状态 - 变更对象增量更新状态
• 同步单对象数据 - 同步单对象数据到本地数据库

实现细节

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

测试信息

测试环境

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

测试用例

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