Querying Data Standard Templates
Function
This API is used to query data standard templates.
URI
GET /v2/{project_id}/design/standards/templates
| 
        Parameter  | 
      
        Mandatory  | 
      
        Type  | 
      
        Description  | 
     
|---|---|---|---|
| 
        project_id  | 
      
        Yes  | 
      
        String  | 
      
        Project ID  | 
     
Request Parameters
None
Response Parameters
Status code: 200
| 
        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
| 
        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
| 
        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
| 
        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
| 
        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"
}
 Status Codes
| 
        Status Code  | 
      
        Description  | 
     
|---|---|
| 
        200  | 
      
        The operation succeeds. StandElementFieldVO is returned.  | 
     
| 
        400  | 
      
        BadRequest  | 
     
| 
        401  | 
      
        Unauthorized  | 
     
| 
        403  | 
      
        Forbidden  | 
     
| 
        404  | 
      
        Not Found  | 
     
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.