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

Performing a Batch Offline Operation

Function

This API is used to perform a batch offline operation.

URI

POST /v2/{project_id}/design/approvals/batch-offline

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

biz_infos

Yes

Array of BizInfoVO objects

List of business information

approver_user_id

Yes

String

Approver ID

approver_user_name

Yes

String

Approver username

email

No

String

Approver email address

fast_approval

No

Boolean

Fast approval for quick experience in informal scenario. This function is available only when you have the approval permission.

Default: false

schedule_time

No

String

Job scheduling time

Table 3 BizInfoVO

Parameter

Mandatory

Type

Description

biz_id

Yes

Long

Business ID

biz_type

Yes

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

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

id

Long

ID

tenant_id

String

tenant id

group_id

Long

group id

biz_name

String

Business name

biz_id

Long

Business ID

operation_status

String

Enumeration values:

  • RUNNING

  • SUCCESS

  • FAILED

operation_type

String

Operation type

biz_info

String

Business information

create_by

String

Creator

remark

String

Remarks

total

Integer

Total number of operations

Default: 0

success

Integer

Number of successful operations

Default: 0

failed

Integer

Number of failed operations

Default: 0

rate

String

Progress

Default: 0

logs

String

Logs

groups

Array of BatchOperationVO objects

Groups

Status code: 400

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

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

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: 404

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

{
  "approver_user_id" : "7b71e498e75d44048c9a22dd3c54f978",
  "approver_user_name" : "ei_dlg",
  "biz_infos" : [ {
    "biz_id" : "885123875376193536",
    "biz_type" : "CODE_TABLE"
  }, {
    "biz_id" : "885123958788317184",
    "biz_type" : "CODE_TABLE"
  } ],
  "email" : null,
  "fast_approval" : true
}

Example Responses

Status code: 200

The operation succeeds. The BatchOperationVO object in the BatchOperationVO.group attribute is returned.

{
  "data" : {
    "value" : {
      "SUCCESS" : [ "name1-id", "name2-id" ],
      "errors" : "[{id: 111, reason: exceptions}]"
    }
  }
}

Status Codes

Status Code

Description

200

The operation succeeds. The BatchOperationVO object in the BatchOperationVO.group attribute is returned.

400

BadRequest

401

Unauthorized

403

Forbidden

404

Not Found