文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 版本分支管理/ 修改分支 - UpdateBranchGt
更新时间：2025-12-27 GMT+08:00
在线调试
CLI示例
查看PDF
分享

修改分支 - UpdateBranchGt

功能介绍

此接口用于对指定项目下的指定分支进行编辑操作,可修改分支名等属性

调用方法

请参见如何调用API。

URI

PUT /GT3KServer/v4/branches/{branch_id}

表1 路径参数

参数

是否必选

参数类型

描述

branch_id

是

String

分支URI

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

name

是

String

名称

number

否

String

开发分支名称

is_master

否

String

是否为Master分支

pbi_id

否

String

PBI ID

pbi_name

否

String

PBI信息

plan_start_date

否

String

开始时间

plan_start_timestamp

否

Long

开始时间戳

plan_end_date

否

String

结束时间

plan_end_timestamp

否

Long

结束时间戳

asyn_git

否

String

是否同步git库

project_uuid

是

String

项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID

project_name

否

String

项目名称（传入微服务名）

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

status

String

参数解释:

调用此接口的返回

取值范围:

  • success，表示接口调用成功。

  • failed，表示接口调用失败。

result

ResultValueTestVersionVo object

修改分支返回参数

error

ApiError object

错误信息

request_id

String

由接口调用方传入，建议使用UUID保证请求的唯一性。

server_address

String

本次请求的受理的服务地址
表4 ResultValueTestVersionVo

参数

参数类型

描述

total

Integer

起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值

value

TestVersionVo object

实际的数据类型：单个对象，集合 或 NULL

reason

String

业务失败的提示内容

page_size

Integer

分页大小

page_no

Integer

分页编码

has_more

Boolean

是否有更多
表5 TestVersionVo

参数

参数类型

描述

uri

String

资源URI

type

String

参数解释:

资源类型

取值范围:

  • TestCase，用例。

  • Task，任务。

  • TestVersion，分支。

  • IteratorTestCase，迭代用例。

author

String

创建人

name

String

名称

rank

Integer

级别

version

String

待测版本

owner

String

处理者ID

creator

String

创建人ID

iterations

String

关联迭代

description

String

描述

region

String

区域

last_modifier

String

最后修改人

last_modified

String

最后修改时间

last_modified_timestamp

Long

修改时间时间戳

last_change_time

String

最后变更时间

version_uri

String

版本URI

origin_uri

String

源资源URI

parent_uri

String

父资源URI

parent_path

String

父资源路径

creation_version_uri

String

创建版本URI

creation_date

String

创建时间

creation_date_timestamp

Long

创建时间时间戳

author_name

String

创建人名称

comment

String

备注

number

String

编号

is_master

Integer

是否为Master分支

is_iterator

Integer

是否为迭代

plan_start_date

String

开始时间

plan_end_date

String

结束时间

service_id

String

微服务ID

service_name

String

微服务名

pbi_id

String

PBI ID

pbi_name

String

PBI信息

plan_id

String

计划ID

metric_pbi_ids

String

度量PBI ID

metric_pbi_id_names

String

度量PBI名称

last_syn_date

String

最后同步时间

is_closed

String

版本是否关闭

asyn_git

String

是否同步git库

schema_no

Integer

schema编号

finish_date

String

迭代实际完成时间

owner_name

String

处理者名称

creator_name

String

创建人名称

current_stage

String

当前所处阶段

service_types

String

服务类型

risk_rating

Integer

风险等级

risk_des

String

风险描述

project_uuid

String

项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID

domain_id

String

租户ID

pi_id

String

pi的id
表6 ApiError

参数

参数类型

描述

code

String

业务失败的错误编码

reason

String

业务失败的提示内容

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码：401

表8 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码：404

表9 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码：500

表10 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

请求示例

post https://{endpoint}/GT3KServer/v4/branches/1232sgs

{
  "project_uuid" : "f3087a82b44744c29a1bd69ab6ada154",
  "name" : "分支1",
  "is_master" : "false"
}

响应示例

状态码：200

OK

{
  "value" : {
    "uri" : "12334",
    "rank" : 1,
    "version_uri" : "123saas54gh"
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 版本分支管理

相关文档