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

Querying a Transaction Set

Function

This API is used to query a transaction set.

URI

GET /v1/{project_id}/all-templates/{test_suite_id}

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

test_suite_id

Yes

Integer

Test project ID.

Minimum: 0

Maximum: 2147483647

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

Response code.

Minimum: 0

Maximum: 1024

message

String

Response message.

Minimum: 0

Maximum: 1024

temps

Array of TempDetailInfo objects

temps

Array Length: 0 - 1024

Table 4 TempDetailInfo

Parameter

Type

Description

description

String

Description.

id

Integer

Transaction ID.

Minimum: 0

Maximum: 2147483647

is_quoted

Boolean

Reference status

name

String

Transaction name.

Minimum: 0

Maximum: 1024

temp_type

Integer

Transaction type (deprecated, reserved for compatibility).

Minimum: 0

Maximum: 2147483647

update_time

String

Update time.

Minimum: 0

Maximum: 1024

Example Requests

Querying the transaction set. The ID of the project to which the transactions belong is 1.

/v1/projectId/all-templates/1

{
  "code" : "SVCSTG.CPTS.0000000",
  "message" : "success",
  "temps" : [ {
    "description" : "",
    "id" : 155175,
    "is_quoted" : false,
    "name" : "test",
    "temp_type" : 0,
    "update_time" : "2023-06-16T15:49:19.128871+08:00"
  } ]
}

Example Responses

Status code: 200

success

{
  "code" : "SVCSTG.CPTS.0000000",
  "message" : "success",
  "temps" : [ {
    "description" : "",
    "id" : 114448,
    "is_quoted" : false,
    "name" : "temp1",
    "temp_type" : 0,
    "update_time" : "2022-07-20T17:49:20.984763+08:00"
  }, {
    "description" : "",
    "id" : 115964,
    "is_quoted" : false,
    "name" : "temp2",
    "temp_type" : 0,
    "update_time" : "2022-07-20T17:38:12.696491+08:00"
  } ]
}

Status Codes

Status Code

Description

200

success

501

unknown error

Error Codes

See Error Codes.