更新时间:2024-08-30 GMT+08:00
分享

添加指定工作项工时

功能介绍

添加指定工作项工时

调用方法

请参见如何调用API

URI

POST /v4/projects/{project_id}/issues/{issue_id}/work-hours

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:项目的32位uuid,项目唯一标识,可以通过ListProjectsV4接口查询项目列表

约束限制:正则表达式, ^[A-Za-z0-9]{32}$

取值范围:字符串,最小长度:32,最大长度:32

默认取值:不涉及

issue_id

Integer

参数解释:工作项id,可通过ListIssuesV4接口高级查询工作项

约束限制:正则表达式,[0-9]{1,10}$

取值范围:最小长度:1,最大长度:10

默认取值:不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

约束限制:不涉及

取值范围:最小长度:10,最大长度:32768

默认取值:不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

start_date

String

参数解释:工时开始日期,年-月-日

约束限制:正则表达式, ^\d{4}-\d{2}-\d{2}$

取值范围:匹配格式为 YYYY-MM-DD 的日期字符串,MM 是两位数的月份限制取值01-12,DD是两位数的日期限制取值01-31

默认取值:不涉及

due_date

String

参数解释:工时结束日期,年-月-日

约束限制:正则表达式, ^\d{4}-\d{2}-\d{2}$

取值范围:匹配格式为 YYYY-MM-DD 的日期字符串,MM 是两位数的月份限制取值01-12,DD是两位数的日期限制取值01-31

默认取值:不涉及

work_hours

Double

参数解释:工时总数(若工时日期范围包含多天,单日工时将设为“工时总数/天数”)

约束限制:不涉及

取值范围:最小值:0.0,最大值:100000000

默认取值:不涉及

work_hours_type_id

Integer

参数解释:工时类型id

(项目预设工时类型id及名称对照:21:研发设计,22:后端开发,23:前端开发(Web),24:前端开发(小程序),25:前端开发(App), 26:测试验证,27:缺陷修复,28:UI设计,29:会议,30:公共事务,31:培训,32:研究,33:其它,34:调休请假)

约束限制:不涉及

取值范围:最小值:21,最大值:34

默认取值:不涉及

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

added_work_hours

Array of added_work_hours objects

已添加的工时列表

表5 added_work_hours

参数

参数类型

描述

work_hours_id

String

工时id

issue_id

Integer

添加工时对应的工作项id

user_name

String

工时添加用户的用户名

user_nick_name

String

工时添加用户的用户昵称

work_date

String

工时日期 年-月-日

work_hours

Double

工时数

work_hours_type_name

String

工时类型名称

(项目预设工时类型id及名称对照:21:研发设计,22:后端开发,23:前端开发(Web),24:前端开发(小程序),25:前端开发(App), 26:测试验证,27:缺陷修复,28:UI设计,29:会议,30:公共事务,31:培训,32:研究,33:其它,34:调休请假)

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

状态码: 401

表7 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

请求示例

Post https://{endpoint}/v4/projects/e2da96a5d2c845e284f0ad47f8ca8cb2/issues/123456/work-hours

{
  "start_date" : "2023-05-15",
  "due_date" : "2023-05-15",
  "work_hours" : 2.0,
  "work_hours_type_id" : 21
}

响应示例

状态码: 200

ok

{
  "added_work_hours" : [ {
    "work_hours_id" : "7da14cf9f3c111eda5a5fa163ec9f6c1",
    "issue_id" : 123456,
    "user_name" : "user_name",
    "user_nick_name" : "O_O",
    "work_date" : "2023-05-15",
    "work_hours" : "2.0",
    "work_hours_type_name" : "研发设计"
  } ]
}

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

    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();
        AddIssueWorkHoursRequest request = new AddIssueWorkHoursRequest();
        AddIssueWorkHoursRequestBody body = new AddIssueWorkHoursRequestBody();
        body.withWorkHoursTypeId(21);
        body.withWorkHours((double)2.0);
        body.withDueDate("2023-05-15");
        body.withStartDate("2023-05-15");
        request.withBody(body);
        try {
            AddIssueWorkHoursResponse response = client.addIssueWorkHours(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
# coding: utf-8

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

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

    try:
        request = AddIssueWorkHoursRequest()
        request.body = AddIssueWorkHoursRequestBody(
            work_hours_type_id=21,
            work_hours=2.0,
            due_date="2023-05-15",
            start_date="2023-05-15"
        )
        response = client.add_issue_work_hours(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
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.AddIssueWorkHoursRequest{}
	workHoursTypeIdAddIssueWorkHoursRequestBody:= int32(21)
	request.Body = &model.AddIssueWorkHoursRequestBody{
		WorkHoursTypeId: &workHoursTypeIdAddIssueWorkHoursRequestBody,
		WorkHours: float64(2.0),
		DueDate: "2023-05-15",
		StartDate: "2023-05-15",
	}
	response, err := client.AddIssueWorkHours(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

ok

400

Bad Request

401

Unauthorized

错误码

请参见错误码

相关文档