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

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

功能介绍

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

调用方法

请参见如何调用API

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
}

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
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 CreateCustomfieldsSolution {

    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();
        CreateCustomfieldsRequest request = new CreateCustomfieldsRequest();
        CreateCustomfieldV1Req body = new CreateCustomfieldV1Req();
        body.withScrumType("Story");
        body.withMemo("描述");
        body.withOptions("0792b7d26cb74bd799cbae80063dc74a");
        body.withType("text");
        body.withName("test");
        request.withBody(body);
        try {
            CreateCustomfieldsResponse response = client.createCustomfields(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
# 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 = CreateCustomfieldsRequest()
        request.body = CreateCustomfieldV1Req(
            scrum_type="Story",
            memo="描述",
            options="0792b7d26cb74bd799cbae80063dc74a",
            type="text",
            name="test"
        )
        response = client.create_customfields(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
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.CreateCustomfieldsRequest{}
	request.Body = &model.CreateCustomfieldV1Req{
		ScrumType: "Story",
		Memo: "描述",
		Options: "0792b7d26cb74bd799cbae80063dc74a",
		Type: "text",
		Name: "test",
	}
	response, err := client.CreateCustomfields(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

错误码

请参见错误码

分享:

    相关文档

    相关产品