创建工作项类型自定义字段
功能介绍
创建工作项类型自定义字段
调用方法
请参见如何调用API。
URI
POST /v3/{project_id}/custom-fields
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目的32位uuid,项目唯一标识,通过[查询项目列表]接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 正则表达式,[A-Za-z0-9]{32}。 取值范围: 不涉及 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
memo |
是 |
String |
参数解释: 自定义字段描述 约束限制: 不涉及 取值范围: 最小长度:0,最大长度:255 默认取值: 不涉及 |
name |
是 |
String |
参数解释: 自定义字段名称 约束限制: 正则表达式:[a-zA-Z0-9\u4E00-\u9FA5-_]{1,15}。 取值范围: 最小长度:1,最大长度:15 默认取值: 不涉及 |
options |
是 |
String |
参数解释: 自定义字段类型 约束限制: 正则表达式,[\s\S]{1,6000}。 取值范围: 最小长度:1,最大长度:6000 默认取值: 不涉及 |
scrum_type |
是 |
String |
参数解释: 当前新建的自定义字段应用的工作项类型 约束限制: 正则表达式,(Epic|Feature|Story|Task|Bug)。 取值范围: 最小长度:0,最大长度:7 默认取值: 不涉及 |
type |
是 |
String |
参数解释: 自定义字段类型 约束限制: 正则表达式,(textArea|select|radio|text|checkbox|date|time_date|number)。 对应参数解释: textArea(多行文本) select(下拉框) radio(单选框,text 单行文本) checkbox(多选框) date(日期) time_date(日期:包含时分,包含时分的日期类型的字段显示格式为:2019/10/10 10:10) number(数字) 取值范围: 最小长度:0,最大长度:7 默认取值: 不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
created |
String |
参数解释: 创建时间 取值范围: 不涉及 |
custom_field |
String |
参数解释: 系统字段 取值范围: 不涉及 |
id |
Integer |
参数解释: 字段ID 取值范围: 不涉及 |
identifier |
String |
参数解释: 字段ID 取值范围: 不涉及 |
is_delete |
Boolean |
参数解释: 是否被删除 取值范围: true,false |
memo |
String |
参数解释: 字段描述 取值范围: 最小长度:0,最大长度:255 |
modified |
String |
参数解释: 修改时间 取值范围: 不涉及 |
name |
String |
字段名称参数解释: 字段名称 取值范围: 最小长度:1,最大长度:15 |
options |
String |
参数解释: 字段选项 取值范围: 最小长度:1,最大长度:6000 |
project_id |
Integer |
参数解释: 项目ID 取值范围: 不涉及 |
region |
String |
参数解释: 区域 取值范围: 不涉及 |
sort |
Integer |
参数解释: 显示排序 取值范围: 不涉及 |
tracker_id |
Integer |
参数解释: 工作项类型id 取值范围: 2(任务/Task) 3(缺陷/Bug) 5(Epic) 6(Feature) 7(Story) |
type |
String |
参数解释: 自定义字段类型 取值范围: textArea(多行文本) select(下拉框) radio(单选框,text 单行文本) checkbox(多选框) date(日期) time_date(日期:包含时分,包含时分的日期类型的字段显示格式为:2019/10/10 10:10) number(数字) |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
Post https://{endpoint}/v3/0792b7d26cb74bd799cbae80063dc74a/custom-fields
{
"memo" : "描述",
"name" : "test",
"options" : "0792b7d26cb74bd799cbae80063dc74a",
"scrum_type" : "Story",
"type" : "text"
}
响应示例
状态码: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 53 |
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();
request.withProjectId("{project_id}");
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 37 38 |
# coding: utf-8
import os
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 = os.environ["CLOUD_SDK_AK"]
sk = os.environ["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.project_id = "{project_id}"
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 43 |
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.ProjectId = "{project_id}"
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 |
错误码
请参见错误码。