Querying Filter Details

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

View PDF

Function

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

URI

GET /v2/{project_id}/design/conditions/{id}

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
latest	No	Boolean	Whether to query the latest data

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
id	Long	ID
name_en	String	Filter name in English Maximum: 100
name_ch	String	Filter name in Chinese Maximum: 250
description	String	Maximum: 600
create_by	String	Creator
condition_fn	String	Filter calculation method Enumeration values: LAST_YEAR CURRENT_YEAR BETWEEN_YEAR LAST_MONTH CURRENT_MONTH BETWEEN_MONTH LAST_DAY CURRENT_DAY BETWEEN_DAY LAST_HOUR CURRENT_HOUR BETWEEN_HOUR LAST_MINUTE CURRENT_MINUTE BETWEEN_MINUTE
condition_fn_param	String	Filter calculation parameters
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
base_time	Integer	Baseline time

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

Status code: 400

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

Status code: 401

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

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

Example Requests

None

Example Responses

Status code: 200

The operation succeeds. ConditionVO is returned.

[ {
  "id" : "873154196235517965",
  "name_en" : "f4w",
  "name_ch" : "Next 4 weeks",
  "description" : "Average daily value of historical data x 7 x 4",
  "create_by" : "SYSTEM",
  "condition_fn" : "BETWEEN_DAY",
  "condition_fn_param" : "1,28",
  "status" : "PUBLISHED",
  "create_time" : "2021-08-06T10:43:03+08:00",
  "update_time" : "2021-08-06T10:43:03+08:00",
  "approval_info" : null,
  "new_biz" : null,
  "base_time" : null
} ]