文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 测试计划管理/ 获取分支列表
更新时间：2024-11-19 GMT+08:00
查看PDF
分享

获取分支列表

功能介绍

获取分支列表

URI

GET /v1/{project_id}/branches

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目id，对应"需求管理 CodeArts Req"项目唯一标识，测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值

约束限制:

不涉及

取值范围:

项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字

默认取值:

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

sort_field

否

String

排序字段

sort_type

否

String

排序方式

offset

是

Integer

起始偏移量，表示从此偏移量开始查询， offset大于等于0，小于等于20000

limit

是

Integer

每页显示的条目数量，最大支持200条

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

total

Integer

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

project_id

String

项目ID

values

Array of ExternalBranchInfoVo objects

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

参数

参数类型

描述

id

String

分支ID

type

String

类型

author

String

创建人

name

String

名称

region

String

区域

last_modifier

String

最后修改人

last_modified

String

最后修改时间

last_modified_timestamp

Long

修改时间时间戳

creation_date

String

创建时间

creation_date_timestamp

Long

创建时间时间戳

author_name

String

创建人名称

is_base_branch

Integer

是否为基线分支。0表示不是基线分支，1表示是基线分支。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码： 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码： 404

表8 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码： 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

请求示例

get https://{endpoint}/v1/efdb403066474ab08836b9eeaaa23bca/branches?offset=1&limit=10&sort_field=name&sort_type=ASC

响应示例

状态码： 200

OK

{
  "total" : 1,
  "project_id" : "1f22e3511dd348e38131b4066afbd0b4",
  "values" : [ {
    "id" : "001s16gt6q5",
    "type" : "TestVersion",
    "author" : "efdb403066474ab08836b9eeaaa23bca",
    "name" : "名称",
    "region" : "cn-north-7",
    "last_modifier" : "张三",
    "last_modified" : "2023-07-20 02:17:01",
    "last_modified_timestamp" : 1660617231016,
    "creation_date" : "2023-07-20 02:17:01",
    "creation_date_timestamp" : 1660617231016,
    "author_name" : "tester",
    "is_base_branch" : 0
  } ]
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 测试计划管理

相关文档