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

Querying a Project Set

Function

This API is used to query a project set.

URI

GET /v1/{project_id}/test-suites

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

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Query offset.

Minimum: 0

Maximum: 2147483647

limit

No

Integer

Number of queried records.

Minimum: 0

Maximum: 2147483647

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

code

String

Status code.

Minimum: 0

Maximum: 128

message

String

Message.

Minimum: 0

Maximum: 1000

projects

Array of ProjectsSet objects

Project set details.

Array Length: 0 - 1000

Table 4 ProjectsSet

Parameter

Type

Description

CreateTime

String

Creation time.

UpdateTime

String

Update time.

description

String

Description.

Minimum: 0

Maximum: 1000

id

Integer

Project ID.

Minimum: 0

Maximum: 2147483647

name

String

Project name.

Minimum: 0

Maximum: 64

source

Integer

Project source. 0: PerfTest; 2: CloudTest.

Minimum: 0

Maximum: 2147483647

external_params

Object

External parameter.

variables_no_file

Array of strings

File variable.

Example Requests

Querying the project list.

/v1/{project_id}/test-suites&offset=1&limit=10

Example Responses

Status code: 200

success

{
  "code" : "CPTS.00000000",
  "message" : "success",
  "projects" : [ {
    "id" : 1,
    "name" : "name",
    "description" : "description",
    "variables_no_file" : [ ],
    "CreateTime" : "2021-07-12T14:41:51+08:00",
    "UpdateTime" : "2021-07-12T14:41:51+08:00",
    "source" : 0,
    "external_params" : { }
  } ]
}

Status Codes

Status Code

Description

200

success

501

unknown error

Error Codes

See Error Codes.