查询自定义字段值
功能介绍
查询自定义字段值。
调用方法
请参见如何调用API。
URI
GET /v2/custom-field/query-custom-field
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
否 |
String |
参数解释: 项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
tracker_id |
否 |
String |
参数解释: 工作项类型。 约束限制: 不涉及。 取值范围: 2(任务/Task) 3(缺陷/Bug) 5(Epic) 6(Feature) 7(Story) 默认取值: 不涉及。 |
请求参数
无
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
result |
result object |
参数解释: 查询自定义字段值响应的结果。 |
status |
String |
参数解释: 查询自定义字段响应体的状态。 取值范围: success:成功 error:失败 |
参数 |
参数类型 |
描述 |
---|---|---|
tracker_list |
Array of strings |
参数解释: 自定义字段列表。 取值范围: 不涉及。 |
region |
String |
参数解释: 所属项目的区域。 取值范围: 不涉及。 |
id |
Integer |
参数解释: 自定义字段的唯一id。 取值范围: 不涉及。 |
project_id |
Integer |
参数解释: 自定义字段的所属项目id。 取值范围: 不涉及。 |
tracker_id |
Integer |
参数解释: 自定义字段所属的工作项类型id。 取值范围: 2(任务/Task) 3(缺陷/Bug) 5(Epic) 6(Feature) 7(Story)。 |
custom_field |
String |
参数解释: 自定义字段的名称标识。 取值范围: 不涉及。 |
type |
String |
参数解释: 自定义字段的类型。 取值范围: 不涉及。 |
name |
String |
参数解释: 自定义字段的显示名称。 取值范围: 不涉及。 |
sort |
Integer |
参数解释: 字段的排序编号,用于在界面中确定字段的显示顺序。 取值范围: 不涉及。 |
memo |
String |
参数解释: 自定义字段的附加信息。 取值范围: 不涉及。 |
created |
String |
参数解释: 自定义字段的创建时间。格式:YYYY-MM-DD HH:mm:ss(示例:2025-07-28 14:47:38) 取值范围: 不涉及。 |
modified |
String |
参数解释: 自定义字段的修改时间。格式:YYYY-MM-DD HH:mm:ss(日期时间格式:2025-07-28 14:47:38) 取值范围: 不涉及。 |
is_delete |
Boolean |
参数解释: 该自定义字段是否删除。 取值范围: true:已删除 false:未删除 |
请求示例
{endpoint}/v2/custom-field/query-custom-field?project_id=5192de5eb435430c8cd41c6ae6028848&tracker_id=3
响应示例
无
状态码
状态码 |
描述 |
---|---|
200 |
OK。 |
错误码
请参见错误码。