Help Center/ DataArts Studio/ API Reference/ DataArts Architecture APIs/ Data Standard Templates/ Creating a Data Standard Template
Updated on 2025-11-17 GMT+08:00
View PDF

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

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

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, which is a string

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

Table 4 Response body parameters

Parameter

Type

Description

data

data object

data: unified outermost data structure of the returned result.
Table 5 data

Parameter

Type

Description

value

StandElementFieldVO object

value: unified outer data structure of the returned result.
Table 6 StandElementFieldVO

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

Table 7 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 8 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 9 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 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.

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" : "test_uesr",
  "update_by" : "test_uesr"
}

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" : "test_uesr",
      "update_by" : "test_uesr"
    }
  }
}

Status code: 400

BadRequest

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

Status code: 401

Unauthorized

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

Status code: 403

Forbidden

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

Status code: 404

Not Found

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

Status Codes

Status Code

Description

200

Success

400

BadRequest

401

Unauthorized

403

Forbidden

404

Not Found
Parent Topic: Data Standard Templates