创建工作项V3
功能介绍
创建工作项。
调用方法
请参见如何调用API。
URI
POST /v3/file/issue-create
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 最小长度:10,最大长度:32768。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
issue_call_back_param |
否 |
issue_call_back_param object |
参数解释: 工作项的请求参数。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
type |
否 |
String |
参数解释: 工作项的类型。 约束限制: 不涉及。 取值范围: scrum。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
status_id |
否 |
Integer |
参数解释: 状态id。 约束限制: 不涉及。 取值范围: 1(新建) 2(进行中) 3(已解决) 4(测试中) 5(已关闭) 6(已拒绝)。 默认取值: 不涉及。 |
subject |
否 |
String |
参数解释: 工作项的标题。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
description |
否 |
String |
参数解释: 工作项的描述。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 取值范围: 不涉及。 |
start_date |
否 |
String |
参数解释: 工作项的开始日期 。时间戳格式(示例:1839340800000)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
order |
否 |
Integer |
参数解释: 工作项的排序。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
priority_id |
否 |
Integer |
参数解释: 优先级id 。 约束限制: 不涉及。 取值范围: 1(低) 2(中) 3(高) 默认取值: 不涉及。 |
severity_id |
否 |
Integer |
参数解释: 重要程度id 。 约束限制: 不涉及。 取值范围: 10 (关键) 11 (重要) 12 (一般) 13 (提示) 默认取值: 不涉及。 |
release_dev |
否 |
String |
参数解释: 工作项发布版本号。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
expected_work_hours |
否 |
String |
参数解释: 工作项的预计工时(单位:人/时)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
story_point_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) 默认取值: 不涉及。 |
due_date |
否 |
String |
参数解释: 工作项的截止时间。时间戳格式(示例:1839340800000)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
assigned_cc |
否 |
String |
参数解释: 分配的抄送人。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
assigned_to_id |
否 |
Integer |
参数解释: 模块的负责人数字id,通过获取指定项目的成员用户列表接口获取,响应消息体中的user_num_id字段的值就是模块的负责人数字id。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
project_uuid |
否 |
String |
参数解释: 项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 32位的数字和字母组成的字符串。 取值范围: 不涉及。 默认取值: 不涉及。 |
project_id |
否 |
String |
参数解释: 项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 32位的数字和字母组成的字符串。 取值范围: 不涉及。 默认取值: 不涉及。 |
tracker_id |
否 |
Integer |
参数解释: 工作项类型。 约束限制: 不涉及。 取值范围: 2(任务/Task) 3(缺陷/Bug) 5(Epic) 6(Feature) 7(Story) 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
result |
result object |
参数解释: 返回结果。 取值范围: 不涉及。 |
status |
String |
参数解释: 返回状态。 取值范围: success:返回成功。 error:返回失败。 |
参数 |
参数类型 |
描述 |
---|---|---|
updated_on |
String |
参数解释: 工作项的更新日期。时间戳格式(示例:1839340800000) 。 取值范围: 不涉及。 |
story_point |
StoryPoint object |
参数解释: 工作项的故事点。 取值范围: 不涉及。 |
subject |
String |
参数解释: 工作项的负责者。 取值范围: 不涉及。 |
project |
Project object |
参数解释: 项目。 取值范围: 不涉及。 |
is_parent |
Boolean |
参数解释: 是否有子工作项。 取值范围: true(有子工作项) false(没有子工作项) |
done_ratio |
Integer |
参数解释: 工作项完成度。 取值范围: 不涉及。 |
findReleaseDev |
String |
参数解释: 发布人 。 取值范围: 不涉及。 |
tracker |
Tracker object |
参数解释: 工作项的类型。 取值范围: 不涉及。 |
id |
Integer |
参数解释: 工作项列表id。 取值范围: 不涉及。 |
start_date |
String |
参数解释: 工作项的开始日期。时间戳格式(示例:1839340800000)。 取值范围: 不涉及。 |
assigned_to |
IssueAssignedVO object |
参数解释: 工作项责任人。 取值范围: 不涉及。 |
status_attribute |
Object |
参数解释: 工作项的状态属性。 取值范围: 不涉及。 |
severity |
Severity object |
参数解释: 重要程度。 取值范围: 不涉及。 |
releaseDev |
String |
参数解释: 工作项发布版本号。 取值范围: 不涉及。 |
author |
IssueAuthorVO object |
参数解释: 工作项负责人。 取值范围: 不涉及。 |
module |
Object |
参数解释: 工作项的模块。 取值范围: 不涉及。 |
due_date |
String |
参数解释: 工作项的截止日期,时间戳格式(示例:1839340800000)。 取值范围: 不涉及。 |
expected_work_hours |
Integer |
参数解释: 工作项的预计工时(单位:人时)。 取值范围: 不涉及。 |
priority |
Priority object |
参数解释: 优先级。 取值范围: 不涉及。 |
actual_work_hours |
Integer |
参数解释: 工作项的实际工时(单位:人/时)。 取值范围: 不涉及。 |
is_watcher |
Boolean |
参数解释: 是否关注 。 取值范围: true(是) false(不是) |
deleted |
Boolean |
参数解释: 是否删除 。 取值范围: true(是) false(不是) |
fixed_version |
Object |
参数解释: 问题解决版本。 取值范围: 不涉及。 |
is_archived |
Boolean |
参数解释: 是否归档。 取值范围: true(是) false(不是) |
created_on |
String |
参数解释: 工作项的创建时间,时间戳格式(示例:1839340800000)。 取值范围: 不涉及。 |
domain |
Object |
参数解释: 工作项的领域 。 取值范围: 不涉及。 |
developer |
Object |
参数解释: 工作项的开发人员。 取值范围: 不涉及。 |
closeder |
Object |
参数解释: 关闭人员。 取值范围: 不涉及。 |
position |
String |
参数解释: 工作项在列表的展示位置 。 取值范围: 不涉及。 |
closed_flag |
Integer |
参数解释: 关闭标志 。 取值范围: 0(打开) 1(关闭) |
assigned_cc_user |
String |
参数解释: 工作项的抄送人。 取值范围: 不涉及。 |
custom_value_new |
Object |
参数解释: 自定义字段。 取值范围: 不涉及。 |
status |
Status object |
参数解释: 工作项的状态。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
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) |
参数 |
参数类型 |
描述 |
---|---|---|
first_name |
String |
参数解释: 用户名。 取值范围: 不涉及。 |
last_name |
String |
参数解释: 用户姓名。 取值范围: 不涉及。 |
identifier |
String |
参数解释: 用户32位uuid。 取值范围: 不涉及。 |
image_id |
String |
参数解释: 用户头像id。 取值范围: 不涉及。 |
assigned_nick_name |
String |
参数解释: 用户昵称。 取值范围: 不涉及。 |
name |
String |
参数解释: 用户名。 取值范围: 不涉及。 |
id |
Integer |
参数解释: 用户数字id。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
参数解释: 工作项的重要程度。 取值范围: 关键 重要 一般 提示 |
id |
Integer |
参数解释: 重要程度id。 取值范围: 10 (关键) 11 (重要) 12 (一般) 13 (提示) |
参数 |
参数类型 |
描述 |
---|---|---|
first_name |
String |
参数解释: 用户名称。 取值范围: 不涉及。 |
last_name |
String |
参数解释: 用户姓名。 取值范围: 不涉及。 |
identifier |
String |
参数解释: 作者唯一标识。 取值范围: 不涉及。 |
image_id |
String |
参数解释: 用户头像id。 取值范围: 不涉及。 |
assigned_nick_name |
String |
参数解释: 用户昵称。 取值范围: 不涉及。 |
name |
String |
参数解释: 带租户信息的用户名(租户名称_用户名)。 取值范围: 不涉及。 |
id |
Integer |
参数解释: 用户id。 取值范围: 不涉及。 |
请求示例
{endpoint}/v3/file/issue-create?_=1753359298572 { "issue_call_back_param" : { "status_id" : 1, "subject" : "123", "description" : "<p style=\"padding-top: 5.0px;\"><span style=\"font-weight: bold;\"> 作为 </span><用户角色></p><p><br /></p><p style=\"padding-top: 5.0px;\"><span style=\"font-weight: bold;\"> 我想要 </span><结果></p><p><br /></p><p style=\"padding-top: 5.0px;\"><span style=\"font-weight: bold;\"> 以便于 </span><目的> </p>", "start_date" : null, "order" : 1, "priority_id" : 2, "severity_id" : 12, "release_dev" : "", "expected_work_hours" : "0", "story_point_id" : 3, "due_date" : null, "assigned_cc" : "", "assigned_to_id" : 4091, "project_uuid" : "5192de5eb435430c8cd41c6ae6028848", "project_id" : "5192de5eb435430c8cd41c6ae6028848", "tracker_id" : 7 }, "type" : "create" }
响应示例
状态码:200
创建工作项接口成功的响应。
{ "result" : { "issue" : { "id" : 9190894, "subject" : "123", "author" : { "identifier" : "a360371833bf4c558f796fd707b44daf", "name" : "devcloud_devcloud_s00404480_01", "last_name" : 4091, "id" : 4091, "image_id" : 4091, "first_name" : 4091 }, "done_ratio" : 0, "expected_work_hours" : 0, "actual_work_hours" : 0, "position" : "9190894", "closed_flag" : 0, "deleted" : false, "custom_value_new" : { }, "project" : { "identifier" : "5192de5eb435430c8cd41c6ae6028848", "name" : "DevOps全流程示例项目XXXX", "id" : 35138974, "type" : "scrum" }, "tracker" : { "name" : "Story", "id" : 7 }, "status" : { "name" : "新建", "id" : 1 }, "assigned_to" : { "identifier" : "a360371833bf4c558f796fd707b44daf", "assigned_nick_name" : "张三丰1", "name" : "devcloud_devcloud_s00404480_01", "last_name" : "devcloud_devcloud_s00404480_01", "id" : 4091, "image_id" : "photo01.png", "first_name" : "devcloud_devcloud_s00404480_01" }, "developer" : { }, "priority" : { "name" : "中", "id" : 2 }, "severity" : { "name" : "一般", "id" : 12 }, "module" : { }, "fixed_version" : { }, "story_point" : { "id" : 3, "name" : "1" }, "assigned_cc_user" : [ null ] } }, "status" : "success" }
状态码
状态码 |
描述 |
---|---|
200 |
创建工作项接口成功的响应。 |
错误码
请参见错误码。