更新时间:2024-11-06 GMT+08:00

创建数据标准模板

功能介绍

创建当前工作空间下的数据标准模板自定义项。

调用方法

请参见如何调用API

URI

POST /v2/{project_id}/design/standards/templates

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参见项目ID和账号ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

IAM Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)

使用Token认证时必选。

workspace

String

工作空间ID,获取方法请参见实例ID和工作空间ID

X-Project-Id

String

项目ID,获取方法请参见项目ID和账号ID

多project场景采用AK/SK认证的接口请求,则该字段必选。

Content-Type

String

默认值:application/json;charset=UTF-8

可选,有Body体的情况下必选,没有Body体则无需填写和校验。

表3 请求Body参数

参数

是否必选

参数类型

描述

fd_name

String

属性名称。

fd_name_en

String

属性英文名称。

description

String

属性描述。

descriptionEn

String

属性英文描述。

label

String

属性标签。

disabled

Boolean

是否禁用。

id

String

数据标准ID,填写String类型替代Long类型。

actived

Boolean

是否显示,系统默认项必然显示不允许修改。true表示使用数据标准时体现(增改查的时候可以操作该属性),false表示使用数据标准时不体现。

required

Boolean

是否必填。true:必填,false:非必填。

searchable

Boolean

是否可搜索。true表示在数据标准列表页面可搜索,false表示在数据标准列表页面不可搜索。

optional_values

String

允许值。

field_type

Integer

字段类型,0表示系统字段, 1表示自定义字段。

displayed_name

String

前端展示名。

displayed_name_en

String

前端展示名英文。

create_by

String

创建人。

update_by

String

更新人。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

data

data object

data,统一的返回结果的最外层数据结构。

表5 data

参数

参数类型

描述

value

StandElementFieldVO object

value,统一的返回结果的外层数据结构。

表6 StandElementFieldVO

参数

参数类型

描述

fd_name

String

属性名称。

fd_name_en

String

属性英文名称。

description

String

属性描述。

descriptionEn

String

属性英文描述。

label

String

属性标签。

disabled

Boolean

是否禁用。

id

String

数据标准ID,填写String类型替代Long类型。

actived

Boolean

是否显示,系统默认项必然显示不允许修改。true表示使用数据标准时体现(增改查的时候可以操作该属性),false表示使用数据标准时不体现。

required

Boolean

是否必填。true:必填,false:非必填。

searchable

Boolean

是否可搜索。true表示在数据标准列表页面可搜索,false表示在数据标准列表页面不可搜索。

optional_values

String

允许值。

field_type

Integer

字段类型,0表示系统字段, 1表示自定义字段。

displayed_name

String

前端展示名。

displayed_name_en

String

前端展示名英文。

create_time

String

创建时间,只读,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。

update_time

String

更新时间,只读,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。

create_by

String

创建人。

update_by

String

更新人。

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码,如DS.6000,请求处理失败。

error_msg

String

错误信息。

data

Object

返回的数据信息。

状态码: 401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码,如DS.6000,请求处理失败。

error_msg

String

错误信息。

data

Object

返回的数据信息。

状态码: 403

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码,如DS.6000,请求处理失败。

error_msg

String

错误信息。

data

Object

返回的数据信息。

状态码: 404

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码,如DS.6000,请求处理失败。

error_msg

String

错误信息。

data

Object

返回的数据信息。

请求示例

创建当前工作空间下的数据标准模板自定义项。

POST https://{endpoint}/v2/{project_id}/design/standards/templates

{
  "fd_name" : "自定义项三",
  "fd_name_en" : "CustomField3",
  "description" : "自定义项三",
  "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" : "test_uesr",
  "update_by" : "test_uesr"
}

响应示例

状态码: 200

Success

{
  "data" : {
    "value" : {
      "fd_name" : "自定义项三",
      "fd_name_en" : "CustomField3",
      "description" : "自定义项三",
      "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" : "test_uesr",
      "update_by" : "test_uesr"
    }
  }
}

状态码: 400

{
  "error_code" : "DS.60xx",
  "error_msg" : "The user request is illegal."
}

状态码: 401

{
  "error_code" : "DS.60xx",
  "error_msg" : "User authentication failed."
}

状态码: 403

{
  "error_code" : "DS.60xx",
  "error_msg" : "The user does not have permission to call this API."
}

状态码: 404

{
  "error_code" : "DS.60xx",
  "error_msg" : "The User Request API does not exist."
}

SDK代码示例

SDK代码示例如下。

创建当前工作空间下的数据标准模板自定义项。

 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("test_uesr");
        body.withCreateBy("test_uesr");
        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("自定义项三");
        body.withFdNameEn("CustomField3");
        body.withFdName("自定义项三");
        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());
        }
    }
}

创建当前工作空间下的数据标准模板自定义项。

 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="test_uesr",
            create_by="test_uesr",
            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="自定义项三",
            fd_name_en="CustomField3",
            fd_name="自定义项三"
        )
        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)

创建当前工作空间下的数据标准模板自定义项。

 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:= "test_uesr"
	createByStandElementFieldVo:= "test_uesr"
	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:= "自定义项三"
	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: "自定义项三",
	}
	response, err := client.CreateStandardTemplate(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

Success

400

BadRequest

401

Unauthorized

403

Forbidden

404

Not Found