查询项目字段配置
功能介绍
查询项目字段配置
调用方法
请参见如何调用API。
URI
GET /v4/projects/{project_id}/field-configs
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字 默认取值: 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释： 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制： 必传。 取值范围： 字符串长度不少于1，不超过10万。 默认取值： 不涉及。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
status |
String |
参数解释 本次请求的处理状态 取值范围 success|error |
|
result |
请求返回的数据 |
|
|
error |
ApiError object |
错误信息 |
|
request_id |
String |
参数解释 请求的唯一id,由接口调用方传入，建议使用UUID保证请求的唯一性。 取值范围 不涉及 |
|
server_address |
String |
参数解释 本次请求的受理的服务地址。 取值范围 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
参数解释 符合条件的所有记录数 取值范围 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 |
|
value |
Array of ProjectFieldConfigVo objects |
参数解释 本次查询的记录结果 取值范围 实际的数据类型：单个对象，集合 或 NULL |
|
reason |
String |
参数解释 业务失败的提示内容 取值范围 不涉及 |
|
page_size |
Integer |
参数解释 每页展示条数 取值范围 不涉及 |
|
page_no |
Integer |
参数解释 页码 取值范围 不涉及 |
|
has_more |
Boolean |
参数解释 是否有更多 取值范围 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
uri |
String |
参数解释 字段配置URI标识 取值范围 不涉及 |
|
updator |
NameAndIdVo object |
参数解释 服务类型信息 取值范围 不涉及 |
|
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 |
参数解释 资源类型 取值范围 不涉及 |
|
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 |
参数解释 项目用例自定义字段入参或者返回参数名称 取值范围 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
参数解释 更新时间时间戳 取值范围 不涉及 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释: 业务失败的错误码 取值范围: 不涉及 |
|
reason |
String |
参数解释: 业务失败的提示内容 取值范围: 不涉及 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释: 业务失败的错误码 取值范围: 不涉及 |
|
reason |
String |
参数解释: 业务失败的提示内容 取值范围: 不涉及 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释: 业务失败的错误码 取值范围: 不涉及 |
|
reason |
String |
参数解释: 业务失败的提示内容 取值范围: 不涉及 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释: 业务失败的错误码 取值范围: 不涉及 |
|
reason |
String |
参数解释: 业务失败的提示内容 取值范围: 不涉及 |
请求示例
get https://{endpoint}/GT3KServer/v4/projects/efdb403066474ab08836b9eeaaa23bca/field-configs
响应示例
状态码：200
OK
{
"status" : "string",
"result" : {
"total" : 0,
"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"
} ],
"reason" : "string",
"page_size" : 0,
"page_no" : 0,
"has_more" : true
},
"error" : { },
"request_id" : "string",
"server_address" : "string"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server Error |
错误码
请参见错误码。
