查询字段列表
功能介绍
分页查询字段列表，关键字搜索支持标题、字段类型、创建人搜索
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/ipdprojectservice/projects/{project_id}/fields
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目Id |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
keyword |
否 |
String |
关键字搜索支持标题、字段类型、创建人搜索 |
|
offset |
是 |
Integer |
分页偏移量，从0开始，取值为limit的倍数 |
|
limit |
是 |
Integer |
分页大小 |
请求参数
无
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
status |
String |
请求状态 |
|
message |
String |
请求失败信息 |
|
result |
FieldListResult object |
字段列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
display_name |
String |
字段显示名 |
|
code |
String |
字段code |
|
id |
String |
字段id |
|
description |
String |
字段描述 |
|
created_by |
String |
字段创建人显示名 |
|
created_date |
String |
字段创建时间 |
|
modified_by |
String |
字段最后更新人显示名 |
|
definition_type |
String |
字段级别 1,2,3为系统字段，4为租户字段，5为项目字段 |
|
field_type_name |
String |
字段类型名称 |
|
required |
Boolean |
字段在工作项中是否必填，为true表示必填。和工作流配置不一致时以工作流为准 |
|
controlled |
Boolean |
字段在工作项中是否受控，为true表示受控。修改已基线的工作项受控字段需要走变更评审流程。和工作流配置不一致时以工作流为准 |
|
immutable |
Boolean |
字段在工作项中是否可修改，为true时不可修改。和工作流配置不一致时以工作流为准 |
|
no |
Integer |
字段排序的序号 |
|
all_options |
Array of OptionEntity objects |
字段选项 |
请求示例
根据关键字查询字段列表
{endpoint}/v1/ipdprojectservice/projects/b54914d464d1498a97d683ef198ec448/fields?offset=0&limit=1
响应示例
状态码： 200
OK
{
"status" : "success",
"result" : {
"data" : [ {
"display_name" : "小标题",
"code" : "c7186197833374113792",
"id" : "994277015639076864",
"description" : "222222222222",
"created_by" : "测试昵称",
"created_date" : "1715305846000",
"modified_by" : "测试昵称",
"definition_type" : "4",
"field_type_name" : "多行文本",
"required" : false,
"controlled" : false,
"immutable" : false,
"no" : 9999
} ],
"total" : 1
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
错误码
请参见错误码。
