创建工作项类型自定义字段 - CreateCustomfields
功能介绍
创建工作项类型自定义字段。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
URI
POST /v3/{project_id}/custom-fields
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目的32位UUID,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 32个字符,由英文字母和数字组成。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| memo | 否 | String | 参数解释: 自定义字段描述 约束限制: 不涉及 取值范围: 长度为0~255的字符串。 默认取值: 不涉及 |
| name | 是 | String | 参数解释: 自定义字段名称 约束限制: 1~15个字符,由中文字符、英文字母、数字、连字符和下划线组成。 取值范围: 长度为1~15的字符串。 默认取值: 不涉及 |
| options | 否 | String | 参数解释: 自定义字段的可选值,多个值以英文逗号区分,如果type为单选框或者多选框时候该参数必填。 约束限制: 1~6000个字符。 取值范围: 长度为1~6000的字符串。 默认取值: 不涉及 |
| scrum_type | 否 | String | 参数解释: 当前新建的自定义字段应用的工作项类型 约束限制: 不涉及(取值范围已有列举)。 取值范围: 默认取值: 不涉及 |
| type | 是 | String | 参数解释: 自定义字段类型 约束限制: 不涉及。 取值范围: 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| created | String | 参数解释: 创建时间 取值范围: 不涉及 |
| custom_field | String | 参数解释: 自定义字段 取值范围: 不涉及 |
| id | Integer | 参数解释: 字段ID 取值范围: 不涉及 |
| identifier | String | 参数解释: 字段UUID 取值范围: 不涉及 |
| is_delete | Boolean | 参数解释: 是否被删除 取值范围: 不涉及 |
| memo | String | 参数解释: 字段描述 取值范围: 不涉及 |
| modified | String | 参数解释: 修改时间 取值范围: 不涉及 |
| name | String | 参数解释: 字段名称 取值范围: 不涉及 |
| options | String | 参数解释: 字段选项 取值范围: 不涉及 |
| project_id | Integer | 参数解释: 项目ID 取值范围: 不涉及 |
| region | String | 参数解释: 区域 取值范围: 不涉及 |
| sort | Integer | 参数解释: 显示排序 取值范围: 不涉及 |
| tracker_id | Integer | 参数解释: 工作项类型id 取值范围: 不涉及 |
| type | String | 参数解释: 自定义字段类型。 取值范围: 不涉及 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误描述。 取值范围: 不涉及。 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误描述。 取值范围: 不涉及。 |
| request_id | String | 参数解释: 请求的ID,系统自动生成。 取值范围: 不涉及。 |
请求示例
POST https://{endpoint}/v3/0792b7d26cb74bd799cbae80063dc74a/custom-fields
{
"memo" : "描述",
"name" : "test",
"options" : "0792b7d26cb74bd799cbae80063dc74a",
"scrum_type" : "Story",
"type" : "text"
} 响应示例
状态码:200
OK
{
"id" : 50611,
"identifier" : "e8dbcc2c2f4f474f801834f8905c08f7",
"project_id" : 527,
"tracker_id" : -2,
"custom_field" : "custom_field20",
"type" : "text",
"name" : "4441",
"sort" : 1,
"created" : "2026-07-08 15:42:56",
"modified" : "2026-07-08 15:42:56",
"is_delete" : false,
"region" : "roma-dg-7"
} 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 44 45 46 47 48 49 50 51 52 53 54 55 | 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := projectman.ProjectManClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := projectman.NewProjectManClient(hcClient) 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 |
错误码
请参见错误码。