Creating a Customized Field for a Work Item Type
Function
This API is used to customize fields for a work item type.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.
URI
POST /v3/{project_id}/custom-fields
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition A 32-character UUID. It uniquely identifies a project. Obtain a project ID by calling the API for querying projects. The value of project_id in the response message body is a project ID. Constraints A string of 32 characters consisting of letters and digits. Range N/A Default Value N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| memo | No | String | Definition Custom field description. Constraints N/A Range A string of 0 to 255 characters. Default Value N/A |
| name | Yes | String | Definition Custom field name. Constraints A string of 1 to 15 characters, including letters, digits, hyphens (-), and underscores (_). Range A string of 1 to 15 characters. Default Value N/A |
| options | No | String | Definition Optional values of a custom field. Use commas (,) to separate the values. This parameter is mandatory if type is radio or checkbox. Constraints 1 to 6,000 characters. Range A string of 1 to 6,000 characters. Default Value N/A |
| scrum_type | No | String | Definition Work item type where the new custom field is used. Constraints N/A (The allowed values are defined in the range below.) Range Default Value N/A |
| type | Yes | String | Definition: Custom field type. Constraints: N/A Value range: select: drop-down list radio: radio button text: single-line text checkbox: check box date: date time_date: time that contains the hour and minute, displayed in the format of 2019/10/10 10:10) number: number Default value: N/A |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| created | String | Definition: Creation time. Options: N/A |
| custom_field | String | Definition: Custom field. Options: N/A |
| id | Integer | Definition: Field ID. Options: N/A |
| identifier | String | Definition: Field UUID. Options: N/A |
| is_delete | Boolean | Definition Deleted or not. Range N/A |
| memo | String | Definition Field description. Range N/A |
| modified | String | Definition: Modification time Options: N/A |
| name | String | Definition Field name. Range N/A |
| options | String | Definition Field option. Range N/A |
| project_id | Integer | Definition: Project ID. Options: N/A |
| region | String | Definition: Region. Options: N/A |
| sort | Integer | Definition: Display order. Options: N/A |
| tracker_id | Integer | Definition Work item type ID. Range N/A |
| type | String | Definition Custom field type. Range N/A |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Definition: Error code. Value range: N/A |
| error_msg | String | Definition: Error description. Value range: N/A |
Status code: 401
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Definition: Error code. Value range: N/A |
| error_msg | String | Definition: Error description. Value range: N/A |
| request_id | String | Definition Request ID, which is automatically generated by the system. Range N/A |
Example Requests
POST https://{endpoint}/v3/0792b7d26cb74bd799cbae80063dc74a/custom-fields
{
"memo" : "Description",
"name" : "test",
"options" : "0792b7d26cb74bd799cbae80063dc74a",
"scrum_type" : "Story",
"type" : "text"
} Example Responses
Status code: 200
{
"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 Sample Code
The SDK sample code is as follows.
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("Description"); 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="Description", 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: "Description", Options: "0792b7d26cb74bd799cbae80063dc74a", Type: "text", Name: "test", } response, err := client.CreateCustomfields(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
| Status Code | Description |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
Error Codes
See Error Codes.
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot