Help Center/ CodeArts Req/ API Reference/ API/ Scrum Project Work Items/ Adding Work Hours for a Specified Work Item
Updated on 2026-10-13 GMT+08:00

Adding Work Hours for a Specified Work Item

Function

This API is used to work hours for a specified work item.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

codeartsreq:workhour:create

Write

-

  • codeartsreq:Model

  • codeartsreq:ProjectId

-

-

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

A 32-character UUID. It uniquely identifies a project. Obtain a project ID by calling the API for querying projects. The value of project_id in the response message body is a project ID.

Constraints

A string of 32 characters consisting of letters and digits.

Range

N/A

Default Value

N/A

issue_id

Yes

Integer

Definition

Work item ID, which can be obtained from the API for performing advanced query of work items. The value of the id field in the response body is the work item ID.

Constraints

N/A

Range

≥ 0

Default Value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

due_date

Yes

String

Definition

Work end date: YYYY-MM-DD.

Constraints

The value is in the format of YYYY-MM-DD.

Range

The value is a date string in the format of YYYY-MM-DD. MM is a two-digit month ranging from 01 to 12, and DD is a two-digit date ranging from 01 to 31.

Default Value

N/A

start_date

Yes

String

Definition

Work start date: YYYY-MM-DD.

Constraints

The value is in the format of YYYY-MM-DD.

Range

The value is a date string in the format of YYYY-MM-DD. MM is a two-digit month ranging from 01 to 12, and DD is a two-digit date ranging from 01 to 31.

Default Value

N/A

work_hours

Yes

Double

Definition

Total workloads (if the date range includes multiple days, the workload for a single day can be set to "Total workloads/Days").

Constraints

N/A

Range

0–100000000

Default Value

N/A

work_hours_type_id

No

Integer

Definition

Work type ID.

21: R&D and design, 22: backend development, 23: frontend development (web), 24: frontend development (applet), 25: frontend development (app), 26: test and verifications, 27: bug rectification, 28: UI design, 29: meeting, 30: public affairs, 31: training, 32: research, 33: other, and 34: replacement leave.

Constraints

N/A

Range

21–34

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

added_work_hours

Array of added_work_hours objects

Definition:

List of added workloads.

Table 4 added_work_hours

Parameter

Type

Description

issue_id

Integer

Definition

ID of the work item of adding workloads.

Range

1 to 10 characters

user_name

String

Definition:

Username.

Options:

N/A

user_nick_name

String

Definition:

User nickname.

Options:

N/A

work_date

String

Definition:

Work date.

Options:

N/A

work_hours

Double

Definition:

Workloads.

Options:

Minimum value: 0.0. Maximum value: *100000000.

work_hours_id

String

Definition:

Workload ID.

Options:

N/A

work_hours_type_name

String

Definition:

Work type name.

Options:

21: R&D and design

22: backend development

23: frontend development (web)

24: frontend development (applet)

25: frontend development (app)

26: test and verification

27: bug fixing

28: UI design

29: conference

30: public affairs

31: training

32: research

33: other

34: replacement leave

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error code.

Value range:

N/A

error_msg

String

Definition:

Error description.

Value range:

N/A

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error code.

Value range:

N/A

error_msg

String

Definition:

Error description.

Value range:

N/A

request_id

String

Definition

Request ID, which is automatically generated by the system.

Range

N/A

Example Requests

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

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

Example Responses

Status code: 200

{
  "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" : "R&D and design"
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

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
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();
        request.withProjectId("{project_id}");
        request.withIssueId({issue_id});
        AddIssueWorkHoursRequestBody body = new AddIssueWorkHoursRequestBody();
        body.withWorkHoursTypeId(21);
        body.withWorkHours((double)2);
        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
36
37
38
# 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 = AddIssueWorkHoursRequest()
        request.project_id = "{project_id}"
        request.issue_id = {issue_id}
        request.body = AddIssueWorkHoursRequestBody(
            work_hours_type_id=21,
            work_hours=2,
            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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
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.AddIssueWorkHoursRequest{}
	request.ProjectId = "{project_id}"
	request.IssueId = int32({issue_id})
	workHoursTypeIdAddIssueWorkHoursRequestBody:= int32(21)
	request.Body = &model.AddIssueWorkHoursRequestBody{
		WorkHoursTypeId: &workHoursTypeIdAddIssueWorkHoursRequestBody,
		WorkHours: float64(2),
		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)
    }
}

More

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

ok

400

Bad Request

401

Unauthorized

Error Codes

See Error Codes.