修改工时 - UpdateWorkHourOpenApi
功能介绍
修改工时
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
URI
PUT /v1/projects/{project_id}/work-items/{issue_id}/work-hour/{workhour_id}
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| work_hour_category | 否 | String | 工时类型唯一标识取值为value,页面展示取值为display_value |
| work_hours | 否 | String | 工时数值 |
| description | 否 | String | 工作内容 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 参数解释: 响应状态。 取值范围: |
| message | String | 参数解释: 响应消息。当请求失败时返回失败原因。 取值范围: 0~1000个字符。 |
| result | WorkHourTotalVO object | 参数解释: 工时信息列表及工时总数。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| data | Array of WorkHourVO objects | 工时信息列表 |
| work_hours_total | String | 实际工时总数 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 工时记录ID。 取值范围: 18~19个字符的数字字符串。 |
| title | String | 参数解释: 工时名称。 取值范围: 不涉及。 |
| operation_id | String | 参数解释: 操作ID,用于标识具体的操作记录。 取值范围: 不涉及。 |
| description | String | 参数解释: 工时工作内容描述。 取值范围: 最大10000个字符。 |
| workitem_id | String | 参数解释: 工时关联的工作项ID。可以通过查询工作项列表或者查询树状工作项接口获取,响应消息体中的id字段的值就是工作项ID。 取值范围: 18~19个字符的数字字符串。 |
| work_date | String | 参数解释: 工时日期时间戳,单位:毫秒。 取值范围: 不涉及。 |
| created_by | UserEntity object | 参数解释: 工时记录创建人信息。 |
| modified_by | UserEntity object | 参数解释: 工时记录最后修改人信息。 |
| work_hour_category | String | 参数解释: 工时类型。页面展示取值为display_value,唯一标识取值为value。 取值范围: 不涉及。 |
| work_hours | Double | 参数解释: 花费工时,单位为"人天"。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 用户ID,可通过查询项目成员列表接口获取,响应消息体中的id字段的值就是用户ID。 取值范围: 不涉及。 |
| name | String | 参数解释: 用户名称。 取值范围: 2~64个字符。 |
| nick_name | String | 参数解释: 用户昵称。 取值范围: 2~30个字符。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误描述,对error_code的补充解释。 取值范围: 不涉及。 |
请求示例
修改工时
PUT https://{endpoint}/v1/projects/dbf92424384e46dd9829492abe533829/work-items/1038401818296492033/work-hour/1038556057203286016
{
"work_hours" : "321",
"work_hour_category" : "后端开发",
"description" : "工作内容"
} 响应示例
状态码:200
工时信息以及工时总数信息返回
{
"status" : "success",
"message" : null,
"result" : {
"data" : [ {
"id" : "1038556057203286016",
"description" : "1133",
"workitem_id" : "1038401818296492033",
"created_by" : {
"id" : "a360371833bf4c558f796fd707b44daf",
"name" : "devcloud_devcloud_01",
"nick_name" : "t"
},
"modified_by" : {
"id" : "a360371833bf4c558f796fd707b44daf",
"name" : "devcloud_devcloud_01",
"nick_name" : "t"
},
"work_hour_category" : "后端开发",
"work_hours" : 321
} ],
"work_hours_total" : 387.7
}
} 状态码:400
请求失败的响应。例如无操作权限、项目不存在。
{
"error_code" : "PM.02174103",
"error_msg" : "无操作权限"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 工时信息以及工时总数信息返回 |
| 400 | 请求失败的响应。例如无操作权限、项目不存在。 |
错误码
请参见错误码。