Creating a Lookup Table
Function
Create a lookup table.
Calling Method
For details, see Calling APIs.
URI
POST /v2/{project_id}/design/code-tables
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 |
---|---|---|---|
id |
No |
String |
Lookup table ID, which is a string |
name_en |
Yes |
String |
Table name, in English. |
name_ch |
Yes |
String |
Table name, in Chinese. |
tb_version |
No |
Integer |
Table version. |
directory_id |
Yes |
String |
Directory ID, which is a string |
directory_path |
No |
String |
Directory tree. |
description |
No |
String |
Description. |
create_by |
No |
String |
Creator. |
status |
No |
String |
Release status of an entity. This parameter is read-only and does not need to be set during creation and update. Options:
|
approval_info |
No |
ApprovalVO object |
Approval information. This parameter is read-only. Latest review information about a business object, including the business details, reviewer information, and review time. |
new_biz |
No |
BizVersionManageVO object |
Service version management. This parameter is read-only. |
code_table_fields |
Yes |
Array of CodeTableFieldVO objects |
Code list attribute information. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
id |
No |
String |
Application ID, which is a string |
tenant_id |
No |
String |
Project ID. For details about how to obtain the project ID, see the API path parameter project_id. |
name_ch |
No |
String |
Chinese name of a service. |
name_en |
No |
String |
English name of a service. |
biz_id |
No |
String |
Business ID, which is a string |
biz_type |
No |
String |
Business entity type. Options:
|
biz_info |
No |
String |
Serialized service details. The type is string. |
biz_info_obj |
No |
Object |
Service details. The type is object. |
biz_version |
No |
Integer |
Service version. |
biz_status |
No |
String |
Release status of an entity. This parameter is read-only and does not need to be set during creation and update. Options:
|
approval_status |
No |
String |
Service approval status. This parameter is read-only. Options:
|
approval_type |
No |
String |
Service review type. Options:
|
submit_time |
No |
String |
Submitted At |
create_by |
No |
String |
Creator. |
l1 |
No |
String |
Chinese name of the subject area group. This parameter is read-only and does not need to be set when you create or update a subject area group. |
l2 |
No |
String |
Chinese name of the subject area. This parameter is read-only and does not need to be set during creation and update. |
l3 |
No |
String |
Chinese name of the business object. This parameter is read-only and does not need to be set during creation and update. |
approval_time |
No |
String |
Review time. |
approver |
No |
String |
Reviewer. |
|
No |
String |
Email address of the reviewer. |
msg |
No |
String |
Review information. |
directory_path |
No |
String |
Directory tree. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
id |
No |
String |
Field ID, which is a string |
biz_type |
No |
String |
Business entity type. Options:
|
biz_id |
No |
String |
Business ID, which is a string |
biz_info |
No |
String |
Business object information. |
status |
No |
String |
Release status of an entity. This parameter is read-only and does not need to be set during creation and update. Options:
|
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
id |
No |
String |
Lookup table field ID, which is a string |
code_table_id |
No |
String |
ID of the lookup table (mandatory for update), which is a string |
ordinal |
Yes |
Integer |
Sequence number. |
name_en |
Yes |
String |
Field name, in English. |
name_ch |
Yes |
String |
Field name, in Chinese. |
description |
No |
String |
Description. |
data_type |
Yes |
String |
Field type |
data_type_extend |
No |
String |
Extended field of the data type. |
is_unique_key |
No |
Boolean |
Whether the field is unique. |
code_table_field_values |
No |
Array of CodeTableFieldValueVO objects |
Code list attribute value. |
count_field_values |
No |
Integer |
Total number of lookup table attribute values. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
id |
No |
String |
Lookup table field ID, which is a string |
fd_id |
No |
String |
Attribute ID of the lookup table, which is a string |
fd_value |
No |
String |
Code list attribute value. |
ordinal |
No |
Integer |
Sequence number. |
description |
No |
String |
Description. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
data |
data object |
data: unified outermost data structure of the returned result. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Lookup table ID, which is a string |
name_en |
String |
Table name, in English. |
name_ch |
String |
Table name, in Chinese. |
tb_version |
Integer |
Table version. |
directory_id |
String |
Directory ID, which is a string |
directory_path |
String |
Directory tree. |
description |
String |
Description. |
create_by |
String |
Creator. |
status |
String |
Release status of an entity. This parameter is read-only and does not need to be set during creation and update. Options:
|
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. |
approval_info |
ApprovalVO object |
Approval information. This parameter is read-only. Latest review information about a business object, including the business details, reviewer information, and review time. |
new_biz |
BizVersionManageVO object |
Service version management. This parameter is read-only. |
code_table_fields |
Array of CodeTableFieldVO objects |
Code list attribute information. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Application ID, which is a string |
tenant_id |
String |
Project ID. For details about how to obtain the project ID, see the API path parameter project_id. |
name_ch |
String |
Chinese name of a service. |
name_en |
String |
English name of a service. |
biz_id |
String |
Business ID, which is a string |
biz_type |
String |
Business entity type. Options:
|
biz_info |
String |
Serialized service details. The type is string. |
biz_info_obj |
Object |
Service details. The type is object. |
biz_version |
Integer |
Service version. |
biz_status |
String |
Release status of an entity. This parameter is read-only and does not need to be set during creation and update. Options:
|
approval_status |
String |
Service approval status. This parameter is read-only. Options:
|
approval_type |
String |
Service review type. Options:
|
submit_time |
String |
Submitted At |
create_by |
String |
Creator. |
l1 |
String |
Chinese name of the subject area group. This parameter is read-only and does not need to be set when you create or update a subject area group. |
l2 |
String |
Chinese name of the subject area. This parameter is read-only and does not need to be set during creation and update. |
l3 |
String |
Chinese name of the business object. This parameter is read-only and does not need to be set during creation and update. |
approval_time |
String |
Review time. |
approver |
String |
Reviewer. |
|
String |
Email address of the reviewer. |
msg |
String |
Review information. |
directory_path |
String |
Directory tree. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Field ID, which is a string |
biz_type |
String |
Business entity type. Options:
|
biz_id |
String |
Business ID, which is a string |
biz_info |
String |
Business object information. |
status |
String |
Release status of an entity. This parameter is read-only and does not need to be set during creation and update. Options:
|
biz_version |
Integer |
Service version, 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. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Lookup table field ID, which is a string |
code_table_id |
String |
ID of the lookup table (mandatory for update), which is a string |
ordinal |
Integer |
Sequence number. |
name_en |
String |
Field name, in English. |
name_ch |
String |
Field name, in Chinese. |
description |
String |
Description. |
data_type |
String |
Field type |
domain_type |
String |
Domain to which a field type belongs. Options:
|
data_type_extend |
String |
Extended field of the data type. |
is_unique_key |
Boolean |
Whether the field is unique. |
code_table_field_values |
Array of CodeTableFieldValueVO objects |
Code list attribute value. |
count_field_values |
Integer |
Total number of lookup table attribute values. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Lookup table field ID, which is a string |
fd_id |
String |
Attribute ID of the lookup table, which is a string |
fd_value |
String |
Code list attribute value. |
ordinal |
Integer |
Sequence number. |
description |
String |
Description. |
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. |
Status code: 404
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 create a lookup table based on the request parameters and save the table as a draft. The information about the successfully created lookup table is returned.
POST https://{endpoint}/v2/{project_id}/design/code-tables { "name_en" : "", "name_ch" : "test_create_code_table", "description" : "", "code_table_fields" : [ { "ordinal" : 1, "name_ch" : "Message", "name_en" : "code", "data_type" : "STRING", "description" : "", "code_table_field_values" : [ ] }, { "ordinal" : 2, "name_ch" : "Economical", "name_en" : "province", "data_type" : "STRING", "description" : "", "code_table_field_values" : [ ] }, { "ordinal" : 3, "name_ch" : "Specifies the city where the customer is located.", "name_en" : "city", "data_type" : "STRING", "description" : "", "code_table_field_values" : [ ] }, { "ordinal" : 4, "name_ch" : "County", "name_en" : "county", "data_type" : "STRING", "description" : "", "code_table_field_values" : [ ] } ], "tb_version" : 0, "directory_id" : "1194963842254491648" }
Example Responses
Status code: 200
This operation succeeds, and the returned data is CodeTableVO.
{ "data" : { "value" : { "id" : "1230204979835502592", "name_en" : "DC000007", "name_ch" : "test_create_code_table", "tb_version" : 0, "directory_id" : "1194963842254491648", "directory_path" : null, "description" : "", "create_by" : "test_uesr", "status" : "DRAFT", "create_time" : "2024-04-17T17:15:23.296+08:00", "update_time" : "2024-04-17T17:15:23.296+08:00", "approval_info" : null, "new_biz" : null, "code_table_fields" : [ { "id" : null, "code_table_id" : null, "ordinal" : 1, "name_en" : "code", "name_ch" : "Status", "description" : "", "data_type" : "STRING", "domain_type" : null, "data_type_extend" : null, "is_unique_key" : false, "code_table_field_values" : [ ], "count_field_values" : null }, { "id" : null, "code_table_id" : null, "ordinal" : 2, "name_en" : "province", "name_ch" : "Economical", "description" : "", "data_type" : "STRING", "domain_type" : null, "data_type_extend" : null, "is_unique_key" : false, "code_table_field_values" : [ ], "count_field_values" : null }, { "id" : null, "code_table_id" : null, "ordinal" : 3, "name_en" : "city", "name_ch" : "City", "description" : "", "data_type" : "STRING", "domain_type" : null, "data_type_extend" : null, "is_unique_key" : false, "code_table_field_values" : [ ], "count_field_values" : null }, { "id" : null, "code_table_id" : null, "ordinal" : 4, "name_en" : "county", "name_ch" : "County", "description" : "", "data_type" : "STRING", "domain_type" : null, "data_type_extend" : null, "is_unique_key" : false, "code_table_field_values" : [ ], "count_field_values" : 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." }
Status code: 404
{ "error_code" : "DS.60xx", "error_msg" : "The User Request API does not exist." }
SDK Sample Code
The SDK sample code is as follows.
This API is used to create a lookup table based on the request parameters and save the table as a draft. The information about the successfully created lookup table is returned.
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 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 |
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 CreateCodeTableSolution { 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(); CreateCodeTableRequest request = new CreateCodeTableRequest(); CodeTableVO body = new CodeTableVO(); List<CodeTableFieldVO> listbodyCodeTableFields = new ArrayList<>(); listbodyCodeTableFields.add( new CodeTableFieldVO() .withOrdinal(1) .withNameEn("code") .withNameCh("Message") .withDescription("") .withDataType("STRING") .withCodeTableFieldValues() ); listbodyCodeTableFields.add( new CodeTableFieldVO() .withOrdinal(2) .withNameEn("province") .withNameCh("Economical") .withDescription("") .withDataType("STRING") .withCodeTableFieldValues() ); listbodyCodeTableFields.add( new CodeTableFieldVO() .withOrdinal(3) .withNameEn("city") .withNameCh("Specifies the city where the customer is located.") .withDescription("") .withDataType("STRING") .withCodeTableFieldValues() ); listbodyCodeTableFields.add( new CodeTableFieldVO() .withOrdinal(4) .withNameEn("county") .withNameCh("County") .withDescription("") .withDataType("STRING") .withCodeTableFieldValues() ); body.withCodeTableFields(listbodyCodeTableFields); body.withDescription(""); body.withDirectoryId("1194963842254491648"); body.withTbVersion(0); body.withNameCh("test_create_code_table"); body.withNameEn(""); request.withBody(body); try { CreateCodeTableResponse response = client.createCodeTable(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 create a lookup table based on the request parameters and save the table as a draft. The information about the successfully created lookup table is returned.
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 |
# 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 = CreateCodeTableRequest() listCodeTableFieldsbody = [ CodeTableFieldVO( ordinal=1, name_en="code", name_ch="Message", description="", data_type="STRING", ), CodeTableFieldVO( ordinal=2, name_en="province", name_ch="Economical", description="", data_type="STRING", ), CodeTableFieldVO( ordinal=3, name_en="city", name_ch="Specifies the city where the customer is located.", description="", data_type="STRING", ), CodeTableFieldVO( ordinal=4, name_en="county", name_ch="County", description="", data_type="STRING", ) ] request.body = CodeTableVO( code_table_fields=listCodeTableFieldsbody, description="", directory_id="1194963842254491648", tb_version=0, name_ch="test_create_code_table", name_en="" ) response = client.create_code_table(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 create a lookup table based on the request parameters and save the table as a draft. The information about the successfully created lookup table is returned.
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 77 78 79 80 81 |
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.CreateCodeTableRequest{} descriptionCodeTableFields:= "" descriptionCodeTableFields1:= "" descriptionCodeTableFields2:= "" descriptionCodeTableFields3:= "" var listCodeTableFieldsbody = []model.CodeTableFieldVo{ { Ordinal: int32(1), NameEn: "code", NameCh: "Message", Description: &descriptionCodeTableFields, DataType: "STRING", }, { Ordinal: int32(2), NameEn: "province", NameCh: "Economical", Description: &descriptionCodeTableFields1, DataType: "STRING", }, { Ordinal: int32(3), NameEn: "city", NameCh: "Specifies the city where the customer is located.", Description: &descriptionCodeTableFields2, DataType: "STRING", }, { Ordinal: int32(4), NameEn: "county", NameCh: "County", Description: &descriptionCodeTableFields3, DataType: "STRING", }, } descriptionCodeTableVo:= "" tbVersionCodeTableVo:= int32(0) request.Body = &model.CodeTableVo{ CodeTableFields: listCodeTableFieldsbody, Description: &descriptionCodeTableVo, DirectoryId: "1194963842254491648", TbVersion: &tbVersionCodeTableVo, NameCh: "test_create_code_table", NameEn: "", } response, err := client.CreateCodeTable(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 |
This operation succeeds, and the returned data is CodeTableVO. |
400 |
BadRequest |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
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