文档首页/ 需求管理 CodeArts Req/ API参考/ API/ IPD项目计划管理/ 批量基线或取消基线 - BatchUpdateBaseline
更新时间：2026-09-01 GMT+08:00
在线调试
CLI示例
查看PDF
分享

批量基线或取消基线 - BatchUpdateBaseline

功能介绍

批量基线或取消基线

调用方法

请参见如何调用API。

授权信息

账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

codeartsreq:plan:baseline

Write

-

  • codeartsreq:Model

  • codeartsreq:ProjectId

-

-

URI

PUT /v1/planservice/projects/{project_id}/plans/batch-baseline

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

32个字符，由英文字母和数字组成。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

x-auth-token

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

长度为10-32768的字符串。

默认取值：

不涉及。
表3 请求Body参数

参数

是否必选

参数类型

描述

ids

是

Array of strings

参数解释：

发布/迭代计划ID列表，通过发布/迭代计划列表查询接口获取，响应消息体中的id字段的值就是发布/迭代ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

attribute

是

BaseLineVO object

参数解释：

基线属性信息，指定基线或取消基线操作。

约束限制：

不涉及。
表4 BaseLineVO

参数

是否必选

参数类型

描述

baseline

否

String

参数解释：

基线或取消基线操作类型。

约束限制：

不涉及。

取值范围：

  • baselined：基线发布/迭代计划

  • unbaseline：取消基线，恢复发布/迭代计划

默认取值：

不涉及。

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

status

String

参数解释：

返回状态。

取值范围：

  • success：批量操作成功

  • error：批量操作失败

message

String

参数解释：

返回消息。

取值范围：

不涉及。

result

BatchResultVO object

参数解释：

批量操作结果数据。
表6 BatchResultVO

参数

参数类型

描述

success_num

Number

参数解释：

批量操作成功的数量。

取值范围：

不涉及。

fail_num

Number

参数解释：

批量操作失败的数量。

取值范围：

不涉及。

success

Array of BatchOperateInfo objects

参数解释：

批量操作成功的计划列表。

failed

Array of BatchOperateInfo objects

参数解释：

批量操作失败的计划列表。
表7 BatchOperateInfo

参数

参数类型

描述

id

String

参数解释：

发布/迭代计划ID。

取值范围：

长度为18~19个字符的数字字符串。

modified_by

String

参数解释：

最近更新人ID。

取值范围：

不涉及。

状态码：400

表8 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误描述信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

请求示例

PUT https://{endpoint}/v1/planservice/projects/b54914d464d1498a97d683ef198ec448/plans/batch-baseline

{
  "ids" : [ "6614174000", "6614174000" ],
  "attribute" : {
    "baseline" : "基线"
  }
}

响应示例

状态码：200

批量基线或取消基线成功

{
  "status" : "success",
  "message" : null,
  "result" : {
    "success_num" : 3,
    "fail_num" : 1,
    "success" : [ {
      "id" : "123e4567e89b12d3a456426614174000",
      "modified_by" : "user1"
    }, {
      "id" : "123e4567e89b12d3a456426614174001",
      "modified_by" : "user2"
    }, {
      "id" : "123e4567e89b12d3a456426614174002",
      "modified_by" : "user3"
    } ],
    "failed" : [ {
      "id" : "123e4567e89b12d3a456426614174003",
      "modified_by" : "user4"
    } ]
  }
}

状态码：400

Bad Request

{
  "error_msg" : "Invalid project_id or other parameters",
  "error_code" : "AS.0001"
}

状态码

状态码

描述

200

批量基线或取消基线成功

400

Bad Request

错误码

请参见错误码。

父主题： IPD项目计划管理

相关文档