Querying the Import Result

Function

Query the processing result of importing the Excel file. The value of uuid is the result returned by the /design/models/action or /design/catalogs/action API.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
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.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
uuid	Yes	String	Processing result of an import to be queried.

Request Parameters

**Table 3** Request header 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

**Table 4** Response body parameters
Parameter	Type	Description
data	DsProcessImportResultVO object	data: unified outermost data structure of the returned result.

**Table 5** DsProcessImportResultVO
Parameter	Type	Description
status	String	Unique value of the import, which is used to query the import result. Options: importing: The file is being imported. fail: The import fails. success: The import is successful.
group	BatchOperationVO object	Group information.
rate	String	Indicates the current progress.

**Table 6** BatchOperationVO
Parameter	Type	Description
id	String	Batch approval ID, which is a string
tenant_id	String	Project ID.
group_id	String	Group ID, which is a string
biz_name	String	Service name.
biz_id	String	Business ID, which is a string
operation_status	String	Operation result type enumeration. RUNNING(Running), SUCCESS(Operation succeeded), and FAILED(Operation failed). Options: RUNNING: The task is running. SUCCESS: The operation is successful. FAILED: The operation fails.
operation_type	String	Indicates the type.
biz_info	String	Service details.
create_by	String	Creator.
remark	String	Indicates the remark information.
total	Integer	Total number.
success	Integer	Number of successful operations.
failed	Integer	Indicates the number of failed operations.
rate	String	Indicates the current progress.
logs	String	Logs.
groups	Array of BatchOperationVO objects	Group information.

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
data	Object	Returned data information.

Status code: 401

**Table 8** Response body parameters
Parameter	Type	Description
data	Object	Returned data information.

Status code: 403

**Table 9** Response body parameters
Parameter	Type	Description
data	Object	Returned data information.

Example Requests

Query the Excel import result based on the UUID.

GET https://{endpoint}/v2/{project_id}/design/catelogs/process-import?uuid=5a8b96cc-6ee1-429b-b6a9-b26b5f669218

Example Responses

Status code: 200

This operation succeeds, and the returned data is DsProcessImportResultVO.

{
  "data" : {
    "status" : "success",
    "group" : {
      "id" : null,
      "tenant_id" : "xxx",
      "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" : "xxx",
        "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"
  }
}