Querying Lookup Table Details

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

View PDF

Function

This API is used to query the details of a lookup table based on the ID.

URI

GET /v2/{project_id}/design/code-tables/{id}

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

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
id	Long	ID
name_en	String	Table name in English Maximum: 200
name_ch	String	Table name in Chinese Maximum: 200
tb_version	Integer	Table version
directory_id	Long	Catalog ID
directory_path	String	Catalog tree
description	String	Description Maximum: 600
create_by	String	Creator
status	String	Business statuses Enumeration values: DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT
create_time	String	Creation time
update_time	String	Update time
approval_info	ApprovalVO object	Approval information
new_biz	BizVersionManageVO object	Business version management
code_table_fields	Array of CodeTableFieldVO objects	Lookup table attribute information

**Table 3** ApprovalVO
Parameter	Type	Description
id	Long	ID
tenant_id	String	tenant id
name_ch	String	Approval name in Chinese
name_en	String	Approval name in English
biz_id	Long	Business ID
biz_type	String	Business types Enumeration values: ATOMIC_INDEX DERIVATIVE_INDEX DIMENSION DIMENSION_ATTRIBUTE DIMENSION_HIERARCHIES CONDITION_GROUP TIME_CONDITION COMMON_CONDITION FACT_LOGIC_TABLE TABLE_MODEL DIMENSION_LOGIC_TABLE STANDARD_ELEMENT AGGREGATION_LOGIC_TABLE TAG CODE_TABLE TABLE_MODEL_ATTRIBUTE FACT_DIMENSION FACT_ATTRIBUTE FACT_MEASURE SUMMARY_DIMENSION_ATTRIBUTE SUMMARY_TIME DIMENSION_TABLE_ATTRIBUTE QUALITY_RULE BIZ_METRIC COMPOUND_METRIC INFO_ARCH DEGENERATE_DIMENSION TABLE_MODEL_LOGIC
biz_info	String	Business information
biz_info_obj	Object	Business information object
biz_version	Integer	Business version
biz_status	String	Business statuses Enumeration values: DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT
approval_status	String	Approval statuses Enumeration values: DEVELOPING APPROVED REJECT WITHDREW
approval_type	String	Approval types Enumeration values: PUBLISH OFFLINE
submit_time	String	Submission time
create_by	String	Creator
l1	String	Subject area group
l2	String	Subject area
l3	String	Business object
approval_time	String	Approval time
approver	String	Approver
email	String	Approver email address
msg	String	Approval message
directory_path	String	Directory tree

**Table 4** BizVersionManageVO
Parameter	Type	Description
id	Long	ID information
biz_type	String	Business types Enumeration values: ATOMIC_INDEX DERIVATIVE_INDEX DIMENSION DIMENSION_ATTRIBUTE DIMENSION_HIERARCHIES CONDITION_GROUP TIME_CONDITION COMMON_CONDITION FACT_LOGIC_TABLE TABLE_MODEL DIMENSION_LOGIC_TABLE STANDARD_ELEMENT AGGREGATION_LOGIC_TABLE TAG CODE_TABLE TABLE_MODEL_ATTRIBUTE FACT_DIMENSION FACT_ATTRIBUTE FACT_MEASURE SUMMARY_DIMENSION_ATTRIBUTE SUMMARY_TIME DIMENSION_TABLE_ATTRIBUTE QUALITY_RULE BIZ_METRIC COMPOUND_METRIC INFO_ARCH DEGENERATE_DIMENSION TABLE_MODEL_LOGIC
biz_id	Long	Business ID
biz_info	String	Business object information
status	String	Business statuses Enumeration values: DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT
biz_version	Integer	Business version
create_time	String	Creation time
update_time	String	Update time

**Table 5** CodeTableFieldVO
Parameter	Type	Description
id	Long	ID
code_table_id	Long	Lookup table ID
ordinal	Integer	Ordinal
name_en	String	Field name in English Maximum: 600
name_ch	String	Field name in Chinese Maximum: 200
description	String	Description Maximum: 600
data_type	String	Data type
domain_type	String	Data type domains Enumeration values: NUMBER STRING DATETIME BLOB OTHER
data_type_extend	String	Data type extended field Maximum: 50
is_unique_key	Boolean	Whether the attribute is unique Default: false
code_table_field_values	Array of CodeTableFieldValueVO objects	Lookup table attribute value
count_field_values	Integer	Number of lookup table attribute values

**Table 6** CodeTableFieldValueVO
Parameter	Type	Description
id	Long	ID
fd_id	Long	Lookup table attribute ID
fd_value	String	Lookup table attribute value
ordinal	Integer	Ordinal
description	String	Description Maximum: 600

Status code: 400

**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: 401

**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: 403

**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

Status code: 404

**Table 10** 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. CodeTableVO is returned.

{
  "id" : "1012307352952635392",
  "name_en" : "RY_000001",
  "name_ch" : "Gender",
  "tb_version" : 0,
  "directory_id" : "1012307270173851648",
  "directory_path" : null,
  "description" : "",
  "create_by" : "abc",
  "status" : "PUBLISHED",
  "create_time" : "2022-08-25T10:28:01+08:00",
  "update_time" : "2022-08-25T10:31:08+08:00",
  "approval_info" : null,
  "new_biz" : null,
  "code_table_fields" : [ {
    "id" : "66929",
    "code_table_id" : "1012307352952635392",
    "ordinal" : 1,
    "name_en" : "code",
    "name_ch" : "Code",
    "description" : "",
    "data_type" : "STRING",
    "domain_type" : null,
    "data_type_extend" : null,
    "is_unique_key" : false,
    "code_table_field_values" : [ ],
    "count_field_values" : null
  }, {
    "id" : "66930",
    "code_table_id" : "1012307352952635392",
    "ordinal" : 2,
    "name_en" : "value",
    "name_ch" : "Value",
    "description" : "",
    "data_type" : "STRING",
    "domain_type" : null,
    "data_type_extend" : null,
    "is_unique_key" : false,
    "code_table_field_values" : [ ],
    "count_field_values" : null
  } ]
}