更新用户自定义列展示及顺序配置
功能介绍
更新用户自定义列展示及顺序配置
调用方法
请参见如何调用API。
URI
PUT /v4/projects/{project_id}/customized-columns
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
service_type |
是 |
Integer |
服务类型 |
|
stage_type |
是 |
Integer |
阶段过程（2：测试设计，3：测试执行，4：质量报告） |
|
display |
否 |
Array of ColumnInfo objects |
展示的表格列集合 |
|
hidden |
否 |
Array of ColumnInfo objects |
隐藏的表格列集合 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
status |
String |
success|error |
|
result |
请求结果 |
|
|
error |
ApiError object |
错误信息 |
|
request_id |
String |
由接口调用方传入，建议使用UUID保证请求的唯一性。 |
|
server_address |
String |
本次请求的受理的服务地址 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 |
|
value |
自定义展示列 |
|
|
reason |
String |
业务失败的提示内容 |
|
page_size |
Integer |
分页大小 |
|
page_no |
Integer |
分页编码 |
|
has_more |
Boolean |
是否有更多 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
display |
Array of ColumnVo objects |
展示的表格列集合 |
|
hidden |
Array of ColumnVo objects |
隐藏的表格列集合 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
表格列ID |
|
name |
String |
表格列名称 |
|
custom_field_param |
String |
项目用例自定义字段入参或者返回参数名称 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释 接口调用失败错误码 取值范围 不涉及 |
|
error_msg |
String |
参数解释 接口调用失败错误信息 取值范围 不涉及 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释 接口调用失败错误码 取值范围 不涉及 |
|
error_msg |
String |
参数解释 接口调用失败错误信息 取值范围 不涉及 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释 接口调用失败错误码 取值范围 不涉及 |
|
error_msg |
String |
参数解释 接口调用失败错误信息 取值范围 不涉及 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释 接口调用失败错误码 取值范围 不涉及 |
|
error_msg |
String |
参数解释 接口调用失败错误信息 取值范围 不涉及 |
请求示例
put https://{endpoint}/v4/projects/a5eb0d410ea341a192f7c12483568985/customized-columns
{
"display" : [ {
"id" : "B",
"name" : "名称"
}, {
"id" : "A",
"name" : "编号"
}, {
"id" : "I",
"name" : "结果"
}, {
"id" : "D",
"name" : "用例等级"
}, {
"id" : "S",
"name" : "执行者"
}, {
"id" : "U",
"name" : "执行方式"
}, {
"id" : "Z",
"name" : "关联测试设计"
}, {
"id" : "G",
"name" : "状态"
} ],
"hidden" : [ {
"id" : "E",
"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" : "Y",
"name" : "评审状态"
}, {
"id" : "AA",
"name" : "密级"
} ],
"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" : "执行方式"
}, {
"id" : "N",
"name" : "关联缺陷"
}, {
"id" : "C",
"name" : "处理者"
} ],
"hidden" : [ {
"id" : "G",
"name" : "状态"
}, {
"id" : "J",
"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" : "评审状态"
}, {
"id" : "Z",
"name" : "关联测试设计"
} ]
}
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server Error |
错误码
请参见错误码。
