Creating a Data Standard Template
Function
Creates a customized item of the data standard template in the current workspace.
Calling Method
For details, see Calling APIs.
URI
POST /v2/{project_id}/design/standards/templates
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 |
---|---|---|---|
fd_name |
Yes |
String |
Attribute name. |
fd_name_en |
No |
String |
English name of an attribute. |
description |
No |
String |
Attribute description. |
descriptionEn |
No |
String |
Attribute description in English. |
label |
No |
String |
Attribute tag. |
disabled |
No |
Boolean |
Disable or not. |
id |
No |
String |
Data standard ID. Set this parameter to the string type instead of the long type. |
actived |
Yes |
Boolean |
Indicates whether to display the default item. The default item is displayed and cannot be modified. The value true indicates that the attribute is displayed when the data standard is used (the attribute can be operated during adding, modification, and query). The value false indicates that the attribute is not displayed when the data standard is used. |
required |
No |
Boolean |
Whether the header input parameter is mandatory. true: mandatory; false: optional. |
searchable |
No |
Boolean |
Indicates whether the content can be searched. The value true indicates that the data can be searched on the data standard list page, and the value false indicates that the data cannot be searched on the data standard list page. |
optional_values |
No |
String |
Allowed value. |
field_type |
No |
Integer |
Field type. The value 0 indicates a system field, and the value 1 indicates a customized field. |
displayed_name |
No |
String |
Frontend display name. |
displayed_name_en |
No |
String |
Frontend display name in English. |
create_by |
No |
String |
Creator. |
update_by |
No |
String |
Person who updates the information. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
data |
data object |
data: unified outermost data structure of the returned result. |
Parameter |
Type |
Description |
---|---|---|
value |
StandElementFieldVO object |
value: unified outer data structure of the returned result. |
Parameter |
Type |
Description |
---|---|---|
fd_name |
String |
Attribute name. |
fd_name_en |
String |
English name of an attribute. |
description |
String |
Attribute description. |
descriptionEn |
String |
Attribute description in English. |
label |
String |
Attribute tag. |
disabled |
Boolean |
Disable or not. |
id |
String |
Data standard ID. Set this parameter to the string type instead of the long type. |
actived |
Boolean |
Indicates whether to display the default item. The default item is displayed and cannot be modified. The value true indicates that the attribute is displayed when the data standard is used (the attribute can be operated during adding, modification, and query). The value false indicates that the attribute is not displayed when the data standard is used. |
required |
Boolean |
Whether the header input parameter is mandatory. true: mandatory; false: optional. |
searchable |
Boolean |
Indicates whether the content can be searched. The value true indicates that the data can be searched on the data standard list page, and the value false indicates that the data cannot be searched on the data standard list page. |
optional_values |
String |
Allowed value. |
field_type |
Integer |
Field type. The value 0 indicates a system field, and the value 1 indicates a customized field. |
displayed_name |
String |
Frontend display name. |
displayed_name_en |
String |
Frontend display name in English. |
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. |
create_by |
String |
Creator. |
update_by |
String |
Person who updates the information. |
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
Creates a customized item of the data standard template in the current workspace.
POST https://{endpoint}/v2/{project_id}/design/standards/templates { "fd_name" : "User-defined item 3", "fd_name_en" : "CustomField3", "description" : "User-defined item 3", "id" : "", "actived" : true, "required" : false, "searchable" : false, "optional_values" : "", "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2024-04-18T16:37:50+08:00", "update_time" : "2024-04-26T14:21:18+08:00", "create_by" : "ei_dayu_y00321344_01", "update_by" : "ei_dayu_y00321344_01" }
Example Responses
Status code: 200
Success
{ "data" : { "value" : { "fd_name" : "User-defined item 3", "fd_name_en" : "CustomField3", "description" : "User-defined item 3", "id" : "1233446517415743488", "actived" : true, "required" : false, "searchable" : false, "optional_values" : "", "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2024-04-26T15:56:06.08+08:00", "update_time" : "2024-04-26T15:56:06.08+08:00", "create_by" : "ei_dayu_y00321344_01", "update_by" : "ei_dayu_y00321344_01" } } }
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.
Creates a customized item of the data standard template in the current workspace.
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 |
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.time.OffsetDateTime; import java.time.format.DateTimeFormatter; public class CreateStandardTemplateSolution { 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(); CreateStandardTemplateRequest request = new CreateStandardTemplateRequest(); StandElementFieldVO body = new StandElementFieldVO(); body.withUpdateBy("ei_dayu_y00321344_01"); body.withCreateBy("ei_dayu_y00321344_01"); body.withUpdateTime(OffsetDateTime.parse("2024-04-26T14:21:18+08:00", DateTimeFormatter.ISO_OFFSET_DATE_TIME)); body.withCreateTime(OffsetDateTime.parse("2024-04-18T16:37:50+08:00", DateTimeFormatter.ISO_OFFSET_DATE_TIME)); body.withOptionalValues(""); body.withSearchable(false); body.withRequired(false); body.withActived(true); body.withId(""); body.withDescription("User-defined item 3"); body.withFdNameEn("CustomField3"); body.withFdName("User-defined item 3"); request.withBody(body); try { CreateStandardTemplateResponse response = client.createStandardTemplate(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()); } } } |
Creates a customized item of the data standard template in the current workspace.
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 |
# 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 = CreateStandardTemplateRequest() request.body = StandElementFieldVO( update_by="ei_dayu_y00321344_01", create_by="ei_dayu_y00321344_01", update_time="2024-04-26T14:21:18+08:00", create_time="2024-04-18T16:37:50+08:00", optional_values="", searchable=False, required=False, actived=True, id="", description="User-defined item 3", fd_name_en="CustomField3", fd_name="User-defined item 3" ) response = client.create_standard_template(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Creates a customized item of the data standard template in the current workspace.
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 |
package main import ( "fmt" "time" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/sdktime" 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.CreateStandardTemplateRequest{} updateByStandElementFieldVo:= "ei_dayu_y00321344_01" createByStandElementFieldVo:= "ei_dayu_y00321344_01" dateTimeUpdateTime, _ := time.ParseInLocation("2006-01-02T15:04:05Z", "2024-04-26T14:21:18+08:00", time.UTC) updateTimeStandElementFieldVo:= sdktime.SdkTime(dateTimeUpdateTime) dateTimeCreateTime, _ := time.ParseInLocation("2006-01-02T15:04:05Z", "2024-04-18T16:37:50+08:00", time.UTC) createTimeStandElementFieldVo:= sdktime.SdkTime(dateTimeCreateTime) optionalValuesStandElementFieldVo:= "" searchableStandElementFieldVo:= false requiredStandElementFieldVo:= false idStandElementFieldVo:= "" descriptionStandElementFieldVo:= "User-defined item 3" fdNameEnStandElementFieldVo:= "CustomField3" request.Body = &model.StandElementFieldVo{ UpdateBy: &updateByStandElementFieldVo, CreateBy: &createByStandElementFieldVo, UpdateTime: &updateTimeStandElementFieldVo, CreateTime: &createTimeStandElementFieldVo, OptionalValues: &optionalValuesStandElementFieldVo, Searchable: &searchableStandElementFieldVo, Required: &requiredStandElementFieldVo, Actived: true, Id: &idStandElementFieldVo, Description: &descriptionStandElementFieldVo, FdNameEn: &fdNameEnStandElementFieldVo, FdName: "User-defined item 3", } response, err := client.CreateStandardTemplate(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 |
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