Modifying a Customized Item
Function
Modify customized items (including table customized items, attribute customized items, theme customized items, and service indicator customized items).
Calling Method
For details, see Calling APIs.
URI
PUT /v2/{project_id}/design/customized-fields
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see Project ID and Account ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
IAM token, which is obtained by calling the IAM API for obtaining a user token (value of X-Subject-Token in the response header). This field is mandatory for authentication using tokens. |
workspace |
Yes |
String |
Workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID. |
X-Project-Id |
No |
String |
Project ID. For details about how to obtain the project ID, see Project ID and Account ID. This parameter is mandatory for API requests that use AK/SK authentication in multi-project scenarios. |
Content-Type |
No |
String |
Default value: application/json;charset=UTF-8 This parameter is optional. If the body is available, this parameter is mandatory. If the body is unavailable, you do not need to set this parameter or verify it. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
type |
Yes |
String |
Type of a customized item. Options:
|
fields |
No |
Array of CustomizedFieldsVO objects |
List of customized items. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
id |
No |
String |
Code. Set this parameter to a value of the String type instead of the Long type. |
name_ch |
Yes |
String |
Chinese name of a user-defined item. |
name_en |
Yes |
String |
English name of a customized item. |
not_null |
Yes |
Boolean |
Whether a parameter is mandatory. |
optional_values |
No |
String |
Sorting order. Options: If there are multiple optional values, separate them with semicolons (;). |
type |
Yes |
String |
Type of a customized item. Options:
|
ordinal |
No |
Integer |
System sorting field. You do not need to set this parameter when creating or modifying a record. |
description |
No |
String |
Description of a user-defined item. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
data |
data object |
data: unified outermost data structure of the returned result. |
Parameter |
Type |
Description |
---|---|---|
value |
Array of CustomizedFieldsVO objects |
Data connection information array |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Code. Set this parameter to a value of the String type instead of the Long type. |
name_ch |
String |
Chinese name of a user-defined item. |
name_en |
String |
English name of a customized item. |
not_null |
Boolean |
Whether a parameter is mandatory. |
optional_values |
String |
Sorting order. Options: If there are multiple optional values, separate them with semicolons (;). |
type |
String |
Type of a customized item. Options:
|
ordinal |
Integer |
System sorting field. You do not need to set this parameter when creating or modifying a record. |
description |
String |
Description of a user-defined item. |
create_by |
String |
Creator, which is read-only. |
update_by |
String |
Updater, which is read-only. |
create_time |
String |
Creation time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z. |
update_time |
String |
Update time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, for example, DS.6000, indicating that the request fails to be processed. |
error_msg |
String |
Error message |
data |
Object |
Returned data information. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, for example, DS.6000, indicating that the request fails to be processed. |
error_msg |
String |
Error message |
data |
Object |
Returned data information. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, for example, DS.6000, indicating that the request fails to be processed. |
error_msg |
String |
Error message |
data |
Object |
Returned data information. |
Example Requests
This API is used to modify a customized item of a table.
PUT https://{endpoint}/v2/{project_id}/design/customized-fields { "type" : "TABLE", "fields" : [ { "id" : "1211611269321355264", "name_ch" : "User-defined item 1", "name_en" : "selfDefine1", "not_null" : false, "optional_values" : "", "description" : "Test 1", "ordinal" : 0, "type" : "TABLE" }, { "id" : "1211611269321355265", "name_ch" : "User-defined item 2", "name_en" : "selfDefine2", "not_null" : true, "optional_values" : "", "description" : "Modification 2", "ordinal" : 1, "type" : "TABLE" } ] }
Example Responses
Status code: 200
Success
{ "data" : { "value" : [ { "id" : "1211611269321355264", "name_ch" : "User-defined item 1", "name_en" : "selfDefine1", "not_null" : false, "optional_values" : "", "type" : "TABLE", "ordinal" : 0, "description" : "Test 1", "create_by" : null, "update_by" : null, "create_time" : null, "update_time" : null }, { "id" : "1211611269321355265", "name_ch" : "User-defined item 2", "name_en" : "selfDefine2", "not_null" : true, "optional_values" : "", "type" : "TABLE", "ordinal" : 1, "description" : "Modification 2", "create_by" : null, "update_by" : null, "create_time" : null, "update_time" : null } ] } }
Status code: 400
{ "error_code" : "DS.60xx", "error_msg" : "The user request is illegal." }
Status code: 401
{ "error_code" : "DS.60xx", "error_msg" : "User authentication failed." }
Status code: 403
{ "error_code" : "DS.60xx", "error_msg" : "The user does not have permission to call this API." }
SDK Sample Code
The SDK sample code is as follows.
This API is used to modify a customized item of a table.
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 63 64 65 66 67 68 69 70 71 72 73 74 75 76 |
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.dataartsstudio.v1.region.DataArtsStudioRegion; import com.huaweicloud.sdk.dataartsstudio.v1.*; import com.huaweicloud.sdk.dataartsstudio.v1.model.*; import java.util.List; import java.util.ArrayList; public class ModifyCustomizedFieldsSolution { 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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); DataArtsStudioClient client = DataArtsStudioClient.newBuilder() .withCredential(auth) .withRegion(DataArtsStudioRegion.valueOf("<YOUR REGION>")) .build(); ModifyCustomizedFieldsRequest request = new ModifyCustomizedFieldsRequest(); CustomizedFieldsVOList body = new CustomizedFieldsVOList(); List<CustomizedFieldsVO> listbodyFields = new ArrayList<>(); listbodyFields.add( new CustomizedFieldsVO() .withId("1211611269321355264") .withNameCh("User-defined item 1") .withNameEn("selfDefine1") .withNotNull(false) .withOptionalValues("") .withType(CustomizedFieldsVO.TypeEnum.fromValue("TABLE")) .withOrdinal(0) .withDescription("Test 1") ); listbodyFields.add( new CustomizedFieldsVO() .withId("1211611269321355265") .withNameCh("User-defined item 2") .withNameEn("selfDefine2") .withNotNull(true) .withOptionalValues("") .withType(CustomizedFieldsVO.TypeEnum.fromValue("TABLE")) .withOrdinal(1) .withDescription("Modification 2") ); body.withFields(listbodyFields); body.withType(CustomizedFieldsVOList.TypeEnum.fromValue("TABLE")); request.withBody(body); try { ModifyCustomizedFieldsResponse response = client.modifyCustomizedFields(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()); } } } |
This API is used to modify a customized item of a table.
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdataartsstudio.v1.region.dataartsstudio_region import DataArtsStudioRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdataartsstudio.v1 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"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = DataArtsStudioClient.new_builder() \ .with_credentials(credentials) \ .with_region(DataArtsStudioRegion.value_of("<YOUR REGION>")) \ .build() try: request = ModifyCustomizedFieldsRequest() listFieldsbody = [ CustomizedFieldsVO( id="1211611269321355264", name_ch="User-defined item 1", name_en="selfDefine1", not_null=False, optional_values="", type="TABLE", ordinal=0, description="Test 1" ), CustomizedFieldsVO( id="1211611269321355265", name_ch="User-defined item 2", name_en="selfDefine2", not_null=True, optional_values="", type="TABLE", ordinal=1, description="Modification 2" ) ] request.body = CustomizedFieldsVOList( fields=listFieldsbody, type="TABLE" ) response = client.modify_customized_fields(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
This API is used to modify a customized item of a table.
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 63 64 65 66 67 68 69 70 71 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dataartsstudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/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") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := dataartsstudio.NewDataArtsStudioClient( dataartsstudio.DataArtsStudioClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ModifyCustomizedFieldsRequest{} idFields:= "1211611269321355264" optionalValuesFields:= "" ordinalFields:= int32(0) descriptionFields:= "Test 1" idFields1:= "1211611269321355265" optionalValuesFields1:= "" ordinalFields1:= int32(1) descriptionFields1:= "Modification 2" var listFieldsbody = []model.CustomizedFieldsVo{ { Id: &idFields, NameCh: "User-defined item 1", NameEn: "selfDefine1", NotNull: false, OptionalValues: &optionalValuesFields, Type: model.GetCustomizedFieldsVoTypeEnum().TABLE, Ordinal: &ordinalFields, Description: &descriptionFields, }, { Id: &idFields1, NameCh: "User-defined item 2", NameEn: "selfDefine2", NotNull: true, OptionalValues: &optionalValuesFields1, Type: model.GetCustomizedFieldsVoTypeEnum().TABLE, Ordinal: &ordinalFields1, Description: &descriptionFields1, }, } request.Body = &model.CustomizedFieldsVoList{ Fields: &listFieldsbody, Type: model.GetCustomizedFieldsVoListTypeEnum().TABLE, } response, err := client.ModifyCustomizedFields(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
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 |
Success |
400 |
BadRequest |
401 |
Unauthorized |
403 |
Forbidden |
Feedback
Was this page helpful?
Provide feedbackThank 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