创建工作项
功能介绍
创建工作项
调用方法
请参见如何调用API。
URI
POST /v4/projects/{project_id}/issue
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释:项目的32位uuid,项目唯一标识,可以通过ListProjectsV4接口查询项目列表 约束限制:正则表达式, ^[A-Za-z0-9]{32}$ 取值范围:字符串,最小长度:32,最大长度:32 默认取值:不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释:用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制:不涉及 取值范围:最小长度:10,最大长度:32768 默认取值:不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
actual_work_hours |
否 |
Double |
参数解释:实际工时,实际工时由详细工时自动累加和子工作项自动卷积计算 约束限制:不涉及 取值范围:最小长度:0 默认取值:不涉及 |
assigned_id |
否 |
Integer |
参数解释:处理人数字id,可通过ListProjectMembersV4接口获取指定项目的成员用户列表,确认特定项目成员的用户数字id 约束限制:正则表达式,^\d+$ 取值范围:最小值 0 默认取值:不涉及 |
begin_time |
否 |
String |
参数解释:开始时间,年-月-日 约束限制:正则表达式,^[1-9]\d{3}-(0?[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$ 取值范围:匹配格式为 YYYY-MM-DD 的日期字符串,MM 是两位数的月份限制取值01-12,DD是两位数的日期限制取值01-31 默认取值:不涉及 |
description |
否 |
String |
参数解释:工作项描述 约束限制:可以为空 取值范围:最小长度 0 默认取值:不涉及 |
developer_id |
否 |
Integer |
参数解释:开发人员数字id,可通过ListProjectMembersV4接口获取指定项目的成员用户列表,确认特定项目成员的用户数字id 约束限制:正则表达式,^\d+$ 取值范围:最小值 0 默认取值:不涉及 |
domain_id |
否 |
Integer |
参数解释:领域id, 14 '性能', 15 '功能', 16 '可靠性' 17 '网络安全' 18 '可维护性' 19 '其他DFX' 20 '可用性' 约束限制:正则表达式,^\d+$ 取值范围:最小值 14 最大值 20 默认取值:不涉及 |
done_ratio |
否 |
Integer |
参数解释:工作项完成度 约束限制:0 '0%'(输入数字0代表完成度为0%的工作项), 10 '10%', 20 '20%' , 30 '30%', 40 '40%', 50 '50%', 60 '60%', 70 '70%' 80 '80%', 90 '90%', 100 '100%' 取值范围:最小值 0 最大值 100 默认取值:不涉及 |
end_time |
否 |
String |
参数解释:结束时间,年-月-日 约束限制:正则表达式,^[1-9]\d{3}-(0?[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$ 取值范围:匹配格式为 YYYY-MM-DD 的日期字符串,MM 是两位数的月份限制取值01-12,DD是两位数的日期限制取值01-31 默认取值:不涉及 |
expected_work_hours |
否 |
Double |
参数解释:预计工时 约束限制:可以为空 取值范围:最小长度 0 默认取值:不涉及 |
iteration_id |
否 |
Integer |
参数解释:迭代id,可通过ListProjectIterationsV4接口获取指定项目的迭代列表 约束限制:正则表达式,^\d+$ 取值范围:最小长度 0 默认取值:不涉及 |
module_id |
否 |
Integer |
参数解释:模块id, 设置-工作项设置-模块设置内用户可新建模块 约束限制:正则表达式,^\d+$ 取值范围:最小长度 0 默认取值:不涉及 |
name |
是 |
String |
参数解释:标题 约束限制:可以为空 取值范围:最小长度 0 默认取值:不涉及 |
parent_issue_id |
否 |
Integer |
参数解释:父工作项的id 约束限制:创建子工作项时必填,父工作项的类型tracker_id不能为2 Task, 3 Bug 取值范围:最小长度 0 默认取值:不涉及 |
priority_id |
是 |
Integer |
参数解释: 优先级, 约束限制:正则表达式,^\d+$ 取值范围:1 低, 2 中, 3 高, 默认取值:不涉及 |
severity_id |
否 |
Integer |
参数解释: 重要程度, 约束限制:正则表达式,^\d+$ 取值范围:10 关键, 11 重要, 12 一般, 13 提示, 默认取值:不涉及 |
status_id |
否 |
Integer |
参数解释: 状态id, 约束限制:正则表达式,^\d+$ 取值范围:新建 1, 进行中 2, 已解决 3, 测试中 4, 已关闭 5, 已拒绝 6 默认取值:不涉及 |
tracker_id |
是 |
Integer |
参数解释: 工作项类型, 约束限制:Epic只能为 Feature的父工作项类型; Feature只能为Story的父工作项类型; Story只能为任务/Task,3缺陷/Bug的父; 取值范围:2任务/Task,3缺陷/Bug,5Epic,6Feature,7Story; 默认取值:不涉及 |
new_custom_fields |
否 |
Array of NewCustomField objects |
参数解释: 用户自定义字段,可以通过ListIssueCustomFields查询Scrum工作项自定义字段 约束限制:不涉及 取值范围:不涉及 默认取值:不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
custom_field |
否 |
String |
参数解释: 自定义字段,可以通过ListIssueCustomFields查询Scrum工作项自定义字段中返回的custom_field值获取 约束限制:可以为空 取值范围:不涉及 默认取值:不涉及 |
field_name |
否 |
String |
参数解释: 自定义字段页面显示的含义, 可以通过ListIssueCustomFields查询Scrum工作项自定义字段中返回的name值获取 约束限制:可以为空 取值范围:不涉及 默认取值:不涉及 |
value |
否 |
String |
参数解释: 自定义属性对应的值,多个值以英文逗号区分开, 可以通过ListIssueCustomFields查询Scrum工作项自定义字段中返回的options值获取 约束限制:可以为空 取值范围:不涉及 默认取值:不涉及 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
actual_work_hours |
Double |
实际工时 |
assigned_cc_user |
Array of IssueUser objects |
抄送人 |
assigned_user |
IssueUser object |
处理人 |
begin_time |
String |
开始时间,年-月-日 |
creator |
IssueUser object |
创建人 |
custom_fields |
Array of CustomField objects |
自定义属性值,不建议使用,建议参考new_custom_fields字段 |
new_custom_fields |
Array of NewCustomField objects |
自定义属性值 |
developer |
IssueUser object |
开发人员 |
domain |
domain object |
id 领域, 14 '性能', 15 '功能', 16 '可靠性', 17 '网络安全', 18 '可维护性', 19 '其他DFX', 20 '可用性', |
done_ratio |
Integer |
工作项完成度 |
end_time |
String |
结束时间,年-月-日 |
expected_work_hours |
Double |
预计工时 |
id |
Integer |
工作项id |
project |
IssueProjectResponseV4 object |
工作项所属项目信息 |
iteration |
iteration object |
迭代 |
module |
module object |
模块 |
parent_issue |
parent_issue object |
父工作项信息 |
priority |
priority object |
工作项优先级,1 '低',2 '中',3 '高' |
severity |
severity object |
工作项重要程度 |
status |
status object |
工作项状态 |
tracker |
tracker object |
工作项类型 2任务/Task,3缺陷/Bug,5Epic,6Feature,7Story |
参数 |
参数类型 |
描述 |
---|---|---|
user_id |
String |
用户32位uuid,用户唯一标识,需要通过IAM获取 |
user_num_id |
Integer |
用户数字id |
id |
Integer |
用户id |
name |
String |
用户名 |
nick_name |
String |
用户昵称 |
参数 |
参数类型 |
描述 |
---|---|---|
custom_field |
String |
自定义字段 |
field_name |
String |
自定义字段名称 |
value |
String |
自定义字段对应的值,多个值以英文逗号区分开 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
Integer |
领域id,14 '性能', 15 '功能', 16 '可靠性', 17 '网络安全', 18 '可维护性', 19 '其他DFX', 20 '可用性', |
name |
String |
领域, '性能', '功能', '可靠性', '网络安全', '可维护性', '其他DFX', '可用性', |
参数 |
参数类型 |
描述 |
---|---|---|
project_id |
String |
项目32位uuid,项目唯一标识 |
project_name |
String |
项目名称 |
project_num_id |
Integer |
项目数字id |
参数 |
参数类型 |
描述 |
---|---|---|
id |
Integer |
重要程度id,10 关键, 11 重要, 12 一般, 13 提示 |
name |
String |
重要程度,关键, 重要, 一般, 提示 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
Integer |
状态id,新建 1, 进行中 2, 已解决 3, 测试中 4, 已关闭 5, 已拒绝 6, |
name |
String |
状态名称,新建,进行中,已解决, 测试中, 已关闭, 已拒绝 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
Integer |
工作项类型id, 2任务/Task,3缺陷/Bug,5Epic,6Feature,7Story |
name |
String |
工作项类型名称,任务/Task, 缺陷/Bug, Epic, Feature, Story |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误描述 |
error_code |
String |
错误码 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误描述 |
error_code |
String |
错误码 |
请求示例
POST https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/issue { "parent_issue_id" : 1679822, "end_time" : "2018-07-05", "name" : "test", "begin_time" : "2018-1-31", "description" : "", "assigned_id" : 4091, "developer_id" : 4091, "tracker_id" : 3, "status_id" : 1, "priority_id" : 2, "severity_id" : 10, "iteration_id" : 11302238 }
响应示例
状态码: 200
OK
{ "actual_work_hours" : 0, "assigned_cc_user" : [ { "id" : 4091, "name" : "user_name_demo", "nick_name" : "nick_name_demo" } ], "assigned_user" : { "id" : 4091, "name" : "user_name_demo", "nick_name" : "nick_name_demo" }, "begin_time" : "2020-09-12", "creator" : { "id" : 4091, "name" : "user_name_demo", "nick_name" : "nick_name_demo" }, "custom_fields" : [ { "name" : "customField16", "value" : "多选框", "new_name" : "custom_field16" } ], "new_custom_fields" : [ { "custom_field" : "custom_field16", "field_name" : "field_name", "value" : "select1,select2" } ], "developer" : { "id" : 4091, "name" : "user_name_demo", "nick_name" : "nick_name_demo" }, "domain" : { "id" : 14, "name" : "性能" }, "done_ratio" : 0, "end_time" : "2020-09-19", "expected_work_hours" : 9, "id" : 4567, "project" : { "project_id" : "526cefde62004de2b62b5e8dd2c2b3af", "project_name" : "testDemo", "project_num_id" : 78953 }, "iteration" : { "id" : 456, "name" : "iteration_1" }, "module" : { "id" : 456, "name" : "Project" }, "parent_issue" : { "id" : 123, "name" : "paren_issue_demo" }, "priority" : { "id" : 1, "name" : "低" }, "severity" : { "id" : 12, "name" : "一般" }, "status" : { "id" : 1, "name" : "新建" }, "tracker" : { "id" : 7, "name" : "story" } }
SDK代码示例
SDK代码示例如下。
Java
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.projectman.v4.region.ProjectManRegion; import com.huaweicloud.sdk.projectman.v4.*; import com.huaweicloud.sdk.projectman.v4.model.*; public class CreateIssueV4Solution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); ProjectManClient client = ProjectManClient.newBuilder() .withCredential(auth) .withRegion(ProjectManRegion.valueOf("<YOUR REGION>")) .build(); CreateIssueV4Request request = new CreateIssueV4Request(); CreateIssueRequestV4 body = new CreateIssueRequestV4(); body.withTrackerId(3); body.withStatusId(1); body.withSeverityId(10); body.withPriorityId(2); body.withParentIssueId(1679822); body.withName("test"); body.withIterationId(11302238); body.withEndTime("2018-07-05"); body.withDeveloperId(4091); body.withDescription(""); body.withBeginTime("2018-1-31"); body.withAssignedId(4091); request.withBody(body); try { CreateIssueV4Response response = client.createIssueV4(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 |
# coding: utf-8 from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkprojectman.v4.region.projectman_region import ProjectManRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkprojectman.v4 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = ProjectManClient.new_builder() \ .with_credentials(credentials) \ .with_region(ProjectManRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateIssueV4Request() request.body = CreateIssueRequestV4( tracker_id=3, status_id=1, severity_id=10, priority_id=2, parent_issue_id=1679822, name="test", iteration_id=11302238, end_time="2018-07-05", developer_id=4091, description="", begin_time="2018-1-31", assigned_id=4091 ) response = client.create_issue_v4(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" projectman "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := projectman.NewProjectManClient( projectman.ProjectManClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateIssueV4Request{} statusIdCreateIssueRequestV4:= int32(1) severityIdCreateIssueRequestV4:= int32(10) parentIssueIdCreateIssueRequestV4:= int32(1679822) iterationIdCreateIssueRequestV4:= int32(11302238) endTimeCreateIssueRequestV4:= "2018-07-05" developerIdCreateIssueRequestV4:= int32(4091) descriptionCreateIssueRequestV4:= "" beginTimeCreateIssueRequestV4:= "2018-1-31" assignedIdCreateIssueRequestV4:= int32(4091) request.Body = &model.CreateIssueRequestV4{ TrackerId: int32(3), StatusId: &statusIdCreateIssueRequestV4, SeverityId: &severityIdCreateIssueRequestV4, PriorityId: int32(2), ParentIssueId: &parentIssueIdCreateIssueRequestV4, Name: "test", IterationId: &iterationIdCreateIssueRequestV4, EndTime: &endTimeCreateIssueRequestV4, DeveloperId: &developerIdCreateIssueRequestV4, Description: &descriptionCreateIssueRequestV4, BeginTime: &beginTimeCreateIssueRequestV4, AssignedId: &assignedIdCreateIssueRequestV4, } response, err := client.CreateIssueV4(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
错误码
请参见错误码。