删除组织历史记录接口

scope: org:history:delete

基本信息

项目	说明
接口路径	`POST /open/api/v1/org/deleteOrgHistory`
Content-Type	`application/json`
所需权限	`org:history:delete`
接口说明	删除指定组织的某一条历史记录（软删除）

请求参数

请求体（Request Body）

参数名	类型	是否必填	说明	示例
`corpId`	String	是	企业ID	`"ding4c7c311a701851ac35c2f4657eb6378f"`
`orgId`	String	是	组织ID	`"org_14bfa9a7264848ea929a03151121816c"`
`id`	String	是	历史记录ID（MongoDB ObjectId），可通过「获取组织历史记录列表」接口返回的 `dataMap.id` 获取	`"69899f58e4b03ff088d62d62"`

请求示例

{
    "corpId": "ding4c7c311a701851ac35c2f4657eb6378f",
    "orgId": "org_14bfa9a7264848ea929a03151121816c",
    "id": "69899f58e4b03ff088d62d62"
}

响应参数

外层结构（ApiResponse）

参数名	类型	说明
`data`	Object	响应数据体
`success`	Boolean	请求是否成功
`errorCode`	String	错误编码，正常为 `null`
`errorMsg`	String	错误信息，正常为 `null`

data 结构（OpenDeleteOrgHistoryResponse）

参数名	类型	说明
`corpId`	String	企业ID
`orgId`	String	组织ID
`id`	String	历史记录ID
`errorMsg`	Map<String, String>	错误信息。`null` 表示操作成功；非 `null` 时，key 为字段标识，value 为错误提示

响应示例

删除成功

{
    "data": {
        "corpId": "ding4c7c311a701851ac35c2f4657eb6378f",
        "orgId": "org_14bfa9a7264848ea929a03151121816c",
        "id": "69899f58e4b03ff088d62d62",
        "errorMsg": null
    },
    "success": true,
    "errorCode": null,
    "errorMsg": null
}

删除失败 — 不能删除最后一条记录

组织至少需要保留一条历史记录，当仅剩一条时不允许删除。

{
    "data": {
        "corpId": "ding4c7c311a701851ac35c2f4657eb6378f",
        "orgId": "org_14bfa9a7264848ea929a03151121816c",
        "id": "69899f58e4b03ff088d62d62",
        "errorMsg": {
            "orgId": "不能删除最后一条记录"
        }
    },
    "success": true,
    "errorCode": null,
    "errorMsg": null
}

删除失败 — 记录不存在

{
    "data": {
        "corpId": "ding4c7c311a701851ac35c2f4657eb6378f",
        "orgId": "org_14bfa9a7264848ea929a03151121816c",
        "id": "invalid_id",
        "errorMsg": {
            "orgId": "记录不存在"
        }
    },
    "success": true,
    "errorCode": null,
    "errorMsg": null
}

参数校验失败

{
    "success": false,
    "errorCode": "400",
    "errorMsg": "企业ID不能为空"
}

业务校验规则

序号	校验项	错误信息	错误字段 key
1	企业ID不能为空	企业ID不能为空	参数校验层返回
2	组织ID不能为空	组织ID不能为空	参数校验层返回
3	历史记录ID不能为空	记录ID不能为空	参数校验层返回
4	组织至少保留一条记录	不能删除最后一条记录	`orgId`
5	记录ID必须存在	记录不存在	`orgId`
6	组织字段级校验不通过	根据具体字段返回	对应字段ID

业务处理流程

请求进入
  │
  ├── 1. 参数校验（corpId / orgId / id 不能为空）
  │
  ├── 2. 权限校验（需要 org:history:delete 权限）
  │
  ├── 3. 查询该组织的所有历史记录
  │     └── 记录数 ≤ 1 → 返回"不能删除最后一条记录"
  │
  ├── 4. 根据 id 查找目标记录
  │     └── 未找到 → 返回"记录不存在"
  │
  ├── 5. 执行组织字段级校验（DELETE_ORG_RECORD）
  │     └── 校验不通过 → 返回字段级错误信息
  │
  ├── 6. 执行软删除
  │
  ├── 7. 发布组织变更事件（通知下游系统）
  │
  └── 返回成功响应（errorMsg = null）

注意事项

成功判断方式：外层 success 始终为 true，需要通过 data.errorMsg 是否为 null 来判断操作是否真正成功

软删除：该操作为软删除，不会物理删除数据库记录

至少保留一条：组织必须保留至少一条历史记录，最后一条不允许删除

记录ID来源：id 字段的值可通过「获取组织历史记录列表」接口返回的 dataMap.id 获取

事件通知：删除成功后会发布组织变更事件（ORG_RECORD_DELETE），下游系统可监听该事件进行相应处理

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200删除指定的组织历史记录-Example

application/json

Bodyapplication/json

示例

{
    "data": {
        "corpId": "", //企业ID
        "orgId": "", //组织ID
        "id": "", //历史记录ID
        /**
         * 错误信息（为空表示成功）
         * key: 字段ID
         * value: 错误信息
         */
        "errorMsg": {
            "key": ""
        }
    },
    "success": false, //请求是否成功标志位
    "errorCode": "", //响应编码
    "errorMsg": "" //响应具体信息
}

删除指定的组织历史记录

删除组织历史记录接口#

基本信息#

请求参数#

请求体（Request Body）#

请求示例#

响应参数#

外层结构（ApiResponse）#

data 结构（OpenDeleteOrgHistoryResponse）#

响应示例#

删除成功#

删除失败 — 不能删除最后一条记录#

删除失败 — 记录不存在#

参数校验失败#

业务校验规则#

业务处理流程#

注意事项#

请求参数

请求示例代码

返回响应

删除组织历史记录接口

基本信息

请求参数

请求体（Request Body）

请求示例

响应参数

外层结构（ApiResponse）

data 结构（OpenDeleteOrgHistoryResponse）

响应示例

删除成功

删除失败 — 不能删除最后一条记录

删除失败 — 记录不存在

参数校验失败

业务校验规则

业务处理流程

注意事项