文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 自定义测试服务用例管理/ 查询用户自定义列展示及顺序配置
更新时间：2024-09-12 GMT+08:00
查看PDF
分享

查询用户自定义列展示及顺序配置

功能介绍

查询用户自定义列展示及顺序配置

URI

GET /v4/projects/{project_id}/customized-columns

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

service_type

是

Integer

服务类型

stage_type

是

Integer

阶段过程（2：测试设计，3：测试执行，4：质量报告，5：测试套执行）

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

status

String

success|error;

result

ResultValueCustomizedColumnDisplayConfigVo object

请求的返回的数据对象

error

ApiError object

失败时的error信息

request_id

String

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

server_address

String

本次请求的受理的服务地址
表5 ResultValueCustomizedColumnDisplayConfigVo

参数

参数类型

描述

total

Integer

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

value

CustomizedColumnDisplayConfigVo object

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

reason

String

业务失败的提示内容

page_size

Integer

每页展示条数

page_no

Integer

页码

has_more

Boolean

是否有更多
表6 CustomizedColumnDisplayConfigVo

参数

参数类型

描述

display

Array of ColumnVo objects

展示的表格列集合

hidden

Array of ColumnVo objects

隐藏的表格列集合
表7 ColumnVo

参数

参数类型

描述

id

String

表格列ID

name

String

表格列名称

custom_field_param

String

项目用例自定义字段入参或者返回参数名称
表8 ApiError

参数

参数类型

描述

code

String

业务失败的错误码

reason

String

业务失败的提示内容

状态码： 400

表9 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码： 401

表10 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码： 404

表11 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码： 500

表12 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

请求示例

查询用户自定义列展示及顺序配置

get https://{endpoint}/v4/projects/300c6295a54c4c698608c878f47ddd59/customized-columns?service_type=-1&stage_type=3

响应示例

状态码： 200

OK

{
  "status" : "success",
  "result" : {
    "value" : {
      "display" : [ {
        "id" : "B",
        "name" : "名称"
      }, {
        "id" : "A",
        "name" : "编号"
      }, {
        "id" : "I",
        "name" : "结果"
      }, {
        "id" : "D",
        "name" : "级别"
      }, {
        "id" : "S",
        "name" : "执行者"
      }, {
        "id" : "U",
        "name" : "执行方式"
      } ],
      "hidden" : [ {
        "id" : "G",
        "name" : "状态"
      }, {
        "id" : "C",
        "name" : "处理者"
      }, {
        "id" : "J",
        "name" : "关联需求"
      }, {
        "id" : "N",
        "name" : "缺陷"
      }, {
        "id" : "H",
        "name" : "执行次数"
      }, {
        "id" : "Q",
        "name" : "执行时间"
      }, {
        "id" : "R",
        "name" : "执行时长"
      }, {
        "id" : "F",
        "name" : "迭代"
      }, {
        "id" : "L",
        "name" : "创建时间"
      }, {
        "id" : "O",
        "name" : "模块"
      }, {
        "id" : "K",
        "name" : "创建者"
      }, {
        "id" : "T",
        "name" : "类型"
      }, {
        "id" : "X",
        "name" : "标签"
      }, {
        "id" : "E",
        "name" : "是否来自测试设计"
      }, {
        "id" : "Y",
        "name" : "评审状态"
      } ]
    }
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

相关文档