文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 测试服务关联关系/ 添加需求/缺陷和多个用例关联关系
更新时间:2025-07-24 GMT+08:00
分享

添加需求/缺陷和多个用例关联关系

功能介绍

添加需求/缺陷和多个用例关联关系

调用方法

请参见如何调用API

URI

POST /testrelation/v4/workitems/{workitem_id}/relations

表1 路径参数

参数

是否必选

参数类型

描述

workitem_id

String

参数解释

需求/缺陷id

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

必传。

取值范围:

字符串长度不少于1,不超过10万。

默认取值:

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

relations

Array of RelationInfo objects

参数解释

关联关系

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

tracker_id

String

参数解释

工作项类型id

约束限制

1到20位数字

取值范围

不涉及

默认取值

不涉及

version_uri

String

参数解释

版本uri

约束限制

11到34位英文或数字

取值范围

不涉及

默认取值

不涉及

task_uri

String

参数解释

测试套id

约束限制

11到34位英文或数字

取值范围

不涉及

默认取值

不涉及

add_to_iterator

Boolean

参数解释

是否将需求添加到迭代

约束限制

11到34位英文或数字

取值范围

不涉及

默认取值

不涉及

project_uuid

String

参数解释

项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID

约束限制

不涉及

取值范围

项目uuid应符合如下规则:长度等于32位,包含大小写字母、数字

默认取值

不涉及

表4 RelationInfo

参数

是否必选

参数类型

描述

dr_number

String

参数解释

需求id

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

test_case_uri

String

参数解释

用例uri

约束限制

不涉及

取值范围

11到34位英文或数字

默认取值

不涉及

relate_type

String

参数解释

资源类型

约束限制

不涉及

取值范围

bug/requirement

默认取值

不涉及

resource_type

String

参数解释

资源类型

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

source_system

String

参数解释

来源系统

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

association_number

String

参数解释

关联资源编号

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

region

String

参数解释

逻辑region,外部使用公有云实际区域,内部使用默认值

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

status

String

参数解释

success|error;

取值范围

success|error

result

ResultValueStringForOk object

参数解释:

请求结果

取值范围:

不涉及

表6 ResultValueStringForOk

参数

参数类型

描述

value

String

参数解释

ok

取值范围

不涉及

状态码:400

表7 响应Body参数

参数

参数类型

描述

code

String

参数解释:

业务失败的错误码

取值范围:

不涉及

reason

String

参数解释:

业务失败的提示内容

取值范围:

不涉及

状态码:401

表8 响应Body参数

参数

参数类型

描述

code

String

参数解释:

业务失败的错误码

取值范围:

不涉及

reason

String

参数解释:

业务失败的提示内容

取值范围:

不涉及

状态码:404

表9 响应Body参数

参数

参数类型

描述

code

String

参数解释:

业务失败的错误码

取值范围:

不涉及

reason

String

参数解释:

业务失败的提示内容

取值范围:

不涉及

状态码:500

表10 响应Body参数

参数

参数类型

描述

code

String

参数解释:

业务失败的错误码

取值范围:

不涉及

reason

String

参数解释:

业务失败的提示内容

取值范围:

不涉及

请求示例

post https://{endpoint}/testrelation/v4/workitems/16228817/relations

{
  "relations" : [ {
    "dr_number" : "3325606",
    "test_case_uri" : "223685",
    "relate_type" : "bug/requirement",
    "resource_type" : "testcase/testitem",
    "source_system" : "vision",
    "association_number" : "223685",
    "region" : "szv"
  } ],
  "tracker_id" : "1",
  "version_uri" : "932opbu6aaf",
  "task_uri" : "59281152185",
  "add_to_iterator" : true,
  "project_uuid" : "223685eqweqwe1112w"
}

响应示例

状态码:200

OK

{
  "result" : {
    "value" : "success"
  }
}

SDK代码示例

SDK代码示例如下。

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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
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.cloudtest.v1.region.CloudtestRegion;
import com.huaweicloud.sdk.cloudtest.v1.*;
import com.huaweicloud.sdk.cloudtest.v1.model.*;

import java.util.List;
import java.util.ArrayList;

public class BatchAddRelationsByOneCaseSolution {

    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);

        CloudtestClient client = CloudtestClient.newBuilder()
                .withCredential(auth)
                .withRegion(CloudtestRegion.valueOf("<YOUR REGION>"))
                .build();
        BatchAddRelationsByOneCaseRequest request = new BatchAddRelationsByOneCaseRequest();
        request.withWorkitemId("{workitem_id}");
        AddRelationsInfo body = new AddRelationsInfo();
        List<RelationInfo> listbodyRelations = new ArrayList<>();
        listbodyRelations.add(
            new RelationInfo()
                .withDrNumber("3325606")
                .withTestCaseUri("223685")
                .withRelateType("bug/requirement")
                .withResourceType("testcase/testitem")
                .withSourceSystem("vision")
                .withAssociationNumber("223685")
                .withRegion("szv")
        );
        body.withProjectUuid("223685eqweqwe1112w");
        body.withAddToIterator(true);
        body.withTaskUri("59281152185");
        body.withVersionUri("932opbu6aaf");
        body.withTrackerId("1");
        body.withRelations(listbodyRelations);
        request.withBody(body);
        try {
            BatchAddRelationsByOneCaseResponse response = client.batchAddRelationsByOneCase(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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcloudtest.v1.region.cloudtest_region import CloudtestRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcloudtest.v1 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 = CloudtestClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CloudtestRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = BatchAddRelationsByOneCaseRequest()
        request.workitem_id = "{workitem_id}"
        listRelationsbody = [
            RelationInfo(
                dr_number="3325606",
                test_case_uri="223685",
                relate_type="bug/requirement",
                resource_type="testcase/testitem",
                source_system="vision",
                association_number="223685",
                region="szv"
            )
        ]
        request.body = AddRelationsInfo(
            project_uuid="223685eqweqwe1112w",
            add_to_iterator=True,
            task_uri="59281152185",
            version_uri="932opbu6aaf",
            tracker_id="1",
            relations=listRelationsbody
        )
        response = client.batch_add_relations_by_one_case(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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    cloudtest "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/v1/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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := cloudtest.NewCloudtestClient(
        cloudtest.CloudtestClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.BatchAddRelationsByOneCaseRequest{}
	request.WorkitemId = "{workitem_id}"
	testCaseUriRelations:= "223685"
	resourceTypeRelations:= "testcase/testitem"
	sourceSystemRelations:= "vision"
	associationNumberRelations:= "223685"
	regionRelations:= "szv"
	var listRelationsbody = []model.RelationInfo{
        {
            DrNumber: "3325606",
            TestCaseUri: &testCaseUriRelations,
            RelateType: "bug/requirement",
            ResourceType: &resourceTypeRelations,
            SourceSystem: &sourceSystemRelations,
            AssociationNumber: &associationNumberRelations,
            Region: &regionRelations,
        },
    }
	projectUuidAddRelationsInfo:= "223685eqweqwe1112w"
	addToIteratorAddRelationsInfo:= true
	taskUriAddRelationsInfo:= "59281152185"
	versionUriAddRelationsInfo:= "932opbu6aaf"
	trackerIdAddRelationsInfo:= "1"
	request.Body = &model.AddRelationsInfo{
		ProjectUuid: &projectUuidAddRelationsInfo,
		AddToIterator: &addToIteratorAddRelationsInfo,
		TaskUri: &taskUriAddRelationsInfo,
		VersionUri: &versionUriAddRelationsInfo,
		TrackerId: &trackerIdAddRelationsInfo,
		Relations: &listRelationsbody,
	}
	response, err := client.BatchAddRelationsByOneCase(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档