文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 项目配置管理/ 更新项目字段配置顺序 - UpdateProjectFieldConfigSort
更新时间:2025-12-27 GMT+08:00
分享

更新项目字段配置顺序 - UpdateProjectFieldConfigSort

功能介绍

此接口用于更新项目自定义字段配置顺序,可以调整自定义字段的先后

设置 -> 测试设置 -> 用例字段设置

调用方法

请参见如何调用API

URI

PUT /v4/projects/{project_id}/field-configs/sort

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

project_field_config_infos

Array of ProjectFieldConfigInfo objects

项目字段配置入参info数组

表3 ProjectFieldConfigInfo

参数

是否必选

参数类型

描述

uri

String

字段配置URI标识

description

String

描述

table_field_name

String

字段名称

value_type

String

字段类型(单行文本text、多行文本textArea、单选框radio、多选框checkbox、日期date、数字number、用户user)。

is_display

Integer

是否显示

is_required

Integer

是否必填

sort_numb

Integer

顺序数值

default_value

String

默认值

custom_field_uri

String

扩展字段uri(用于连表查扩展字段)

resource_type

String

参数解释:

资源类型

约束限制:

根据资源类型传入对应的值

取值范围:

  • TestResult,测试结果。

  • Task,测试任务。

  • TestCase,测试用例。

  • TestReport,测试报告。

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

value

String

请求返回的数据

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码:401

表6 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码:404

表7 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码:500

表8 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

请求示例

put https://{endpoint}/v4/projects/{project_id}/field-configs/sort

{
  "project_field_config_infos" : [ {
    "uri" : "005t3o8pmtm",
    "description" : "描述",
    "table_field_name" : "状态、名称、编号",
    "value_type" : "text",
    "is_display" : 1,
    "is_required" : 1,
    "sort_numb" : 10,
    "default_value" : "默认值",
    "custom_field_uri" : "fdsj58mnfgb524",
    "resource_type" : "TestCase"
  } ]
}

响应示例

状态码:200

OK

{
  "status" : "string",
  "result" : "ok",
  "error" : { },
  "request_id" : "string",
  "server_address" : "string"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档