快速新建子工作项
功能介绍
快速新建子工作项。
调用方法
请参见如何调用API。
URI
POST /v2/issues/quick-issue
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 最小长度:10,最大长度:32768。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
- |
否 |
String |
快速新建子工作项的请求参数。 |
subject |
否 |
String |
参数解释: 工作项标题,可通过高级查询工作项接口获取,响应消息体中的subject字段的值就是工作项标题。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及 |
assigned_to_id |
否 |
Integer |
参数解释: 模块的负责人数字id,通过获取指定项目的成员用户列表接口获取,响应消息体中的assigned_to_id字段的值就是模块的负责人数字id。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
tracker_id |
否 |
Integer |
参数解释: 工作项类型id。 约束限制: 不涉及。 取值范围: 2(任务/Task) 3(缺陷/Bug) 5(Epic) 6(Feature) 7(Story) 默认取值: 不涉及。 |
projectUUId |
否 |
String |
参数解释: 项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 32位的数字和字母组成的字符串。 取值范围: 不涉及。 默认取值: 不涉及。 |
parent_issue_id |
否 |
Integer |
参数解释: 父工作项id,可通过高级查询工作项接口获取,响应消息体中的id字段的值就是工作项id。 约束限制: 长度在1位到10位之间的纯数字。 取值范围: 最小长度:1,最大长度:10 默认取值: 不涉及。 |
fixed_version_id |
否 |
String |
参数解释: 新建子工作项的迭代id,可通过高级查询工作项接口获取。 约束限制: 以.和0结尾的字符串,前面可以有任意数量的数字。比如“.0”、“123.0”、“456.0” 取值范围: 不涉及。 默认取值: 不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
- |
String |
参数解释: 快速新建子工作项的响应结果。 |
result |
result object |
参数解释: 返回结果。 取值范围: 不涉及。 |
status |
String |
参数解释: 返回状态。 取值范围: success:返回成功。 error:返回失败。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
Integer |
参数解释: 项目ID。 取值范围: 不涉及。 |
region |
String |
参数解释: 局点信息。 取值范围: 不涉及。 |
projectUUId |
String |
参数解释: 项目32位UUID。 取值范围: 不涉及。 |
subject |
String |
参数解释: 工作项的标题。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
order |
Order object |
参数解释: 排序信息。 取值范围: 不涉及。 |
author |
AuthorVO object |
参数解释: 用户信息。 取值范围: 不涉及。 |
due_date |
String |
参数解释: 工作项的截止时间。时间戳格式(示例:1839340800000)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
root_id |
Integer |
参数解释: 根工作项的id。 取值范围: 不涉及。 |
created_on |
String |
参数解释: 工作项的创建时间。时间戳格式(示例:1839340800000)。 取值范围: 不涉及。 |
updated_on |
String |
参数解释: 工作项的更新日期。时间戳格式(示例:1839340800000) 。 取值范围: 不涉及。 |
done_ratio |
Integer |
参数解释: 工作项完成度。 取值范围: 不涉及。 |
description |
String |
参数解释: 工作项的描述。 取值范围: 不涉及。 |
expected_work_hours |
Integer |
参数解释: 工作项的预计工时(单位:人/时)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
actual_work_hours |
Integer |
参数解释: 工作项的实际工时(单位:人/时)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
position |
String |
参数解释: 状态在页面的位置id 取值范围: 不涉及。 |
releaseDev |
String |
参数解释: 工作项发布版本号。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
developer |
developerVO object |
参数解释: 工作项开发者。 取值范围: 不涉及。 |
closed_flag |
Integer |
参数解释: 关闭标志。 取值范围: 0(打开) 1(关闭) |
deleted |
Boolean |
参数解释: 是否删除。 取值范围: true(删除) false(不删除) |
is_archived |
Boolean |
参数解释: 归档状态。 取值范围: true(已归档)。 false(未归档)。 |
status_attribute |
StatusAttributeVO object |
参数解释: 工作项的状态属性。 取值范围: 不涉及。 |
customValueNew |
Object |
参数解释: 自定义字段。 取值范围: 不涉及。 |
is_watcher |
Boolean |
参数解释: 是否关注。 取值范围: true(关注)。 false(不关注)。 |
children |
Array of strings |
参数解释: 子工作项。 取值范围: 不涉及。 |
project |
Project object |
参数解释: 项目信息。 取值范围: 不涉及。 |
tracker |
Tracker object |
参数解释: 工作项类型。 取值范围: 不涉及。 |
status |
Status object |
参数解释: 工作项状态。 取值范围: 不涉及。 |
assigned_to |
IssueAssignedTo object |
参数解释: 工作项分配责任人。 取值范围: 不涉及。 |
priority |
Priority object |
参数解释: 工作项优先级。 取值范围: 不涉及。 |
severity |
Severity object |
参数解释: 工作项重要程度。 取值范围: 不涉及。 |
module |
ModulesVO object |
参数解释: 工作项模块。 取值范围: 不涉及。 |
fixed_version |
FixedVersion object |
参数解释: 工作项修复版本。 取值范围: 不涉及。 |
story_point |
story_point object |
参数解释: 工作项故事点。 取值范围: 不涉及。 |
assigned_cc_user |
Array of AssignedCcUser objects |
参数解释: 工作项的抄送人。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
firstName |
String |
参数解释: 用户名称。 取值范围: 不涉及。 |
lastName |
String |
参数解释: 用户姓名。 取值范围: 不涉及。 |
identifier |
String |
参数解释: 作者唯一标识。 取值范围: 不涉及。 |
imageId |
String |
参数解释: 用户头像id。 取值范围: 不涉及。 |
assignedNickName |
String |
参数解释: 用户昵称。 取值范围: 不涉及。 |
name |
String |
参数解释: 带租户信息的用户名(租户名称_用户名)。 取值范围: 不涉及。 |
id |
Integer |
参数解释: 用户id。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
firstName |
String |
参数解释: 开发者名称。 取值范围: 不涉及。 |
lastName |
String |
参数解释: 开发者姓名。 取值范围: 不涉及。 |
identifier |
String |
参数解释: 开发者唯一标识。 取值范围: 不涉及。 |
imageId |
String |
参数解释: 开发者头像id。 取值范围: 不涉及。 |
assignedNickName |
String |
参数解释: 开发者昵称。 取值范围: 不涉及。 |
name |
String |
参数解释: 带租户信息的用户名(租户名称_用户名)。 取值范围: 不涉及。 |
id |
Integer |
参数解释: 开发者id。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
identifier |
String |
参数解释: 项目uuid。 取值范围: 不涉及。 |
name |
String |
参数解释: 项目名称。 取值范围: 不涉及。 |
id |
Integer |
参数解释: 项目数字id。 取值范围: 不涉及。 |
type |
String |
参数解释: 项目类型。 取值范围: scrum。 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
参数解释: 类型名称。 取值范围: Task。 Bug。 Epic。 Feature。 Story。 |
id |
Integer |
参数解释: 类型id。 取值范围: 2(任务/Task) 3(缺陷/Bug) 5(Epic) 6(Feature) 7(Story) |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
参数解释: 状态名称 取值范围: 新建 进行中 已解决 测试中 已关闭 已拒绝 |
id |
Integer |
参数解释: 状态id。 取值范围: 1(新建) 2(进行中) 3(已解决) 4(测试中) 5( 已关闭) 6(已拒绝) |
参数 |
参数类型 |
描述 |
---|---|---|
firstName |
String |
参数解释: 用户名。 取值范围: 不涉及。 |
lastName |
String |
参数解释: 用户姓名。 取值范围: 不涉及。 |
identifier |
String |
参数解释: 用户32位uuid。 取值范围: 不涉及。 |
imageId |
String |
参数解释: 用户头像id。 取值范围: 不涉及。 |
assignedNickName |
String |
参数解释: 用户昵称。 取值范围: 不涉及。 |
name |
String |
参数解释: 用户名。 取值范围: 不涉及。 |
id |
Integer |
参数解释: 用户数字id。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
参数解释: 工作项的优先级。 取值范围: 低。 中。 高。 |
id |
Integer |
参数解释: 优先级id 。 取值范围: 1(低) 2(中) 3(高) |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
参数解释: 工作项的重要程度。 取值范围: 关键 重要 一般 提示 |
id |
Integer |
参数解释: 重要程度id。 取值范围: 10 (关键) 11 (重要) 12 (一般) 13 (提示) |
参数 |
参数类型 |
描述 |
---|---|---|
path |
String |
参数解释: 模块的路径。 取值范围: 不涉及。 |
name |
String |
参数解释: 模块的名称。 取值范围: 不涉及。 |
id |
Integer |
参数解释: 模块的id。 取值范围: 不涉及。 |
path_name |
String |
参数解释: 模块路径的名称。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
参数解释: 修复版本名称。 取值范围: 不涉及。 |
id |
Integer |
参数解释: 修复版本id。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
Integer |
参数解释: 工作项的故事点id。 约束限制: 不涉及。 取值范围: 1(0) 2(1/2) 3(1) 4(2) 5(3) 6(5) 7(8) 8(13) 9(21) 10(40) 11(80) 12(100) 默认取值: 不涉及。 |
name |
String |
参数解释: 工作项的故事点名称。 约束限制: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
Integer |
参数解释: 用户id。 取值范围: 不涉及。 |
login |
String |
参数解释: 用户登录名。 取值范围: 不涉及。 |
firstname |
String |
参数解释: 用户名。 取值范围: 不涉及。 |
lastname |
String |
参数解释: 用户姓。 取值范围: 不涉及。 |
userName |
String |
参数解释: 用户姓名。 取值范围: 不涉及。 |
admin |
Integer |
参数解释: 管理员。 取值范围: 不涉及。 |
status |
Integer |
参数解释: 状态属性。 取值范围: 0(开始态)。 1(进行态)。 2(结束态)。 |
createdOn |
String |
参数解释: 创建时间。 取值范围: 不涉及。 |
domainId |
String |
参数解释: 租户uuid。 取值范围: 不涉及。 |
domainName |
String |
参数解释: 租户名。 取值范围: 不涉及。 |
identifier |
String |
参数解释: 用户32位uuid。 取值范围: 不涉及。 |
nickName |
String |
参数解释: 用户昵称。 取值范围: 不涉及。 |
请求示例
POST https://{endpoint}/v2/issues/quick_issue?_=1755746286116 { "subject": "xxxx", "assigned_to_id": 0000, "tracker_id": 2, "projectUUId": "xxxxxxxxxxxxxxxxx", "parent_issue_id": 0000000, "fixed_version_id": 000000000 }
响应示例
状态码:200
快速新建子工作项口接口成功的响应。
{ "result": { "issue": { "id": 00000000, "region": "xxxxxxxx", "projectUUId": "xxxxxxxx", "subject": "xxxxxxxx", "order": { "name": 1, "id": 1 }, "author": { "firstName": "xxxxxxxx", "lastName": "xxxxxxxx", "identifier": "xxxxxxxx", "imageId": "photo.png", "author_nickname": "xxxxx", "name": "xxxxxxxx", "last_name": "xxxxxxxx", "id": 000, "image_id": "photo.png", "first_name": "xxxxxxxxxx", "authorNickName": "xxxxxxx" }, "root_id": 00000000, "description": "test", "expected_work_hours": 0, "position": "00000000", "releaseDev": "", "closed_flag": 0, "deleted": false, "project": { "identifier": "xxxxxxxx", "name": "xxxxxxxx", "id": 0000000, "type": "scrum" }, "tracker": { "name": "Task", "id": 2 }, "status": { "name": "xxx", "id": 1 }, "assigned_to": { "assigned_nickname": "xxxxxxxxxx", "firstName": "xxxxxxxxxxxxxxxxxx", "lastName": "xxxxxxxxxxxxxxxxxx, "identifier": "xxxxxxxxxxxxxxxxxx", "imageId": "photo.png", "assignedNickName": "xxxxx", "name": "xxxxxxxxxxxxxxxxxx", "last_name": "xxxxxxxxxxxxxxxxxx", "id": 4091, "image_id": "photo.png", "first_name": "xxxxxxxxxxxxxxxxxx" }, "developer": {}, "priority": { "name": "中", "id": 2 }, "severity": { "name": "一般", "id": 12 }, "module": {}, "fixed_version": { "name": "xxxxxxx", "id": 000000000 }, "story_point_id": {}, "assigned_cc_user": [], "created_on": "000000000", "updated_on": "000000000", "actual_work_hours": 0.0, "done_ratio": 0, "release_dev": "" } }, "status": "success" }
状态码
状态码 |
描述 |
---|---|
200 |
快速新建子工作项口接口成功的响应。 |
错误码
请参见错误码。