文档首页/ 需求管理 CodeArts Req/ API参考/ API/ IPD项目计划管理/ 批量删除计划
更新时间：2025-10-15 GMT+08:00
在线调试
CLI示例
查看PDF
分享

批量删除计划

功能介绍

当需要删除发布计划/迭代时，可调用此接口，用户可以根据传入的发布计划/迭代id列表批量删除计划或迭代。

调用方法

请参见如何调用API。

URI

DELETE /v1/planservice/projects/{project_id}/plans/batch-delete

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目的32位uuid，项目唯一标识，通过查询项目列表接口获取，响应消息体中的project_id字段的值就是项目ID。

约束限制：

正则表达式，^[A-Za-z0-9]{32}$。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

x-auth-token

是

String

参数解释：用户token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

约束限制：不涉及

取值范围：最小长度10，最大长度：32768

默认取值：不涉及
表3 请求Body参数

参数

是否必选

参数类型

描述

ids

否

Array of strings

参数解释:

批量删除的发布计划/迭代的id列表，列表元素为发布/迭代唯一Id。

通过发布/迭代计划列表查询接口查询发布计划的id，返回参数中PlanVO里面的id字段即发布计划的id。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

result

BatchResultVO object

参数解释：

批量操作结果数据对象
表5 BatchResultVO

参数

参数类型

描述

success_num

Number

参数解释：

成功数量

取值范围：

不涉及

fail_num

Number

参数解释：

失败数量

取值范围：

不涉及

success

Array of BatchOperateInfo objects

参数解释：

成功的结果列表

failed

Array of BatchOperateInfo objects

参数解释：

失败的结果列表
表6 BatchOperateInfo

参数

参数类型

描述

id

String

参数解释：

发布/迭代计划的id

取值范围：

不涉及

modified_by

String

参数解释：

更新者

取值范围：

不涉及

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

批量删除计划

https://{endpoint}/v1/planservice/projects/9548acc581ba498d9895ecdb7d2db5ea/plans/batch-delete

{
  "ids" : [ "1164155086611324928", "1164155134381436929" ]
}

响应示例

状态码：200

批量删除接口成功的响应

{
  "status" : "success",
  "message" : null,
  "result" : {
    "success_num" : 2,
    "fail_num" : 0,
    "success" : [ {
      "id" : "1164155086611324928",
      "modified_by" : "a360371833bf4c558f796fd707b44daf"
    }, {
      "id" : "1164155134381436929",
      "modified_by" : "a360371833bf4c558f796fd707b44daf"
    } ],
    "failed" : [ ]
  }
}

状态码

状态码

描述

200

批量删除接口成功的响应

400

批量删除接口失败的错误信息

错误码

请参见错误码。

父主题： IPD项目计划管理

相关文档