文档首页/ 需求管理 CodeArts Req/ API参考/ API/ IPD配置管理/ 查询项目下工作项类型的关联关系配置 - ShowIpdIssueRelationsConfigByProject
更新时间:2026-10-22 GMT+08:00
分享

查询项目下工作项类型的关联关系配置 - ShowIpdIssueRelationsConfigByProject

功能介绍

查询项目下工作项类型的关联关系配置

调用方法

请参见如何调用API。

授权信息

账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

codeartsreq:configuration:list

List

-

  • codeartsreq:Model

  • codeartsreq:ProjectId

-

-

URI

GET /v2/ipdprojectservice/projects/{project_id}/issue-relation-config

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目32位ID,项目唯一标识。通过查询IPD项目列表获取,响应消息体中的id字段的值就是项目ID。

约束限制:

不涉及。

取值范围:

32个字符,由英文字母和数字组成。

默认取值:

不涉及。

请求参数

无

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

status

String

参数解释:

返回状态。

取值范围:

  • success:响应成功。

  • error:响应失败

message

String

参数解释:

信息。

取值范围:

不涉及

result

RelationConfig object

参数解释:

查询结果。

表3 RelationConfig

参数

参数类型

描述

relations

Map<String,Array<Relation>>

key为工作项类型,value为该类型的所有关联关系

表4 Relation

参数

参数类型

描述

type

String

参数解释:

关系code。

取值范围:

不涉及。

categories

String

参数解释:

关联的工作项code列表。

取值范围:

不涉及。

link_field_code

String

参数解释:

工作流场景使用,前置校验中的关联关系校验字段。

取值范围:

不涉及。

relation_name

String

参数解释:

关系名称,在工作项详情关联项下左侧显示。

取值范围:

不涉及。

description

String

参数解释:

关系描述。

取值范围:

不涉及。

display_scope

String

参数解释:

展示范围。

取值范围:

不涉及。

actions

Array of RelateAction objects

参数解释:

动作行为。

表5 RelateAction

参数

参数类型

描述

action

String

参数解释:

关联行为code。

取值范围:

不涉及。

action_display_name

String

参数解释:

关联行为名称。

取值范围:

不涉及。

relate_object_list

Array of RelationObject objects

参数解释:

关联的对象列表。

表6 RelationObject

参数

参数类型

描述

object_type

String

参数解释:

实体的种类。

取值范围:

不涉及。

categories

Array of strings

参数解释:

类型列表。

取值范围:

不涉及。

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

不涉及。

error_msg

String

参数解释:

错误描述,对error_code的补充解释。

取值范围:

不涉及。

请求示例

GET https://{endpoint}/v2/ipdprojectservice/projects/de7115f62a96485b8ceaac6e68c701c4/issue-relation-config

响应示例

状态码:200

{
  "status" : "success",
  "message" : null,
  "result" : {
    "relations" : {
      "RR" : [ {
        "type" : "children",
        "categories" : [ "IR" ],
        "link_field_code" : "rr2ir",
        "relation_name" : "子需求",
        "description" : "",
        "actions" : [ {
          "action" : "RELATE_TO_ISSUE",
          "action_display_name" : "关联",
          "relate_object_list" : [ {
            "object_type" : "issue",
            "categories" : [ "IR" ]
          } ]
        }, {
          "action" : "BREAK_DOWN",
          "action_display_name" : "分解",
          "relate_object_list" : [ {
            "object_type" : "issue",
            "categories" : [ "IR" ]
          } ]
        } ]
      }, {
        "type" : "upstream",
        "categories" : [ ],
        "link_field_code" : "",
        "relation_name" : "协同上游需求",
        "description" : "",
        "actions" : [ ]
      }, {
        "type" : "downstream",
        "categories" : [ ],
        "link_field_code" : "",
        "relation_name" : "协同下游需求",
        "description" : "",
        "actions" : [ {
          "action" : "COLLABORATE_DOWNSTREAM",
          "action_display_name" : "协同下发",
          "relate_object_list" : [ {
            "object_type" : "downstream",
            "categories" : [ ]
          } ]
        } ]
      }, {
        "type" : "association",
        "categories" : [ "RR", "SF", "IR", "SR", "DR", "AR", "Task", "Bug" ],
        "link_field_code" : "link",
        "relation_name" : "关联工作项",
        "description" : "",
        "actions" : [ {
          "action" : "RELATE_TO_CREATE_ISSUE",
          "action_display_name" : "新建",
          "relate_object_list" : [ {
            "object_type" : "issue",
            "categories" : [ "RR", "SF", "IR", "Task", "Bug" ]
          } ]
        }, {
          "action" : "RELATE_TO_EXISTING",
          "action_display_name" : "关联已有",
          "relate_object_list" : [ {
            "object_type" : "issue",
            "categories" : [ "RR", "SF", "IR", "SR", "DR", "AR", "Task", "Bug" ]
          } ]
        } ]
      }, {
        "type" : "file",
        "categories" : [ ],
        "link_field_code" : "$$associate_documents",
        "relation_name" : "文件",
        "description" : "",
        "actions" : [ {
          "action" : "RELATE_TO_FILE",
          "action_display_name" : "关联",
          "relate_object_list" : [ {
            "object_type" : "file",
            "categories" : [ ]
          } ]
        } ]
      }, {
        "type" : "wiki",
        "categories" : [ ],
        "link_field_code" : "$$wikis",
        "relation_name" : "Wiki",
        "description" : "",
        "actions" : [ {
          "action" : "RELATE_TO_WIKI",
          "action_display_name" : "关联",
          "relate_object_list" : [ {
            "object_type" : "wiki",
            "categories" : [ ]
          } ]
        } ]
      } ]
    }
  }
}

状态码:400

{
  "error_code" : "PM.02174103",
  "error_msg" : "无操作权限"
}

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
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 ShowIpdIssueRelationsConfigByProjectSolution {

    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();
        ShowIpdIssueRelationsConfigByProjectRequest request = new ShowIpdIssueRelationsConfigByProjectRequest();
        request.withProjectId("{project_id}");
        try {
            ShowIpdIssueRelationsConfigByProjectResponse response = client.showIpdIssueRelationsConfigByProject(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
# 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 = ShowIpdIssueRelationsConfigByProjectRequest()
        request.project_id = "{project_id}"
        response = client.show_ipd_issue_relations_config_by_project(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
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.ShowIpdIssueRelationsConfigByProjectRequest{}
	request.ProjectId = "{project_id}"
	response, err := client.ShowIpdIssueRelationsConfigByProject(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

查询项目下工作项类型的关联关系配置成功的响应。

400

请求失败的响应。例如无操作权限、项目不存在。

错误码

请参见错误码。

相关文档