文档首页/ 需求管理 CodeArts Req/ API参考/ API/ Scrum项目的工作项/ 细粒度权限用户创建工作项
更新时间:2024-11-19 GMT+08:00
分享

细粒度权限用户创建工作项

功能介绍

拥有IAM细粒度权限(projectmanConfig:systemSettingField:set)且在devcloud项目中有创建工作项的权限的用户可以设置工作项的创建者

调用方法

请参见如何调用API

URI

POST /v4/projects/{project_id}/system/issue

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

devcloud项目的32位id

最小长度:32

最大长度:32

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:10

最大长度:32768

表3 请求Body参数

参数

是否必选

参数类型

描述

actual_work_hours

Double

实际工时

assigned_id

Integer

处理人id,对应用户信息的数字id

begin_time

String

开始时间,年-月-日

description

String

描述信息

developer_id

Integer

开发者id,对应用户信息的数字id

domain_id

Integer

id 领域, 14 '性能', 15 '功能', 16 '可靠性' 17 '网络安全' 18 '可维护性' 19 '其他DFX' 20 '可用性'

done_ratio

Integer

工作项进度值

end_time

String

结束时间,年-月-日

expected_work_hours

Double

预计工时

iteration_id

Integer

迭代id

module_id

Integer

模块id

name

String

标题

parent_issue_id

Integer

父工作项的id,创建子工作项时必填,父工作项的类型tracker_id不能为2,3

priority_id

Integer

优先级, 1 低, 2 中, 3 高,

severity_id

Integer

重要程度, 10 关键, 11 重要, 12 一般, 13 提示,

status_id

Integer

状态 id, 新建 1, 进行中 2, 已解决 3, 测试中 4, 已关闭 5, 已拒绝 6,

tracker_id

Integer

工作项类型, 2任务/Task,3缺陷/Bug,5Epic,6Feature,7Story; 5 只能为 6 的父工作项类型; 6 只能为 7 的父工作项类型; 7 只能为 2,3的父;

new_custom_fields

Array of NewCustomField objects

用户自定义字段

creator

Creator object

创建者

custom_fields

Array of ScrumCustomField objects

用户自定义字段

表4 NewCustomField

参数

是否必选

参数类型

描述

custom_field

String

自定义字段

field_name

String

自定义字段名称

value

String

自定义属性对应的值,多个值以英文逗号区分开

表5 Creator

参数

是否必选

参数类型

描述

user_id

String

指定工作项的创建者用户id

表6 ScrumCustomField

参数

是否必选

参数类型

描述

name

String

自定义字段

value

String

自定义字段值

响应参数

状态码: 200

表7 响应Body参数

参数

参数类型

描述

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

工作项优先级

severity

severity object

工作项重要程度

status

status object

工作项状态

tracker

tracker object

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

表8 IssueUser

参数

参数类型

描述

user_id

String

用户uuid

user_num_id

Integer

用户数字id

id

Integer

用户id

name

String

用户名

nick_name

String

昵称

表9 CustomField

参数

参数类型

描述

name

String

自定义属性名

value

String

自定义属性对应的值

new_name

String

自定义属性名

表10 NewCustomField

参数

参数类型

描述

custom_field

String

自定义字段

field_name

String

自定义字段名称

value

String

自定义属性对应的值,多个值以英文逗号区分开

表11 domain

参数

参数类型

描述

id

Integer

领域id

name

String

领域

表12 IssueProjectResponseV4

参数

参数类型

描述

project_id

String

项目id

project_name

String

项目名称

project_num_id

Integer

项目数字id

表13 iteration

参数

参数类型

描述

id

Integer

迭代id

name

String

迭代名

表14 module

参数

参数类型

描述

id

Integer

模块id

name

String

模块

表15 parent_issue

参数

参数类型

描述

id

Integer

父工作项id

name

String

父工作项

表16 priority

参数

参数类型

描述

id

Integer

优先级id

name

String

优先级

表17 severity

参数

参数类型

描述

id

Integer

重要程度id

name

String

重要程度

表18 status

参数

参数类型

描述

id

Integer

状态id

name

String

状态名称

表19 tracker

参数

参数类型

描述

id

Integer

类型id

name

String

类型名称

状态码: 400

表20 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

状态码: 401

表21 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

请求示例

POST https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/system/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,
  "creator" : {
    "user_id" : "a360371833bf4c558f796fd707b44daf"
  }
}

响应示例

状态码: 200

OK

{
  "actual_work_hours" : 0,
  "assigned_cc_user" : [ {
    "id" : 4091,
    "name" : "demo_user_name",
    "nick_name" : "bear"
  } ],
  "assigned_user" : {
    "id" : 4091,
    "name" : "demo_user_name",
    "nick_name" : "bear"
  },
  "begin_time" : "2020-09-12",
  "creator" : {
    "id" : 4091,
    "name" : "demo_user_name",
    "nick_name" : "bear"
  },
  "custom_fields" : [ {
    "name" : "customField16",
    "value" : "多选框",
    "new_name" : "custom_field16"
  } ],
  "new_custom_fields" : [ {
    "custom_field" : "custom_field16",
    "field_name" : "field_name",
    "value" : "多选框1,多选框2"
  } ],
  "developer" : {
    "id" : 4091,
    "name" : "demo_user_name",
    "nick_name" : "bear1"
  },
  "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" : "迭代1"
  },
  "module" : {
    "id" : 456,
    "name" : "Project"
  },
  "parent_issue" : {
    "id" : 123,
    "name" : "parentIssue"
  },
  "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
60
61
62
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 CreateSystemIssueV4Solution {

    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();
        CreateSystemIssueV4Request request = new CreateSystemIssueV4Request();
        CreateSystemIssueRequestV4 body = new CreateSystemIssueRequestV4();
        Creator creatorbody = new Creator();
        creatorbody.withUserId("a360371833bf4c558f796fd707b44daf");
        body.withAssignedId(4091);
        body.withDeveloperId(4091);
        body.withSeverityId(10);
        body.withParentIssueId(1679822);
        body.withName("test");
        body.withTrackerId(3);
        body.withStatusId(1);
        body.withPriorityId(2);
        body.withIterationId(11302238);
        body.withDescription("");
        body.withBeginTime("2018-1-31");
        body.withEndTime("2018-07-05");
        body.withCreator(creatorbody);
        request.withBody(body);
        try {
            CreateSystemIssueV4Response response = client.createSystemIssueV4(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
44
45
46
47
# 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 = CreateSystemIssueV4Request()
        creatorbody = Creator(
            user_id="a360371833bf4c558f796fd707b44daf"
        )
        request.body = CreateSystemIssueRequestV4(
            assigned_id=4091,
            developer_id=4091,
            severity_id=10,
            parent_issue_id=1679822,
            name="test",
            tracker_id=3,
            status_id=1,
            priority_id=2,
            iteration_id=11302238,
            description="",
            begin_time="2018-1-31",
            end_time="2018-07-05",
            creator=creatorbody
        )
        response = client.create_system_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
59
60
61
62
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.CreateSystemIssueV4Request{}
	creatorbody := &model.Creator{
		UserId: "a360371833bf4c558f796fd707b44daf",
	}
	assignedIdCreateSystemIssueRequestV4:= int32(4091)
	developerIdCreateSystemIssueRequestV4:= int32(4091)
	severityIdCreateSystemIssueRequestV4:= int32(10)
	parentIssueIdCreateSystemIssueRequestV4:= int32(1679822)
	statusIdCreateSystemIssueRequestV4:= int32(1)
	iterationIdCreateSystemIssueRequestV4:= int32(11302238)
	descriptionCreateSystemIssueRequestV4:= ""
	beginTimeCreateSystemIssueRequestV4:= "2018-1-31"
	endTimeCreateSystemIssueRequestV4:= "2018-07-05"
	request.Body = &model.CreateSystemIssueRequestV4{
		AssignedId: &assignedIdCreateSystemIssueRequestV4,
		DeveloperId: &developerIdCreateSystemIssueRequestV4,
		SeverityId: &severityIdCreateSystemIssueRequestV4,
		ParentIssueId: &parentIssueIdCreateSystemIssueRequestV4,
		Name: "test",
		TrackerId: int32(3),
		StatusId: &statusIdCreateSystemIssueRequestV4,
		PriorityId: int32(2),
		IterationId: &iterationIdCreateSystemIssueRequestV4,
		Description: &descriptionCreateSystemIssueRequestV4,
		BeginTime: &beginTimeCreateSystemIssueRequestV4,
		EndTime: &endTimeCreateSystemIssueRequestV4,
		Creator: creatorbody,
	}
	response, err := client.CreateSystemIssueV4(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

错误码

请参见错误码

相关文档