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

Querying the Import Result

Function

This API is used to query the result of data import to an Excel file.

URI

GET /v2/{project_id}/design/catelogs/process-import

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

tenant id

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

uuid

Yes

String

Import result to be queried

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

status

String

Status used to query the import result

Enumeration values:

  • importing

  • fail

  • success

group

BatchOperationVO object

Group

rate

String

Progress

Default: 0

Table 4 BatchOperationVO

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

data

Object

Returned data

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

data

Object

Returned data

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

data

Object

Returned data

Example Requests

None

Example Responses

Status code: 200

The operation succeeds. DsProcessImportResultVO is returned.

{
  "status" : "success",
  "group" : {
    "id" : null,
    "tenant_id" : "0cf68da0ba80f2962ff7c01ba8c0b7f7-workspace-f7eee36e67e541a59679f9b1b7f4eab0",
    "group_id" : "1014919548664713216",
    "biz_name" : null,
    "biz_id" : null,
    "operation_status" : "SUCCESS",
    "operation_type" : "IMPORT_CODETABLE",
    "biz_info" : null,
    "create_by" : "abc",
    "remark" : null,
    "total" : 2,
    "success" : 2,
    "failed" : 0,
    "rate" : "1.00",
    "logs" : null,
    "groups" : [ {
      "id" : "1014919548861845504",
      "tenant_id" : "0cf68da0ba80f2962ff7c01ba8c0b7f7-workspace-f7eee36e67e541a59679f9b1b7f4eab0",
      "group_id" : "1014919548664713216",
      "biz_name" : "test",
      "biz_id" : null,
      "operation_status" : "SUCCESS",
      "operation_type" : "IMPORT_CODETABLE",
      "biz_info" : "{\"op_name\":\"test\",\"op_number\":0}",
      "create_by" : "abc",
      "remark" : "SKIP",
      "total" : 0,
      "success" : 0,
      "failed" : 0,
      "rate" : null,
      "logs" : null,
      "groups" : null
    } ]
  },
  "rate" : "1.00"
}

Status Codes

Status Code

Description

200

The operation succeeds. DsProcessImportResultVO is returned.

400

BadRequest

401

Unauthorized

403

Forbidden