Updated on 2025-12-01 GMT+08:00

Querying the Import Progress

Function

This API is used to query the import progress.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v1/{project_id}/test-suites/upload/processes

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details, see Method of obtaining instructions.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

code

String

Response code.

message

String

Response message.

json

UploadProcessJson object

Response content.

extend

String

Extension information.

Table 3 UploadProcessJson

Parameter

Type

Description

details

Array of UploadProcessJsonDetail objects

Project import progress details.

process_status

Integer

Total status (0: being imported; 1: imported).

Table 4 UploadProcessJsonDetail

Parameter

Type

Description

id

Integer

Import progress ID.

name

String

Project name.

status

Integer

Import status (0: importing; 1: successful; 2: failed).

cause

String

Failure cause.

Status code: 501

Table 5 Response body parameters

Parameter

Type

Description

-

String

response message

Example Requests

Querying the progress of importing a project.

/v1/{project_id}/test-suites/upload/processes

Example Responses

Status code: 200

success

{
  "code" : "SVCSTG.CPTS.0000000",
  "message" : "success",
  "json" : {
    "details" : [ {
      "id" : 0,
      "name" : "Project name",
      "status" : 1,
      "cause" : ""
    } ],
    "process_status" : 1
  },
  "extend" : null
}

Status Codes

Status Code

Description

200

success

501

unknown error

Error Codes

See Error Codes.