文档首页/ 需求管理 CodeArts Req/ API参考/ API/ IPD工作流/ 获取工作流的详情及每条流转线的详情
更新时间:2025-08-05 GMT+08:00
分享

获取工作流的详情及每条流转线的详情

功能介绍

获取工作流的详情及每条流转线的详情。

调用方法

请参见如何调用API

URI

GET /v1/ipdprojectservice/projects/{project_id}/workflow-template

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

正则表达式,^[A-Za-z0-9]{32}$。

取值范围

不涉及。

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

issue_category

String

参数解释:

工作项类型。

约束限制:

正则表达式:"^(RR|IR|AR|SR|Bug|FE|Task|US|Epic|SF)"。

取值范围:

RR、IR、AR、SR、Bug、FE、Task、US、Epic、SF

默认取值:

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

最小长度:10,最大长度:32768。

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

result

WorkflowTemplateVO object

参数解释:

查询结果。

取值范围:

不涉及。

status

String

参数解释:

状态码。

取值范围:

不涉及。

message

String

参数解释:

响应信息。

取值范围:

不涉及。

表5 WorkflowTemplateVO

参数

参数类型

描述

processNodes

Array of WorkflowTemplateNodesVO objects

参数解释:

状态流中的状态信息。

取值范围:

不涉及。

processFlows

Array of WorkflowTemplateFlowsVO objects

参数解释:

状态流中的流转线信息。

取值范围:

不涉及。

表6 WorkflowTemplateNodesVO

参数

参数类型

描述

name

String

参数解释:

状态名称。

取值范围:

不涉及。

表7 WorkflowTemplateFlowsVO

参数

参数类型

描述

before_rule_validator

Array of WorkflowTemplateConfigsVO objects

参数解释:

流转前校验配置。

取值范围:

不涉及。

before_rule_configs

Array of WorkflowTemplateConfigsVO objects

参数解释:

流转中界面配置。

取值范围:

不涉及。

from_code

String

参数解释:

流转线的入口状态。

取值范围:

不涉及。

to_code

String

参数解释:

流转线的出口状态。

取值范围:

不涉及。

表8 WorkflowTemplateConfigsVO

参数

参数类型

描述

configValue

Array of Map<String,String> objects

参数解释:

操作项配置。

取值范围:

不涉及

请求示例

GEThttps://{endpoint}/v1/ipdprojectservice/projects/39d30be0842e4e5d8e28ee7e1712c6a2/workflow-template?issue_category=RR

响应示例

状态码:200

成功响应

{
  "status" : "success",
  "message" : null,
  "result" : {
    "process_nodes" : [ {
      "code" : "Analyse",
      "name" : "分析"
    } ],
    "process_flows" : [ {
      "code" : "Analyse2ToBeConfirmed",
      "name" : "退回",
      "from_code" : "Analyse",
      "to_code" : "ToBeConfirmed",
      "before_rule_configs" : [ ],
      "before_rule_validator" : [ ]
    } ]
  }
}

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

    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();
        ShowWorkflowTemplateRequest request = new ShowWorkflowTemplateRequest();
        request.withProjectId("{project_id}");
        try {
            ShowWorkflowTemplateResponse response = client.showWorkflowTemplate(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 = ShowWorkflowTemplateRequest()
        request.project_id = "{project_id}"
        response = client.show_workflow_template(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
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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := projectman.NewProjectManClient(
        projectman.ProjectManClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

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

更多

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

状态码

状态码

描述

200

成功响应

错误码

请参见错误码

相关文档