Help Center/ DataArts Studio/ API Reference/ DataArts Architecture APIs/ Data Standard Template APIs/ Initializing a Data Standard Template
Updated on 2022-09-15 GMT+08:00
View PDF

Initializing a Data Standard Template

Function

This API is used to initialize a data standard template.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

action-id

Yes

String

action-id=init

Request Parameters

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

fields

No

Array of StandElementFieldVO objects

Fields
Table 4 StandElementFieldVO

Parameter

Mandatory

Type

Description

fd_name

Yes

String

Field name

description

No

String

Field description

id

No

Long

ID

actived

No

Boolean

Whether to display the field. The default value cannot be changed.

required

No

Boolean

Whether the field is mandatory

searchable

No

Boolean

Whether the field is searchable

displayed_name

No

String

Field name displayed at the frontend

displayed_name_en

No

String

Field name (English) displayed at the frontend

create_time

No

String

Creation time

update_time

No

String

Update time

create_by

No

String

Creator

update_by

No

String

User who updated the field

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

fd_name

String

Field name

description

String

Field description

id

Long

ID

actived

Boolean

Whether to display the field. The default value cannot be changed.

required

Boolean

Whether the field is mandatory

searchable

Boolean

Whether the field is searchable

displayed_name

String

Field name displayed at the frontend

displayed_name_en

String

Field name (English) displayed at the frontend

create_time

String

Creation time

update_time

String

Update time

create_by

String

Creator

update_by

String

User who updated the field

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.000 which indicates that the request was successfully processed.

error_msg

String

Error message

data

Object

Returned data

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.000 which indicates that the request was successfully processed.

error_msg

String

Error message

data

Object

Returned data

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.000 which indicates that the request was successfully processed.

error_msg

String

Error message

data

Object

Returned data

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.000 which indicates that the request was successfully processed.

error_msg

String

Error message

data

Object

Returned data

Example Requests

{
  "fields" : [ {
    "fd_name" : "nameEn",
    "description" : "Standard code",
    "id" : "793889740666605568",
    "actived" : true,
    "required" : true,
    "searchable" : true,
    "displayed_name" : "Standard code",
    "displayed_name_en" : "Standard code"
  }, {
    "fd_name" : "dataType",
    "description" : "Data type",
    "id" : "793889740775657472",
    "actived" : true,
    "required" : true,
    "searchable" : true,
    "displayed_name" : "Data type",
    "displayed_name_en" : "Data type"
  } ]
}

Example Responses

Status code: 200

Success

{
  "data" : {
    "value" : [ {
      "xxx" : "StandElementFieldVO"
    } ]
  }
}

Status Codes

Status Code

Description

200

Success

400

BadRequest

401

Unauthorized

403

Forbidden

404

Not Found