修改工作项工时操作记录 - UpdateWorkingHours
功能介绍
修改工作项工时操作记录。
调用方法
请参见如何调用API。
授权信息
当前API调用无需身份策略权限。
URI
PUT /v3/projects/{project_UUID}/issues/{issue_id}/work-hours/{work_hours_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_UUID | 是 | String | 参数解释: 项目的32位UUID,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 32位的数字和字母组成的字符串。 取值范围: 不涉及。 默认取值: 不涉及。 |
| issue_id | 是 | Integer | 参数解释: 工作项ID,可通过高级查询工作项接口获取,响应消息体中的id字段的值就是工作项ID。 约束限制: 不涉及。 取值范围: ≥0。 默认取值: 不涉及。 |
| work_hours_id | 是 | String | 参数解释: 工时ID。用户通过[查询Scrum工作项工时记录]接口获取,响应消息体中的id字段的值就是工时ID。 约束限制: 32个字母(包括大写和小写)和数字组成的字符串。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| summary | 否 | String | 参数解释: 工作内容。 约束限制: 长度为 0 到 128 个字符的任意字符串。 取值范围: 不涉及。 默认取值: 不涉及。 |
| work_hours | 否 | String | 参数解释: 工时总数(若工时日期范围包含多天,单日工时将设为“工时总数/天数”)。 约束限制: 不涉及。 取值范围: 最小值:0.0,最大值:100000000。 默认取值: 不涉及。 |
| work_hour_type | 否 | Integer | 参数解释: 工时类型,可通过查询项目下的工时类型接口获取,响应消息体中的id字段的值就是工时类型ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| result | GetWorkingHoursResponse object | 参数解释: 修改工作项工时操作记录的返回结果。 |
| status | String | 参数解释: 修改工作项工时操作记录的返回状态。 取值范围: success:返回成功。 error:返回失败。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Integer | 参数解释: 工作项工时操作记录总数。 取值范围: 不涉及。 |
| data | Array of IssueWorkHours objects | 参数解释: 工作项工时操作记录列表。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 主键。 取值范围: 32位UUID字符串。 |
| issueId | Integer | 参数解释: 工作项ID。 取值范围: 不涉及。 |
| userId | String | 参数解释: 用户ID。 取值范围: 32位UUID字符串。 |
| userNumId | String | 参数解释: 用户数字ID。 取值范围: 不涉及。 |
| userName | String | 参数解释: 用户名。 取值范围: 不涉及。 |
| nickName | String | 参数解释: 用户昵称。 取值范围: 不涉及。 |
| summary | String | 参数解释: 工作内容。 取值范围: 不涉及。 |
| workDate | String | 参数解释: 产生工时的日期。 取值范围: 不涉及。 |
| workDateTimestamp | String | 参数解释: 产生工时的日期时间戳。 取值范围: 不涉及。 |
| workHours | String | 参数解释: 实际工时(人/天) 取值范围: 不涉及 |
| status | Integer | 参数解释: 工时操作记录是否有效。 取值范围: 0(被删除); 1(记录有效)。 |
| created | String | 参数解释: 创建时间。 取值范围: 不涉及。 |
| modified | String | 参数解释: 修改时间。 取值范围: 不涉及。 |
| region | String | 参数解释: 区域。 取值范围: 不涉及。 |
| batchIdentifier | String | 参数解释: 同批次增加工作项工时记录的UUID。 取值范围: 32位UUID。 |
| batchWorkHours | String | 参数解释: 同批次添加工作项的总工时。 取值范围: 不涉及。 |
| workHourTypeId | Integer | 参数解释: 工时类型ID。 取值范围: 不涉及。 |
| workHourTypeName | String | 参数解释: 工时类型名称。 取值范围: 新建 编辑 删除 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误描述,对error_code的补充解释。 取值范围: 不涉及。 |
请求示例
PUT https://{endpoint}/v2/projects/919bb351ef424e2daaf3dd80c179fae9/issues/9049242/work_hours/383910e1483811f09df2fa163eed4f94
{
"summary" : "图片上传功能开发。",
"work_hours" : 0.5,
"work_hour_type" : 27
} 响应示例
状态码:200
修改工作项工时操作记录的响应信息
{
"result": {
"total": 1,
"data": [
{
"id": "ae6a11b27be511f0aa95fa163e60f658",
"issueId": 69882126,
"userId": "xxxxxx",
"userNumId": 000000,
"userName": "xxxxxx",
"nickName": "xxxxxx",
"summary": "",
"workDate": "2025/08/18",
"workDateTimestamp": "1755446400000",
"workHours": "2.0"
}
]
},
"status": "success"
} 状态码:400
无权限的错误响应
{
"error_code" : "PM.02100011",
"error_msg" : "无权限访问"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 修改工作项工时操作记录的响应信息 |
| 400 | 无权限的错误响应 |
错误码
请参见错误码。