更新时间:2024-06-17 GMT+08:00
分享

查询项目字段配置

功能介绍

查询项目字段配置

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

最小长度:32

最大长度:32

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

最小长度:1

最大长度:100000

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

status

String

对外时:success|error; 对内时:ok|failed

result

ResultValueListProjectFieldConfigVo object

请求的返回的数据对象

error

ApiError object

失败时的error信息

request_id

String

由接口调用方传入,建议使用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

服务类型信息

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

项目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

业务失败的提示内容

请求示例

响应示例

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码

分享:

    相关文档

    相关产品