Updated on 2026-10-13 GMT+08:00

Querying Associated Cases

Function

This API is used to query associated cases.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

codeartsreq:workitem:get

Read

-

  • codeartsreq:Model

  • codeartsreq:ProjectId

-

-

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

A 32-character UUID. It uniquely identifies a project. Obtain a project ID by calling the API for querying projects. The value of project_id in the response message body is a project ID.

Constraints

A string of 32 characters consisting of letters and digits.

Range

N/A

Default Value

N/A

issue_id

Yes

Integer

Definition

Work item ID, which can be obtained from the API for performing advanced query of work items. The value of the id field in the response body is the work item ID.

Constraints

N/A

Range

≥ 0

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. Obtain a token by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token.

Constraints

N/A

Range

The value contains 10 to 32,768 characters.

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

test_cases

Array of AssociatedTestCase objects

Definition:

List of associated test cases.

total

Integer

Definition:

Total number.

Options:

N/A

Table 4 AssociatedTestCase

Parameter

Type

Description

case_id

String

Definition:

Case ID.

Options:

N/A

case_level

String

Definition:

Case level.

Options:

N/A

case_name

String

Definition:

Case name.

Options:

N/A

case_num

String

Definition:

Case ID.

Options:

N/A

created_time

Long

Definition:

Creation time.

Options:

N/A

creator

SimpleUser object

Definition:

Creator.

is_base_line

Integer

Definition:

Baseline or not.

Options:

N/A

owner

SimpleUser object

Definition:

Owner.

project

SimpleProject object

Definition:

Project information.

status

StatusVo object

Definition:

Status.

type

String

Definition:

Case type.

Value range:

TestCase (test case)

Table 5 SimpleUser

Parameter

Type

Description

nick_name

String

Definition

User alias. You can obtain the nick_name field of a specified project member using the API for obtaining the user list of a specified project.

Range

N/A

user_id

String

Definition

User UUID. You can obtain the user_id field of a specified project member using the API for obtaining the user list of a specified project.

Range

N/A

user_name

String

Definition

Account name. You can obtain the user_name field of a specified project member using the API for obtaining the user list of a specified project.

Range

N/A

user_num_id

Integer

Definition

User digital ID. You can obtain the user_num_id field of a specified project member using the API for obtaining the user list of a specified project.

Range

N/A

Table 6 SimpleProject

Parameter

Type

Description

project_id

String

Definition

A 32-character UUID. It uniquely identifies a project. Obtain a project ID by calling the API for querying projects. The value of project_id in the response message body is a project ID.

project_name

String

Definition:

Project name.

Options:

N/A

Table 7 StatusVo

Parameter

Type

Description

id

String

Definition:

Status ID.

Options:

N/A

name

String

Definition:

Value of the status ID.

Options:

N/A

Status code: 400

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error code.

Value range:

N/A

error_msg

String

Definition:

Error description.

Value range:

N/A

Status code: 401

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error code.

Value range:

N/A

error_msg

String

Definition:

Error description.

Value range:

N/A

request_id

String

Definition

Request ID, which is automatically generated by the system.

Range

N/A

Example Requests

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

Example Responses

Status code: 200

{
  "test_cases" : [ {
    "case_id" : "36cfaab019dc49cdb53b07aefe553f5a",
    "case_num" : "1",
    "case_name" : "demo",
    "case_level" : "2",
    "status" : {
      "id" : "1",
      "name" : "Not started"
    },
    "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
}

SDK Sample Code

The SDK sample code is as follows.

Java

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.projectman.v4.region.ProjectManRegion;
import com.huaweicloud.sdk.projectman.v4.*;
import com.huaweicloud.sdk.projectman.v4.model.*;


public class ListAssociatedTestCasesSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        ProjectManClient client = ProjectManClient.newBuilder()
                .withCredential(auth)
                .withRegion(ProjectManRegion.valueOf("<YOUR REGION>"))
                .build();
        ListAssociatedTestCasesRequest request = new ListAssociatedTestCasesRequest();
        request.withProjectId("{project_id}");
        request.withIssueId({issue_id});
        try {
            ListAssociatedTestCasesResponse response = client.listAssociatedTestCases(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Python

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkprojectman.v4.region.projectman_region import ProjectManRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkprojectman.v4 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = ProjectManClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(ProjectManRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListAssociatedTestCasesRequest()
        request.project_id = "{project_id}"
        request.issue_id = {issue_id}
        response = client.list_associated_test_cases(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    projectman "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := projectman.ProjectManClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := projectman.NewProjectManClient(hcClient)

    request := &model.ListAssociatedTestCasesRequest{}
	request.ProjectId = "{project_id}"
	request.IssueId = int32({issue_id})
	response, err := client.ListAssociatedTestCases(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

More

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

ok

400

Bad Request

401

Unauthorized

Error Codes

See Error Codes.