Creating a Topic (New)

Function

Create a topic (new).

Calling Method

For details, see Calling APIs.

URI

POST /v3/{project_id}/design/subjects

**Table 1** Path Parameters
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

**Table 2** Request header 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.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
id	No	String	ID, which is a string. This parameter is mandatory for update and can be left empty for creation.
name_ch	Yes	String	Chinese name
name_en	Yes	String	English name.
description	No	String	Description, which is mandatory for the business object.
alias	No	String	Alias
data_owner	No	String	Data owner department.
data_owner_list	Yes	String	Data owner. Array format: ["user_1","user_2"].
level	Yes	Integer	Indicates the level. The value ranges from 1 to 7.
parent_id	No	String	Upper-layer subject ID, which is a string. This parameter is left empty for the first layer.
self_defined_fields	No	Array of SelfDefinedFieldVO objects	User-defined item. Customized attribute of a theme.

**Table 4** SelfDefinedFieldVO
Parameter	Mandatory	Type	Description
fd_name_ch	No	String	Chinese name of a user-defined item.
fd_name_en	No	String	English name of a customized item.
not_null	No	Boolean	Whether a parameter is mandatory.
fd_value	No	String	Attribute value

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
data	data object	data: unified outermost data structure of the returned result.

**Table 6** data
Parameter	Type	Description
value	CatalogVO object	CatalogVO information.

**Table 7** CatalogVO
Parameter	Type	Description
name_ch	String	Chinese name
name_en	String	English name.
description	String	Description
qualified_name	String	File name extension.
guid	String	GUID, which is automatically generated.
code	String	Code.
alias	String	Alias
status	String	Release status of an entity. This parameter is read-only and does not need to be set during creation and update. Options: DRAFT: draft PUBLISH_DEVELOPING: to be reviewed PUBLISHED: released OFFLINE_DEVELOPING: to be reviewed OFFLINE: offline REJECT: rejected
new_biz	BizVersionManageVO object	Service version management. This parameter is read-only.
data_owner	String	Data owner.
data_owner_list	String	Data owner set.
data_department	String	Data domain.
path	String	Path information.
level	Integer	Level information.
ordinal	Integer	Sequence number.
owner	String	Owner of the instance.
parent_id	String	Parent directory ID, which is a string. If no parent directory ID exists, the parent directory is the root directory.
swap_order_id	String	ID of the target node at the same layer, which is a string
id	String	Subject ID, which is a string
qualified_id	String	Authentication ID, which is automatically generated.
from_public	Boolean	Indicates whether the data is from the public layer.
create_by	String	Creator.
update_by	String	Person who updates the information.
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.
children_num	Integer	Number of subprocesses, excluding subprocesses. This parameter is not transferred from the front end.
children	Array of CatalogVO objects	Lower-level subdirectory, which is read-only.
self_defined_fields	Array of SelfDefinedFieldVO objects	Customize Attribute Field:

**Table 8** BizVersionManageVO
Parameter	Type	Description
id	String	Field ID, which is a string
biz_type	String	Business entity type. Options: AGGREGATION_LOGIC_TABLE: summary table ATOMIC_INDEX: atomic metric ATOMIC_METRIC: atomic metric (new) BIZ_CATALOG: process architecture directory BIZ_METRIC: service indicator CODE_TABLE: code table COMMON_CONDITION: general filter COMPOSITE_METRIC: Compound Metric (new) COMPOUND_METRIC: compound metric CONDITION_GROUP: restriction group DEGENERATE_DIMENSION: degenerate dimension DERIVATIVE_INDEX: derivative indicator DERIVED_METRIC: derivative indicator (new) DIMENSION: dimension DIMENSION_ATTRIBUTE: dimension attribute DIMENSION_HIERARCHIES: dimension level DIMENSION_LOGIC_TABLE: dimension table DIMENSION_TABLE_ATTRIBUTE: dimension attribute DIRECTORY: directory FACT_ATTRIBUTE: fact table attribute FACT_DIMENSION: fact table dimension FACT_LOGIC_TABLE: fact table FACT_MEASURE: fact table measurement FUNCTION: function INFO_ARCH: information architecture (used for modifying themes in batches) MODEL: model QUALITY_RULE: quality rule SECRECY_LEVEL: security level STANDARD_ELEMENT: data standard STANDARD_ELEMENT_TEMPLATE: data standard template SUBJECT: theme Dimension attributes of SUMMARY_DIMENSION_ATTRIBUTE: summary tables SUMMARY_INDEX: summary table indicator attribute SUMMARY_TIME: time period attribute of the SDR table TABLE_MODEL: relationship model (logical model/physical model) TABLE_MODEL_ATTRIBUTE: relationship model attribute (logical model/physical model) TABLE_MODEL_LOGIC: logical entity TABLE_TYPE: table type TAG: tag TIME_CONDITION: time restriction
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: DRAFT: draft PUBLISH_DEVELOPING: to be reviewed PUBLISHED: released OFFLINE_DEVELOPING: to be reviewed OFFLINE: offline REJECT: rejected
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.

**Table 9** SelfDefinedFieldVO
Parameter	Type	Description
fd_name_ch	String	Chinese name of a user-defined item.
fd_name_en	String	English name of a customized item.
not_null	Boolean	Whether a parameter is mandatory.
fd_value	String	Attribute value

Status code: 400

**Table 10** Response body parameters
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

**Table 11** Response body parameters
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

**Table 12** Response body parameters
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

**Table 13** Response body parameters
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

Create a topic (new).

POST https://{endpoint}/v2/{project_id}/design/subjects

{
  "name_ch" : "test_create_catalog_demo",
  "name_en" : "test_create_catalog_demo",
  "description" : "this is a demo.",
  "alias" : "",
  "data_owner" : "",
  "data_owner_list" : "[\"test_uesr\"]",
  "self_defined_fields" : [ ],
  "level" : 1
}

Example Responses

Status code: 200

This operation succeeds, and the returned data is entity details.

{
  "data" : {
    "value" : {
      "name_ch" : "test_create_catalog_demo",
      "name_en" : "test_create_catalog_demo",
      "description" : "this is a demo.",
      "qualified_name" : "test_create_catalog_demo@Business.0833a5737480d53b2f25c010dc1a7b88-workspace-9ce2cfd08fda4f3b95faa5ba65fa5ec3",
      "guid" : null,
      "code" : null,
      "status" : "DRAFT",
      "new_biz" : null,
      "alias" : "",
      "data_owner" : "",
      "data_owner_list" : "[\"test_uesr\"]",
      "data_department" : null,
      "path" : "test_create_catalog_demo",
      "level" : 1,
      "ordinal" : 11,
      "owner" : "test_uesr",
      "parent_id" : null,
      "swap_order_id" : null,
      "id" : "1232018366517129216",
      "qualified_id" : null,
      "from_public" : null,
      "create_by" : "test_uesr",
      "update_by" : "test_uesr",
      "create_time" : "2024-04-22T17:21:08.372+08:00",
      "update_time" : "2024-04-22T17:21:08.372+08:00",
      "self_defined_fields" : [ ],
      "children_num" : null,
      "children" : 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.

Create a topic (new).

      
       
         
         
           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 CreateSubjectNewSolution {

    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();
        CreateSubjectNewRequest request = new CreateSubjectNewRequest();
        SubjectParamsVO body = new SubjectParamsVO();
        body.withLevel(1);
        body.withDataOwnerList("["test_uesr"]");
        body.withDataOwner("");
        body.withAlias("");
        body.withDescription("this is a demo.");
        body.withNameEn("test_create_catalog_demo");
        body.withNameCh("test_create_catalog_demo");
        request.withBody(body);
        try {
            CreateSubjectNewResponse response = client.createSubjectNew(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());
        }
    }
}

          

        

      
     

Create a topic (new).

      
       
         
         
           # 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 = CreateSubjectNewRequest()
        request.body = SubjectParamsVO(
            level=1,
            data_owner_list="["test_uesr"]",
            data_owner="",
            alias="",
            description="this is a demo.",
            name_en="test_create_catalog_demo",
            name_ch="test_create_catalog_demo"
        )
        response = client.create_subject_new(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

          

        

      
     

Create a topic (new).

      
       
         
         
           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.CreateSubjectNewRequest{}
	dataOwnerSubjectParamsVo:= ""
	aliasSubjectParamsVo:= ""
	descriptionSubjectParamsVo:= "this is a demo."
	request.Body = &model.SubjectParamsVo{
		Level: int32(1),
		DataOwnerList: "["test_uesr"]",
		DataOwner: &dataOwnerSubjectParamsVo,
		Alias: &aliasSubjectParamsVo,
		Description: &descriptionSubjectParamsVo,
		NameEn: "test_create_catalog_demo",
		NameCh: "test_create_catalog_demo",
	}
	response, err := client.CreateSubjectNew(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

          

        

      
     