更新时间：2025-09-11 GMT+08:00
查询IPD项目租户字段列表
功能介绍
查询IPD项目租户字段列表，包括系统预设字段和租户自定义字段。
调用方法
请参见如何调用API。
URI
POST /v1/ipdprojectservice/tenant/fields/query
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
page |
是 |
Integer |
参数解释： 分页索引 约束限制： 不涉及 取值范围： 最小值1，最大值10000 默认取值： 不涉及 |
|
size |
是 |
Integer |
参数解释： 分页大小 约束限制： 不涉及 取值范围： 最小值5，最大值200 默认取值： 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
search |
否 |
String |
参数解释： 关键字搜索，支持按字段标题、字段类型、字段创建人搜索。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
sort_info |
否 |
SortInfo object |
参数解释： 排序方式 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
page |
String |
参数解释： 当前页 取值范围： 不涉及 |
|
size |
String |
参数解释： 每页条数 取值范围： 不涉及 |
|
count |
String |
参数解释： 数据总数 取值范围： 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释： 字段id。 取值范围： 不涉及。 |
|
display_name |
String |
参数解释： 字段名称。 取值范围： 不涉及。 |
|
created_by |
String |
参数解释： 添加人。 取值范围： 不涉及。 |
|
field_type |
String |
参数解释： 字段类型。 取值范围： 不涉及。 |
|
show_on_card |
Boolean |
参数解释： 是否显示在新建页。 取值范围： true：是；false：否。 |
|
optional |
Boolean |
参数解释： 是否必填。 取值范围： true：必填；false：非必填。 |
|
all_options |
Array of OptionEntity objects |
参数解释： 字段选项。 取值范围： 不涉及。 |
|
default_value |
String |
参数解释： 默认值。 取值范围： 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释： 选项id 取值范围： 不涉及 |
|
code |
String |
参数解释： 选项code值 取值范围： 不涉及 |
|
display_value |
String |
参数解释： 选项名称 取值范围： 不涉及 |
|
value |
String |
参数解释： 选项唯一标识 取值范围： 不涉及 |
|
level |
Integer |
参数解释： 选项层级。用于区分层级字段的层级 取值范围： 层级字段最多4层 |
|
sequence |
Integer |
参数解释： 选项顺序 取值范围： 不涉及 |
|
parent_id |
String |
参数解释： 父选项id 取值范围： 不涉及 |
请求示例
查询租户字段列表
https://{endpoint}/v1/ipdprojectservice/tenant/fields/query?page=1&size=10
{
"search" : ""
}
响应示例
状态码：200
ok
{
"page" : {
"page" : 1,
"size" : 10,
"count" : 2
},
"result" : [ {
"display_name" : "更新租户字段选项2",
"code" : "c7354343193790545920",
"name" : "c7354343193790545920",
"id" : "1162422376023437316",
"show" : false,
"description" : "",
"default_value" : "",
"field_type" : "pick",
"field_id" : "1162422376023437316",
"created_by" : "Amy",
"created_userinfo" : {
"user_id" : "c2d89e38a64a466f8f945f595df4402d",
"user_num_id" : 1274137,
"user_name" : "ForTest",
"domain_id" : "aae03ca0d6814951980945b6eeca56cd",
"domain_name" : "HIS_CodeArtsReq",
"nick_name" : "Amy",
"role_id" : null,
"role_name" : null,
"role_code" : null
},
"created_date" : "1755072691000",
"modified_by" : "Amy",
"modified_date" : "1755072755000",
"definition_type" : "4",
"field_type_id" : "10001",
"alm_field_type_id" : "10001",
"field_type_name" : "单选列表",
"using_status" : true,
"controlled" : false,
"immutable" : false,
"optional" : true,
"show_on_split" : false,
"show_on_filter" : true,
"show_on_edit" : false,
"show_on_table" : true,
"sort_on_table" : true,
"no" : 9999,
"option" : [ {
"id" : "1162422376023437313",
"display_value" : "A",
"value" : "1162422376023437313",
"code" : "1162422376023437313",
"value_py" : "A",
"sequence" : 0,
"level" : 1,
"domain_id" : "-1",
"belong_definition_type" : "4"
}, {
"id" : "1162422376023437314",
"display_value" : "B",
"value" : "1162422376023437314",
"code" : "1162422376023437314",
"value_py" : "B",
"sequence" : 1,
"level" : 1,
"domain_id" : "-1",
"belong_definition_type" : "4"
}, {
"id" : "1162422376023437315",
"display_value" : "C",
"value" : "1162422376023437315",
"code" : "1162422376023437315",
"value_py" : "C",
"sequence" : 2,
"level" : 1,
"domain_id" : "-1",
"belong_definition_type" : "4"
} ],
"option_editable" : true,
"has_update_privilege" : false,
"has_same_display_name" : false
}, {
"display_name" : "更新租户层级字段",
"code" : "c7354346623145807872",
"name" : "c7354346623145807872",
"id" : "1162425805358092292",
"show" : false,
"description" : "",
"default_value" : "",
"field_type" : "pick",
"field_id" : "1162425805358092292",
"created_by" : "Amy",
"created_userinfo" : {
"user_id" : "c2d89e38a64a466f8f945f595df4402d",
"user_num_id" : 1274137,
"user_name" : "ForTest",
"domain_id" : "aae03ca0d6814951980945b6eeca56cd",
"domain_name" : "HIS_CodeArtsReq",
"nick_name" : "Amy",
"role_id" : null,
"role_name" : null,
"role_code" : null
},
"created_date" : "1755073508000",
"modified_by" : "Amy",
"modified_date" : "1755073639000",
"definition_type" : "4",
"field_type_id" : "10011",
"alm_field_type_id" : "10011",
"field_type_name" : "层级字段",
"using_status" : true,
"controlled" : false,
"immutable" : false,
"optional" : true,
"show_on_split" : false,
"show_on_filter" : true,
"show_on_edit" : false,
"show_on_table" : true,
"sort_on_table" : true,
"no" : 9999,
"option" : [ {
"id" : "1162425805358092289",
"display_value" : "A",
"value" : "1162425805358092289",
"code" : "1162425805358092289",
"value_py" : "A",
"sequence" : 0,
"level" : 1,
"domain_id" : "-1",
"belong_definition_type" : "4"
}, {
"id" : "1162425805358092290",
"display_value" : "AAa1",
"value" : "1162425805358092290",
"code" : "1162425805358092290",
"value_py" : "AAa1",
"sequence" : 0,
"level" : 2,
"parent_id" : "1162425805358092289",
"domain_id" : "-1",
"belong_definition_type" : "4"
}, {
"id" : "1162425805358092291",
"display_value" : "AAA1",
"value" : "1162425805358092291",
"code" : "1162425805358092291",
"value_py" : "AAA1",
"sequence" : 0,
"level" : 3,
"parent_id" : "1162425805358092290",
"domain_id" : "-1",
"belong_definition_type" : "4"
}, {
"id" : "1162426355597901824",
"display_value" : "AA2",
"value" : "1162426355597901824",
"code" : "1162426355597901824",
"value_py" : "AA2",
"sequence" : 1,
"level" : 2,
"parent_id" : "1162425805358092289",
"domain_id" : "-1",
"belong_definition_type" : "4"
}, {
"id" : "1162426355597901825",
"display_value" : "AAA2",
"value" : "1162426355597901825",
"code" : "1162426355597901825",
"value_py" : "AAA2",
"sequence" : 0,
"level" : 3,
"parent_id" : "1162426355597901824",
"domain_id" : "-1",
"belong_definition_type" : "4"
} ],
"option_editable" : true,
"has_update_privilege" : false,
"has_same_display_name" : false
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
ok |
错误码
请参见错误码。
父主题： IPD字段管理
