更新时间:2025-09-19 GMT+08:00
分享

工作项流程流转

功能介绍

工作项流程流转。

调用方法

请参见如何调用API

URI

POST /v1/ipdprojectservice/projects/{project_id}/work-item/flow/transfer

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

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

默认取值:

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

id

String

参数解释

工作项唯一Id。可以通过查询工作项列表或者查询树状工作接口获取,响应消息体中的id字段的值就是工作项ID。

约束限制

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

issue_category

String

参数解释:

工作项类型。

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

flow_code

String

参数解释:

工作项流转code。可以通过查询工作项流程信息接口获取。

响应消息体中的next_flow数组为工作流流转线,根据from_code当前状态和to_code目标状态找到匹配的流转线,流转线的code字段的值就是工作项流转code。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

issue_ids

Array of strings

参数解释:

工作项唯一Id数组。可以通过查询工作项列表或者查询树状工作接口获取,响应消息体中的id字段的值就是工作项ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

process_context

Map<String,Object>

参数解释:

流转中配置上下文信息。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

status

String

参数解释:

状态码。

取值范围:

不涉及。

message

String

参数解释:

响应信息。

取值范围:

不涉及。

result

WorkItemFlowInfoVO object

参数解释:

工作流详情信息响应体。

取值范围:

不涉及。

表5 WorkItemFlowInfoVO

参数

参数类型

描述

process_instance

WorkItemFlowProcessInstanceVO object

参数解释:

工作项工作流示例信息。

取值范围:

不涉及。

next_flow

Array of FlowsInfoVO objects

参数解释:

可以流转的流转线信息。

取值范围:

不涉及。

表6 FlowsInfoVO

参数

参数类型

描述

process_instance

WorkItemFlowProcessInstanceVO object

参数解释:

工作项工作流示例信息。

取值范围:

不涉及。

next_flow

Array of FlowsInfoVO objects

参数解释:

可以流转的流转线信息。

取值范围:

不涉及。

code

String

参数解释:

流转线code。

取值范围:

不涉及。

name

String

参数解释:

流转线名称。

取值范围:

不涉及。

description

String

参数解释:

流转线描述信息。

取值范围:

不涉及。

from_code

String

参数解释:

当前工作流节点code。

取值范围:

不涉及。

to_code

String

参数解释:

目标工作流节点code。

取值范围:

不涉及。

表7 WorkItemFlowProcessInstanceVO

参数

参数类型

描述

process_instance

WorkItemFlowProcessInstanceVO object

参数解释:

工作项工作流示例信息。

取值范围:

不涉及。

next_flow

Array of FlowsInfoVO objects

参数解释:

可以流转的流转线信息。

取值范围:

不涉及。

id

String

参数解释:

工作项工作流实例id。

取值范围:

不涉及。

flow_state

Integer

参数解释:

工作流示例是否挂起。

取值范围:

1: 运行

2: 挂起

请求示例

POST /v1/ipdprojectservice/projects/39d30be0842e4e5d8e28ee7e1712c6a2/work-item/flow/transfer

{
  "id" : "1135239465657217024",
  "issue_category" : "Bug",
  "flow_code" : "__virtual_Analyse__2__Fixed"
}

响应示例

状态码:200

成功响应

{
  "status" : "success",
  "message" : null
}

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

    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();
        TransferWorkItemFlowRequest request = new TransferWorkItemFlowRequest();
        request.withProjectId("{project_id}");
        WorkItemFlowRequestBody body = new WorkItemFlowRequestBody();
        body.withFlowCode("__virtual_Analyse__2__Fixed");
        body.withIssueCategory("Bug");
        body.withId("1135239465657217024");
        request.withBody(body);
        try {
            TransferWorkItemFlowResponse response = client.transferWorkItemFlow(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
# 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 = TransferWorkItemFlowRequest()
        request.project_id = "{project_id}"
        request.body = WorkItemFlowRequestBody(
            flow_code="__virtual_Analyse__2__Fixed",
            issue_category="Bug",
            id="1135239465657217024"
        )
        response = client.transfer_work_item_flow(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
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.TransferWorkItemFlowRequest{}
	request.ProjectId = "{project_id}"
	flowCodeWorkItemFlowRequestBody:= "__virtual_Analyse__2__Fixed"
	issueCategoryWorkItemFlowRequestBody:= "Bug"
	idWorkItemFlowRequestBody:= "1135239465657217024"
	request.Body = &model.WorkItemFlowRequestBody{
		FlowCode: &flowCodeWorkItemFlowRequestBody,
		IssueCategory: &issueCategoryWorkItemFlowRequestBody,
		Id: &idWorkItemFlowRequestBody,
	}
	response, err := client.TransferWorkItemFlow(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

成功响应

错误码

请参见错误码

相关文档