Querying Approvals

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

View PDF

Function

Querying Approvals

URI

GET /v2/{project_id}/design/approvals

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
biz_id	No	Long	Business ID
name	No	String	Fuzzy query by name or code
create_by	No	String	Creator
approver	No	String	Approver
approval_status	No	String	Approval status Enumeration values: DEVELOPING FINISHED
approval_status_detail	No	String	Approval status details Enumeration values: DEVELOPING APPROVED REJECT
approval_type	No	String	Approval type Enumeration values: PUBLISH OFFLINE
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.
limit	No	Integer	Number of records to be queried, that is, Y records. The value ranges from 1 to 100. The default value is 50. Maximum: 100 Default: 50
offset	No	Integer	Query offset, that is, X data records are skipped. The value must be 0 or an integer multiple of limit. If the value does not meet the requirements, it will be rounded down. The default value is 0. Default: 0

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
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

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

Status code: 404

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

Example Requests

None

Example Responses

Status code: 200

The operation succeeds. The ApprovalVO array and the total number of approvals are returned.

{
  "id" : "1014218490837635072",
  "tenant_id" : "0cf68da0ba80f2962ff7c01ba8c0b7f7-workspace-f7eee36e67e541a59679f9b1b7f4eab0",
  "name_ch" : "Gender",
  "name_en" : "RY_000001",
  "biz_id" : "1012307352952635392",
  "biz_type" : "CODE_TABLE",
  "biz_info" : "",
  "biz_info_obj" : {
    "id" : "1012307352952635392",
    "name_en" : "RY_000001",
    "name_ch" : "Gender",
    "tb_version" : 0,
    "directory_id" : "1012307270173851648",
    "directory_path" : null,
    "description" : "",
    "create_by" : "abc",
    "status" : "DRAFT",
    "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
    } ]
  },
  "biz_version" : 0,
  "biz_status" : "PUBLISHED",
  "approval_status" : "WITHDREW",
  "approval_type" : "OFFLINE",
  "submit_time" : "2022-08-30T17:02:11+08:00",
  "create_by" : "abc",
  "l1" : null,
  "l2" : null,
  "l3" : null,
  "approval_time" : "2022-08-30T17:02:23+08:00",
  "approver" : "abc",
  "email" : null,
  "msg" : null,
  "directory_path" : null
}

Status Codes

Status Code	Description
200	The operation succeeds. The ApprovalVO array and the total number of approvals are returned.
400	BadRequest
401	Unauthorized
403	Forbidden
404	Not Found