GET 模块字段定义列表

GET 查询。query 参数：label（模块标签，必填，如 customer / opportunity / product / supplier）、includeArchived（是否包含已停用字段，默认 false）。返回该模块的全部字段定义：fieldName 为字段标识、name 为显示名称、type 为字段类型、fieldType 区分来源（0=租户自定义、1=系统固定、2=系统字段但值独立存储）。做高级筛选（advancedFilters）时字段名取 fieldName——自定义字段的 fieldName 是随机标识（形如 field_ogwkl4），无法预知，须先调用本接口获取可用字段清单。

接口编码	所需范围	后端接口
`system.field.list`	`system:read`	`GET /v1/field/list`（comap-field）

请求参数（query）

字段	类型	必填	说明
`label`	string	是	—
`includeArchived`	boolean	—	—

「必填」仅反映接口规格声明的部分。服务内还有未体现在规格里的校验，标「—」不等于可以不传；租户在主站配置的字段必填不约束本接口。详见必填字段的判定与字段清单与自定义字段。

请求示例

curl -X POST https://open.risemap.cn/v1/api/invoke \
  -H "Authorization: Bearer <访问令牌>" \
  -H "Content-Type: application/json" \
  -d '{
    "apiCode": "system.field.list",
    "query": {
      "label": "string"
    }
  }'

响应 data 字段

字段	类型	必填	说明
`id`	integer(int64)	—	字段ID
`label`	string	—	模块标签
`fieldScope`	string	—	—
`fieldName`	string	—	字段标识
`name`	string	—	显示名称
`type`	integer(int32)	—	字段类型
`fieldType`	integer(int32)	—	0自定义 1系统固定 2系统但值在Data表
`isUnique`	integer(int32)	—	是否唯一
`isNull`	integer(int32)	—	是否必填
`isHidden`	integer(int32)	—	是否隐藏
`sorting`	integer(int32)	—	排序号
`options`	string	—	选项值JSON
`stylePercent`	integer(int32)	—	表单占比宽度
`maxNumRestrict`	string	—	数值最大限制
`minNumRestrict`	string	—	数值最小限制
`precisions`	integer(int32)	—	小数精度
`formPosition`	string	—	表单分组标识
`defaultValue`	string	—	默认值
`remark`	string	—	字段说明
`operating`	integer(int32)	—	是否只读
`isSystem`	integer(int32)	—	是否系统字段
`status`	integer(int32)	—	字段状态: 0=启用 1=停用/归档
`inputTips`	string	—	输入提示文字
`maxLength`	integer(int32)	—	最大输入长度
`relevant`	integer(int64)	—	关联字段ID
`formAssistId`	integer(int32)	—	前端辅助ID
`sensitivityLevel`	integer(int32)	—	敏感度分级: 0=PUBLIC 1=INTERNAL 2=CONFIDENTIAL 3=RESTRICTED
`maskRule`	string	—	脱敏规则 JSON
`visibilityRules`	string	—	条件显隐规则JSON，从options中提取
`fieldExtendList`19	FieldExtendVO[]	—	明细表子字段列表
`createTime`	string(date-time)	—	创建时间
`searchable`	boolean	—	是否可搜索
`sortable`	boolean	—	是否可排序
`filterable`	boolean	—	是否可筛选
`exportable`	boolean	—	是否可导出
`xaxis`	integer(int32)	—	—
`yaxis`	integer(int32)	—	—

错误处理

响应统一信封 { code, message, data }，code == 200 为成功。以下是本接口可能返回的开放平台层错误：

错误码	说明	可重试
92101	访问凭证无效	否
92201	接口未登记或已停用	否
92202	超出凭证授权范围——本接口需 `system:read`	否
92204	绑定员工无此接口的功能权限	否
92203	上游服务调用失败	是
92301	请求过于频繁	是

除此之外，comap-field 自身的业务校验失败会原样透传其业务码与提示（如字段校验、状态不允许、数据不存在），这类码不在开放平台的号段内，以响应里的 message 为准。完整的平台层错误码见错误码说明。

← 返回字段定义

错误处理​

错误处理