Querying Data Standard Templates

Updated on 2022-09-15 GMT+08:00

View PDF

Function

This API is used to query data standard templates.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** 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 3** 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 4** 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 5** 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 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

Example Requests

None

Example Responses

Status code: 200

The operation succeeds. StandElementFieldVO is returned.

{
  "fd_name" : "nameEn",
  "description" : "Standard code",
  "id" : "793889740666605568",
  "actived" : true,
  "required" : true,
  "searchable" : true,
  "displayed_name" : "Standard code",
  "displayed_name_en" : "Standard code"
}