Searching for Version Information
Function
Search for version information by name, creator, and modification time.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/design/versions
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID. For details about how to obtain the project ID, see Project ID and Account ID. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| name | No | String | Fuzzy query by name or code. |
| create_by | No | String | Query by creator. |
| biz_id | No | String | Business definition ID, which is a string |
| biz_type | No | String | Query by service type. The options are ATOMIC_INDEX (atomic indicator), DERIVATIVE_INDEX (derivative indicator), DIMENSION (dimension), and TIME_CONDITION (time filter). DIMENSION_LOGIC_TABLE (dimension table), FACT_LOGIC_TABLE (fact table), AGGREGATION_LOGIC_TABLE (summary table), TABLE_MODEL (relational modeling table), CODE_TABLE (code table), STANDARD_ELEMENT) (data standard), BIZ_METRIC (business metric), COMPOUND_METRIC (compound metric), SUBJECT (subject), ATOMIC_METRIC (atomic metric (new)), DERIVED_METRIC (Derivative (new)), COMPOSITE_METRIC (Compound (new))). |
| begin_time | No | String | Left boundary of time filtering. This parameter is used together with end_time. Only time range filtering is supported. Unilateral filtering is invalid. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z. |
| end_time | No | String | Right boundary for time filtering. This parameter is used together with begin_time to support only time range filtering. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z. |
| limit | No | Integer | Number of records to be queried on each page, that is, Y records to be queried. The default value is 50, and the value range is [1,100]. |
| offset | No | Integer | Start coordinate of the query, that is, the number of skipped data records. The value can only be 0 or an integer multiple of limit. If the value does not meet the requirement, the value is rounded down. The default value is 0. |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | IAM token, which is obtained by calling the IAM API for obtaining a user token (value of X-Subject-Token in the response header). This field is mandatory for authentication using tokens. |
| workspace | Yes | String | Workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID. |
| X-Project-Id | No | String | Project ID. For details about how to obtain the project ID, see Project ID and Account ID. This parameter is mandatory for API requests that use AK/SK authentication in multi-project scenarios. |
| Content-Type | No | String | Default value: application/json;charset=UTF-8 This parameter is optional. If the body is available, this parameter is mandatory. If the body is unavailable, you do not need to set this parameter or verify it. |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| data | data object | Returned data. |
| Parameter | Type | Description |
|---|---|---|
| records | Array of PublishVersionVO objects | Number of queried version value objects (PublishVersionVO). |
| total | Integer | Total number of records that meet the search criteria. |
| Parameter | Type | Description |
|---|---|---|
| id | String | Version ID, which is a string |
| version_name | String | Version name. |
| version_tag | String | Version flag, which is read-only. |
| description | String | Version description. |
| biz_id | String | Business object ID, which is a string |
| biz_type | String | Business entity type. Options:
|
| biz_info | String | Service details. This parameter is read-only. |
| biz_info_vo | Object | Business object. |
| effect_objs | String | Impact information. This parameter is read-only. |
| change_props | String | Indicates the change information. This parameter is read-only. |
| sql_ddl | String | SQL script, which is read-only. |
| physical_table | String | Synchronization status. Options:
|
| dev_physical_table | String | Synchronization status. Options:
|
| technical_asset | String | Synchronization status. Options:
|
| business_asset | String | Synchronization status. Options:
|
| meta_data_link | String | Synchronization status. Options:
|
| data_quality | String | Synchronization status. Options:
|
| dlf_task | String | Synchronization status. Options:
|
| materialization | String | Synchronization status. Options:
|
| publish_to_dlm | String | Synchronization status. Options:
|
| biz_metric | String | Synchronization status. Options:
|
| summary_status | String | Synchronization status. Options:
|
| is_current_version | Boolean | Indicates whether the version is the current version. This parameter is read-only. |
| create_time | String | Creation time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z. |
| create_by | String | Creator, which is read-only. |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code, for example, DS.6000, indicating that the request fails to be processed. |
| error_msg | String | Error message |
| data | Object | Returned data information. |
Status code: 401
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code, for example, DS.6000, indicating that the request fails to be processed. |
| error_msg | String | Error message |
| data | Object | Returned data information. |
Status code: 403
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code, for example, DS.6000, indicating that the request fails to be processed. |
| error_msg | String | Error message |
| data | Object | Returned data information. |
Example Requests
Query the version information based on the service object ID.
GET https://{endpoint}/v2/{project_id}/design/versions?biz_id=1193199235202428928 Example Responses
Status code: 200
This operation is successful. The returned data is a PublishVersionVO array and the total number of records.
{
"data" : {
"value" : {
"total" : 1,
"records" : [ {
"id" : "1196551286263267328",
"version_name" : "V1.0",
"version_tag" : "test_czh_001_2024-01-15_20-27-37_493",
"description" : null,
"biz_id" : "1193199235202428928",
"biz_type" : "BIZ_METRIC",
"biz_info" : null,
"biz_info_vo" : null,
"effect_objs" : null,
"change_props" : null,
"sql_ddl" : null,
"physical_table" : null,
"technical_asset" : null,
"business_asset" : "CREATE_SUCCESS",
"meta_data_link" : null,
"data_quality" : null,
"dlf_task" : null,
"materialization" : null,
"publish_to_dlm" : null,
"biz_metric" : "CREATE_SUCCESS",
"summary_status" : "SUMMARY_SUCCESS",
"is_current_version" : true,
"create_time" : "2024-01-15T20:27:37+08:00",
"create_by" : "test_uesr"
} ]
}
}
} Status code: 400
BadRequest
{
"error_code" : "DS.60xx",
"error_msg" : "The user request is illegal."
} Status code: 401
Unauthorized
{
"error_code" : "DS.60xx",
"error_msg" : "User authentication failed."
} Status code: 403
Forbidden
{
"error_code" : "DS.60xx",
"error_msg" : "The user does not have permission to call this API."
} Status Codes
| Status Code | Description |
|---|---|
| 200 | This operation is successful. The returned data is a PublishVersionVO array and the total number of records. |
| 400 | BadRequest |
| 401 | Unauthorized |
| 403 | Forbidden |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
