Updated on 2023-06-12 GMT+08:00

Querying Associated Wikis

Function

Querying Associated Wikis

URI

GET /v4/projects/{project_id}/issues/{issue_id}/associate-test-cases

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the 32-bit ID of the devcloud project.

Minimum: 32

Maximum: 32

issue_id

Yes

Integer

Work Item ID

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Number of records on each page

offset

No

Integer

Offset

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Minimum: 10

Maximum: 32768

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

test_cases

Array of AssociatedTestCase objects

List of Associated Test Cases

total

Integer

Total

Table 5 AssociatedTestCase

Parameter

Type

Description

case_id

String

Case ID

case_num

String

Case No.

case_name

String

Case Name

case_level

String

Case Level

status

StatusVo object

Status

creator

SimpleUser object

  

owner

SimpleUser object

  

project

SimpleProject object

  

is_base_line

Integer

Baseline or Not

type

String

Case Type

created_time

Long

Created

Table 6 StatusVo

Parameter

Type

Description

id

String

Identifies a status.

name

String

Value of the status ID.

Table 7 SimpleUser

Parameter

Type

Description

user_num_id

Integer

User ID

user_id

String

Indicates the user UUID.

user_name

String

Account name

nick_name

String

Nickname of the user.

Table 8 SimpleProject

Parameter

Type

Description

project_name

String

Project name

project_id

String

Project ID

Status code: 400

Table 9 Response body parameters

Parameter

Type

Description

error_msg

String

Description

error_code

String

Error Codes

Status code: 401

Table 10 Response body parameters

Parameter

Type

Description

error_msg

String

Description

error_code

String

Error Codes

Example Requests

GET https://{endpoint}/v4/projects/{project_id}/issues/{issue_id}/associate-test-cases

GET https://{endpoint}/v4/projects/a360371833bf4c558f796fd707b44daf/issues/1234/associate-test-cases

Example Responses

Status code: 200

ok

{
  "test_cases" : [ {
    "case_id" : "36cfaab019dc49cdb53b07aefe553f5a",
    "case_num" : "1",
    "case_name" : "demo",
    "case_level" : "2",
    "status" : {
      "id" : "1",
      "name" : ""
    },
    "creator" : {
      "user_num_id" : 4091,
      "user_id" : "a360371833bf4c558f796fd707b44daf",
      "user_name" : "demo_user_name_xiongzhitest001",
      "nick_name" : "bear1"
    },
    "owner" : {
      "user_num_id" : 4091,
      "user_id" : "a360371833bf4c558f796fd707b44daf",
      "user_name" : "demo_user_name_xiongzhitest001",
      "nick_name" : "bear1"
    },
    "project" : {
      "project_name" : "demo",
      "project_id" : "58d9050550c847c89885c1797a718b0c"
    },
    "is_base_line" : 0,
    "type" : "1",
    "created_time" : 1233445566000
  } ],
  "total" : 0
}

Status Codes

Status Code

Description

200

ok

400

Bad Request

401

Unauthorized

Error Codes

See Error Codes.