文档首页/ 需求管理 CodeArts Req/ API参考/ API/ Scrum项目的工作项/ 创建工作项类型自定义字段
更新时间:2022-12-08 GMT+08:00

创建工作项类型自定义字段

功能介绍

创建工作项类型自定义字段

URI

POST /v3/{project_id}/custom-fields

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

devcloud项目的32位id

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

字段名称

type

String

自定义字段类型 可选类型 textArea|select|radio|text|checkbox|date|time_date|number

options

String

字段选项

memo

String

描述

scrum_type

String

工作项类型

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

options

String

字段选项

region

String

系统字段

id

Integer

字段ID

identifier

String

字段ID

project_id

Integer

项目ID

tracker_id

Integer

工作项类型id 2任务/Task,3缺陷/Bug,5Epic,6Feature,7Story

custom_field

String

系统字段名

type

String

字段类型

name

String

字段名称

sort

Integer

系统字段

memo

String

字段描述

created

String

创建时间

modified

String

修改时间

is_delete

Boolean

是否被删除

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

状态码: 401

表6 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

请求示例

Post https://{endpoint}/v3/0792b7d26cb74bd799cbae80063dc74a/custom-fields

{
  "name" : "test",
  "type" : "text",
  "memo" : "描述",
  "options" : "0792b7d26cb74bd799cbae80063dc74a",
  "scrum_type" : "Story"
}

响应示例

状态码: 200

OK

{
  "options" : "select1,select2",
  "region" : "southchina",
  "id" : 1,
  "identifier" : "81abca040032407bb62d52536d69ce2d",
  "project_id" : 2282492,
  "tracker_id" : 3,
  "custom_field" : "custom_field34",
  "type" : "select",
  "name" : "test",
  "sort" : 1,
  "memo" : "description",
  "created" : "2020-06-02T10:45:09Z",
  "modified" : 1,
  "is_delete" : false
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

错误码

请参见错误码