查询项目字段配置 - ListProjectFieldConfigsV4

功能介绍

查询项目字段配置

调用方法

URI

GET /v4/projects/{project_id}/field-configs

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释: 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID 约束限制: 不涉及取值范围: 项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字默认取值: 不涉及

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释：用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。约束限制：必传。取值范围：字符串长度不少于1，不超过10万。默认取值：不涉及。

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
status	String	参数解释本次请求的处理状态取值范围 success\|error
result	ResultValueListProjectFieldConfigVo object	参数解释请求返回的数据取值范围不涉及
error	ApiError object	参数解释错误信息取值范围不涉及
request_id	String	参数解释请求的唯一id,由接口调用方传入，建议使用UUID保证请求的唯一性。取值范围不涉及
server_address	String	参数解释本次请求的受理的服务地址。取值范围不涉及

表4 ResultValueListProjectFieldConfigVo
参数	参数类型	描述
total	Integer	参数解释符合条件的所有记录数取值范围起始记录数大于实际总条数时，值为0，分页请求才有此值
value	Array of ProjectFieldConfigVo objects	参数解释本次查询的记录结果取值范围实际的数据类型：单个对象，集合或 NULL
reason	String	参数解释业务失败的提示内容取值范围不涉及
page_size	Integer	参数解释每页展示条数取值范围不涉及
page_no	Integer	参数解释页码取值范围不涉及
has_more	Boolean	参数解释是否有更多取值范围不涉及

表5 ProjectFieldConfigVo
参数	参数类型	描述
uri	String	参数解释字段配置URI标识取值范围不涉及
updator	NameAndIdVo object	参数解释名称和id关系取值范围不涉及
description	String	参数解释描述取值范围不涉及
customName	String	参数解释项目用例自定义字段名称取值范围不涉及
table_field_name	String	参数解释字段名（对应后端参数名）取值范围不涉及
value_type	String	参数解释字段类取值范围单行文本text、多行文本textArea、单选框radio、多选框checkbox、日期date、数字number、用户user
value_type_name	String	参数解释字段类型国际化名称）取值范围不涉及
is_system	Integer	参数解释是否系统字段取值范围不涉及
is_display	Integer	参数解释是否显示取值范围不涉及
is_required	Integer	参数解释是否必填取值范围不涉及
sort_numb	Integer	参数解释顺序数值取值范围不涉及
default_value	String	参数解释默认值取值范围不涉及
custom_field_uri	String	参数解释扩展字段uri(用于连表查扩展字段) 取值范围不涉及
resource_type	String	参数解释: 资源类型取值范围: TestCase，用例。 Task，任务。 TestVersion，分支。 IteratorTestCase，迭代用例。
creator	NameAndIdVo object	参数解释服务类型信息取值范围不涉及
create_time_stamp	Long	参数解释创建时间时间戳取值范围不涉及
update_time_stamp	Long	参数解释更新时间时间戳取值范围不涉及
project_uuid	String	参数解释项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID 取值范围不涉及
option_vos	Array of ProjectFieldConfigOptionVo objects	参数解释可选项取值范围不涉及
custom_field_id	Integer	参数解释项目用例自定义字段id 取值范围（1-25数字）
custom_field_name	String	参数解释项目用例自定义字段名称取值范围不涉及
custom_field_param	String	参数解释项目用例自定义字段入参或者返回参数名称取值范围不涉及

表6 ProjectFieldConfigOptionVo
参数	参数类型	描述
uri	String	参数解释字段选项URI标识. 取值范围新增不传，修改、删除使用必传
name	String	参数解释可选项名称取值范围不涉及
code	String	参数解释可选项code值取值范围不涉及
updator	NameAndIdVo object	参数解释服务类型信息取值范围不涉及
description	String	参数解释描述取值范围不涉及
flag	Integer	参数解释修改标识取值范围 0：不可修改 1：可修改，用于结果和状态的选项值
sort_numb	Integer	参数解释顺序数值取值范围不涉及
creator	NameAndIdVo object	参数解释服务类型信息取值范围不涉及
create_time_stamp	Long	参数解释创建时间时间戳取值范围不涉及
update_time_stamp	Long	参数解释更新时间时间戳取值范围不涉及

表7 NameAndIdVo
参数	参数类型	描述
id	String	参数解释 ID 取值范围不涉及
name	String	参数解释名称取值范围不涉及

表8 ApiError
参数	参数类型	描述
code	String	参数解释: 业务失败的错误码取值范围: 不涉及
reason	String	参数解释: 业务失败的提示内容取值范围: 不涉及

状态码：400

表9 响应Body参数
参数	参数类型	描述
code	String	参数解释: 业务失败的错误码取值范围: 不涉及
reason	String	参数解释: 业务失败的提示内容取值范围: 不涉及

状态码：401

**表10** 响应Body参数
参数	参数类型	描述
code	String	参数解释: 业务失败的错误码取值范围: 不涉及
reason	String	参数解释: 业务失败的提示内容取值范围: 不涉及

状态码：404

**表11** 响应Body参数
参数	参数类型	描述
code	String	参数解释: 业务失败的错误码取值范围: 不涉及
reason	String	参数解释: 业务失败的提示内容取值范围: 不涉及

状态码：500

**表12** 响应Body参数
参数	参数类型	描述
code	String	参数解释: 业务失败的错误码取值范围: 不涉及
reason	String	参数解释: 业务失败的提示内容取值范围: 不涉及

请求示例

get https://{endpoint}/GT3KServer/v4/projects/efdb403066474ab08836b9eeaaa23bca/field-configs

响应示例

状态码：200

{
  "value" : [ {
    "uri" : "005t3o8pmtm",
    "updator" : { },
    "description" : "描述",
    "customName" : "名称aaa",
    "table_field_name" : "status,name,result",
    "value_type" : "text",
    "value_type_name" : "单选项",
    "is_system" : 1,
    "is_display" : 1,
    "is_required" : 1,
    "sort_numb" : 10,
    "default_value" : "默认值",
    "custom_field_uri" : "fdsj58mnfgb524",
    "resource_type" : "TestCase",
    "creator" : { },
    "create_time_stamp" : 1660617231016,
    "update_time_stamp" : 1660617231016,
    "project_uuid" : "1f22e3511dd348e38131b4066afbd0b4",
    "option_vos" : [ { } ],
    "custom_field_id" : 1,
    "custom_field_name" : "项目用例自定义字段名称",
    "custom_field_param" : "custom_field_1"
  } ]
}