Querying Versions

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

View PDF

Function

This API is used to query versions based on the name, creator, and modification time.

URI

GET /v2/{project_id}/design/versions

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
name	No	String	Fuzzy query by name or code
create_by	No	String	Creator
biz_id	No	Long	Business ID
biz_type	No	String	Business types
begin_time	No	String	Left boundary for a time filter. This parameter must be used together with end_time.
end_time	No	String	Right boundary for a time filter. This parameter must be used together with begin_time.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
id	Long	Version ID
version_name	String	Version name
version_tag	String	Version tag
description	String	Version description
biz_id	Long	Business object 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_vo	Object	Business object
effect_objs	String	Impact information
change_props	String	Change information
sql_ddl	String	SQL script
physical_table	String	Table creation status Enumeration values: NO_NEED CREATE_SUCCESS CREATE_FAILED UPDATE_SUCCESS UPDATE_FAILED SUMMARY_SUCCESS SUMMARY_FAILED RUNNING OFFLINE
technical_asset	String	Technical asset synchronization status Enumeration values: NO_NEED CREATE_SUCCESS CREATE_FAILED UPDATE_SUCCESS UPDATE_FAILED SUMMARY_SUCCESS SUMMARY_FAILED RUNNING OFFLINE
business_asset	String	Logical asset synchronization status Enumeration values: NO_NEED CREATE_SUCCESS CREATE_FAILED UPDATE_SUCCESS UPDATE_FAILED SUMMARY_SUCCESS SUMMARY_FAILED RUNNING OFFLINE
meta_data_link	String	Asset association status Enumeration values: NO_NEED CREATE_SUCCESS CREATE_FAILED UPDATE_SUCCESS UPDATE_FAILED SUMMARY_SUCCESS SUMMARY_FAILED RUNNING OFFLINE
data_quality	String	Quality job status Enumeration values: NO_NEED CREATE_SUCCESS CREATE_FAILED UPDATE_SUCCESS UPDATE_FAILED SUMMARY_SUCCESS SUMMARY_FAILED RUNNING OFFLINE
dlf_task	String	Data development job status Enumeration values: NO_NEED CREATE_SUCCESS CREATE_FAILED UPDATE_SUCCESS UPDATE_FAILED SUMMARY_SUCCESS SUMMARY_FAILED RUNNING OFFLINE
materialization	String	Storage status of the lookup table value Enumeration values: NO_NEED CREATE_SUCCESS CREATE_FAILED UPDATE_SUCCESS UPDATE_FAILED SUMMARY_SUCCESS SUMMARY_FAILED RUNNING OFFLINE
publish_to_dlm	String	DLM API generation status Enumeration values: NO_NEED CREATE_SUCCESS CREATE_FAILED UPDATE_SUCCESS UPDATE_FAILED SUMMARY_SUCCESS SUMMARY_FAILED RUNNING OFFLINE
biz_metric	String	Business metric synchronization status Enumeration values: NO_NEED CREATE_SUCCESS CREATE_FAILED UPDATE_SUCCESS UPDATE_FAILED SUMMARY_SUCCESS SUMMARY_FAILED RUNNING OFFLINE
summary_status	String	Summary status Enumeration values: NO_NEED CREATE_SUCCESS CREATE_FAILED UPDATE_SUCCESS UPDATE_FAILED SUMMARY_SUCCESS SUMMARY_FAILED RUNNING OFFLINE
is_current_version	Boolean	Whether the version is the current version Default: false
create_time	String	Creation time
create_by	String	Creator

Status code: 400

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

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

**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. The PublishVersionVO array and the total number of versions are returned.

{
  "id" : "1012308140932370432",
  "version_name" : "Gender_2022-08-25_10-31-08_575",
  "version_tag" : "Gender_2022-08-25_10-31-08_575",
  "description" : null,
  "biz_id" : "1012307352952635392",
  "biz_type" : "CODE_TABLE",
  "biz_info" : null,
  "biz_info_vo" : null,
  "effect_objs" : null,
  "change_props" : null,
  "sql_ddl" : null,
  "physical_table" : null,
  "technical_asset" : null,
  "business_asset" : null,
  "meta_data_link" : null,
  "data_quality" : null,
  "dlf_task" : null,
  "materialization" : null,
  "publish_to_dlm" : null,
  "biz_metric" : null,
  "summary_status" : "SUMMARY_SUCCESS",
  "is_current_version" : true,
  "create_time" : "2022-08-25T10:31:09+08:00",
  "create_by" : "abc"
}