Querying a Data Standard Template
Function
This API is used to query data standard templates in the current workspace.
Calling Method
For details, see Calling APIs.
URI
GET /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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
No |
Integer |
Number of records to be queried on each page, that is, Y records to be queried. The default value is 50, and the value range is [1,100]. |
offset |
No |
Integer |
Start coordinate of the query, that is, the number of skipped data records. The value can only be 0 or an integer multiple of limit. If the value does not meet the requirement, the value is rounded down. The default value is 0. |
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. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
data |
data object |
Data returned by the API |
Parameter |
Type |
Description |
---|---|---|
value |
value object |
Result of querying the data standard template |
Parameter |
Type |
Description |
---|---|---|
allFields |
Array of StandElementFieldVO objects |
All attributes of the data standard. The set contains a single StandElementFieldVO object. |
optional |
Array of StandElementFieldVO objects |
This parameter is optional. The set contains a single StandElementFieldVO object. |
system_default |
Array of StandElementFieldVO objects |
System default item. The collection contains a single StandElementFieldVO object. |
custom |
Array of StandElementFieldVO objects |
User-defined item. The collection contains a single StandElementFieldVO object. |
hasTemplate |
Boolean |
Whether to use the template |
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, which is a string |
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
This API is used to query data standard templates in the current workspace.
GET https://{endpoint}/v2/{project_id}/design/standards/templates
Example Responses
Status code: 200
This operation succeeds, and the returned data is a StandElementFieldVO list.
{ "data" : { "value" : { "allFields" : [ { "fd_name" : "nameCh", "fd_name_en" : null, "description" : "Standard Name", "id" : "1020622096960831488", "actived" : true, "required" : true, "searchable" : true, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_uesr", "update_by" : "test_uesr" }, { "fd_name" : "nameEn", "fd_name_en" : null, "description" : "Standard Code", "id" : "1020622096985997312", "actived" : true, "required" : true, "searchable" : true, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_uesr", "update_by" : "test_uesr" }, { "fd_name" : "dataType", "fd_name_en" : null, "description" : "Data type", "id" : "1020622097006968832", "actived" : true, "required" : true, "searchable" : true, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_uesr", "update_by" : "test_uesr" }, { "fd_name" : "dataLength", "fd_name_en" : null, "description" : "Max. Data Length", "id" : "1020622097032134656", "actived" : true, "required" : false, "searchable" : false, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_uesr", "update_by" : "test_uesr" }, { "fd_name" : "hasAllowValueList", "fd_name_en" : null, "description" : "Allowed Value Exist", "id" : "1020622097048911872", "actived" : true, "required" : false, "searchable" : false, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_uesr", "update_by" : "test_uesr" }, { "fd_name" : "allowList", "fd_name_en" : null, "description" : "Allowed Value", "id" : "1020622097065689088", "actived" : true, "required" : false, "searchable" : false, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_uesr", "update_by" : "test_uesr" }, { "fd_name" : "referCodeTable", "fd_name_en" : null, "description" : "Lookup Table", "id" : "1020622097086660608", "actived" : true, "required" : false, "searchable" : false, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_uesr", "update_by" : "test_uesr" }, { "fd_name" : "codeStandColumn", "fd_name_en" : null, "description" : "Lookup Table Field", "id" : "1020622097103437824", "actived" : true, "required" : false, "searchable" : false, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_uesr", "update_by" : "test_uesr" }, { "fd_name" : "dqcRule", "fd_name_en" : null, "description" : "Quality rule", "id" : "1020622097124409344", "actived" : true, "required" : false, "searchable" : false, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_uesr", "update_by" : "test_uesr" }, { "fd_name" : "ruleOwner", "fd_name_en" : null, "description" : "Rule Designer", "id" : "1020622097141186560", "actived" : true, "required" : false, "searchable" : false, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_uesr", "update_by" : "test_uesr" }, { "fd_name" : "dataMonitorOwner", "fd_name_en" : null, "description" : "Rule Implementer", "id" : "1020622097162158080", "actived" : true, "required" : false, "searchable" : false, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_uesr", "update_by" : "test_uesr" }, { "fd_name" : "standardLevel", "fd_name_en" : null, "description" : "Standard Level", "id" : "1020622097178935296", "actived" : true, "required" : false, "searchable" : false, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_uesr", "update_by" : "test_uesr" }, { "fd_name" : "description", "fd_name_en" : null, "description" : "Description", "id" : "1020622097195712512", "actived" : true, "required" : false, "searchable" : false, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_uesr", "update_by" : "test_uesr" }, { "fd_name" : "englishName", "fd_name_en" : null, "description" : "Identifier Name", "id" : "1185628711836360704", "actived" : true, "required" : false, "searchable" : true, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2023-12-16T17:05:13+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_uesr", "update_by" : "test_uesr" } ], "custom" : [ ], "optional" : [ { "fd_name" : "dataLength", "fd_name_en" : null, "description" : "Max. Data Length", "id" : "1020622097032134656", "actived" : true, "required" : false, "searchable" : false, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_uesr", "update_by" : "test_uesr" }, { "fd_name" : "hasAllowValueList", "fd_name_en" : null, "description" : "Allowed Value Exist", "id" : "1020622097048911872", "actived" : true, "required" : false, "searchable" : false, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_uesr", "update_by" : "test_uesr" }, { "fd_name" : "allowList", "fd_name_en" : null, "description" : "Allowed Value", "id" : "1020622097065689088", "actived" : true, "required" : false, "searchable" : false, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_uesr", "update_by" : "test_uesr" }, { "fd_name" : "referCodeTable", "fd_name_en" : null, "description" : "Lookup Table", "id" : "1020622097086660608", "actived" : true, "required" : false, "searchable" : false, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_uesr", "update_by" : "test_uesr" }, { "fd_name" : "codeStandColumn", "fd_name_en" : null, "description" : "Lookup Table Field", "id" : "1020622097103437824", "actived" : true, "required" : false, "searchable" : false, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_uesr", "update_by" : "test_uesr" }, { "fd_name" : "dqcRule", "fd_name_en" : null, "description" : "Quality rule", "id" : "1020622097124409344", "actived" : true, "required" : false, "searchable" : false, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_uesr", "update_by" : "test_uesr" }, { "fd_name" : "ruleOwner", "fd_name_en" : null, "description" : "Rule Designer", "id" : "1020622097141186560", "actived" : true, "required" : false, "searchable" : false, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_uesr", "update_by" : "test_uesr" }, { "fd_name" : "dataMonitorOwner", "fd_name_en" : null, "description" : "Rule Implementer", "id" : "1020622097162158080", "actived" : true, "required" : false, "searchable" : false, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_uesr", "update_by" : "test_uesr" }, { "fd_name" : "standardLevel", "fd_name_en" : null, "description" : "Standard Level", "id" : "1020622097178935296", "actived" : true, "required" : false, "searchable" : false, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_uesr", "update_by" : "test_uesr" }, { "fd_name" : "description", "fd_name_en" : null, "description" : "Description", "id" : "1020622097195712512", "actived" : true, "required" : false, "searchable" : false, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_uesr", "update_by" : "test_uesr" }, { "fd_name" : "englishName", "fd_name_en" : null, "description" : "Identifier Name", "id" : "1185628711836360704", "actived" : true, "required" : false, "searchable" : true, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2023-12-16T17:05:13+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_uesr", "update_by" : "test_uesr" } ], "hasTemplate" : true, "system_default" : [ { "fd_name" : "nameCh", "fd_name_en" : null, "description" : "Standard Name", "id" : "1020622096960831488", "actived" : true, "required" : true, "searchable" : true, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_uesr", "update_by" : "test_uesr" }, { "fd_name" : "nameEn", "fd_name_en" : null, "description" : "Standard Code", "id" : "1020622096985997312", "actived" : true, "required" : true, "searchable" : true, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_uesr", "update_by" : "test_uesr" }, { "fd_name" : "dataType", "fd_name_en" : null, "description" : "Data type", "id" : "1020622097006968832", "actived" : true, "required" : true, "searchable" : true, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_uesr", "update_by" : "test_uesr" } ] } } }
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.
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 |
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.*; public class ShowStandardTemplateSolution { 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(); ShowStandardTemplateRequest request = new ShowStandardTemplateRequest(); try { ShowStandardTemplateResponse response = client.showStandardTemplate(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()); } } } |
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 |
# 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 = ShowStandardTemplateRequest() response = client.show_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) |
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 |
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.ShowStandardTemplateRequest{} response, err := client.ShowStandardTemplate(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 a StandElementFieldVO list. |
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