查询Scrum工作项自定义字段
功能介绍
查询Scrum工作项自定义字段的可选列表,符合custom_fields或者names条件的都返回,2个值都不传，返回所有的自定义字段列表
URI
POST /v4/projects/{project_id}/issues/custom-fields
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
devcloud项目的32位id |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
custom_fields |
否 |
Array of strings |
自定义字段 |
|
names |
否 |
Array of strings |
自定义字段页面显示的含义 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
datas |
Array of IssueCustomField objects |
自定义字段返回数据 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
自定义字段 |
|
custom_field |
String |
自定义字段 |
|
options |
String |
自定义字段的可选值，多个值以英文逗号区分 |
|
type |
String |
自定义字段类型， textArea 多行文本，只能包含汉字、英文大小写字母、数字、下划线和连接符，不能超过500字符； text 单行文本， 只能包含汉字、英文大小写字母、数字、下划线和连接符，不能超过500字符； select 下拉框，只能包含汉字、英文大小写字母、数字、下划线和连接符，每个选项最大长度40个字符，最多可定义60个选项； number 数字，取值范围由用户创建自定义字段时设置； date 日期 精确到年月日， time_date 日期 精确到时分秒， 长整型时间戳； checkbox 多选框，只能包含汉字、英文大小写字母、数字、下划线和连接符，每个选项最大长度40个字符，最多可定义60个选项； radio 单选框，只能包含汉字、英文大小写字母、数字、下划线和连接符，每个选项最大长度40个字符，最多可定义60个选项； |
|
tracker_ids |
Array of integers |
自定义字段支持的工作项类型 2任务/Task,3缺陷/Bug,5Epic,6Feature,7Story |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
错误描述 |
|
error_code |
String |
错误码 |
状态码： 401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
错误描述 |
|
error_code |
String |
错误码 |
请求示例
Post https://{endpoint}/v4/projects/0792b7d26cb74bd799cbae80063dc74a/issues/custom-fields
{
"names" : [ "下拉框Demo" ]
}
响应示例
状态码： 200
OK
{
"datas" : [ {
"name" : "selectName",
"custom_field" : "custom_field16",
"options" : "selectName1,selectName2",
"type" : "ratio",
"tracker_ids" : [ 7 ]
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
错误码
请参见错误码。
