Querying the Import Progress

Updated on 2024-04-08 GMT+08:00

Online Debugging

CLI Examples

View PDF

Function

This API is used to query the import progress.

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 Obtaining a Project ID. Minimum: 0 Maximum: 64

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
code	String	Response code. Minimum: 0 Maximum: 1024
message	String	Response message. Minimum: 0 Maximum: 1024
json	UploadProcessJson object	Response content.
extend	String	Extension information. Minimum: 0 Maximum: 1024

**Table 3** UploadProcessJson
Parameter	Type	Description
details	Array of UploadProcessJsonDetail objects	Project import progress details. Array Length: 0 - 1024
process_status	Integer	Total status (0: being imported; 1: imported). Minimum: 0 Maximum: 2147483647

**Table 4** UploadProcessJsonDetail
Parameter	Type	Description
id	Integer	Import progress ID. Minimum: 0 Maximum: 2147483647
name	String	Project name. Minimum: 0 Maximum: 1024
status	Integer	Import status (0: importing; 1: successful; 2: failed). Minimum: 0 Maximum: 2147483647
cause	String	Failure cause. Minimum: 0 Maximum: 1024

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
}