修改工时 - UpdateWorkHourOpenApi

功能介绍

修改工时

调用方法

请参见如何调用API。

授权信息

账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
codeartsreq:workhour:update	Write	-	codeartsreq:Model codeartsreq:ProjectId	-	-

URI

PUT /v1/projects/{project_id}/work-items/{issue_id}/work-hour/{workhour_id}

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：项目的32位uuid，项目唯一标识，通过查询项目列表接口获取，响应消息体中的project_id字段的值就是项目ID。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
issue_id	是	String	参数解释：工作项唯一ID。可以通过查询工作项列表或者查询树状工作接口获取，响应消息体中的id字段的值就是工作项ID。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
workhour_id	是	String	工时id

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
work_hour_category	否	String	工时类型唯一标识取值为value，页面展示取值为display_value
work_hours	否	String	工时数值
description	否	String	工作内容

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
status	String	参数解释：返回状态。取值范围： success：响应成功 error：响应失败
message	String	消息
result	WorkHourTotalVO object	工时信息及工时总数

表4 WorkHourTotalVO
参数	参数类型	描述
data	Array of WorkHourVO objects	工时信息列表
work_hours_total	String	实际工时总数

表5 WorkHourVO
参数	参数类型	描述
id	String	工时id
title	String	工时名称
operation_id	String	操作ID
description	String	描述
workitem_id	String	工作项id
work_date	String	工时日期
created_by	UserEntity object	创建人信息
modified_by	UserEntity object	修改人信息
work_hour_category	String	工时类型唯一标识取值为value，页面展示取值为display_value
work_hours	String	花费工时(人天)

表6 UserEntity
参数	参数类型	描述
id	String	参数解释：用户ID，可通过获取当前用户信息接口获取，响应消息体中的id字段的值就是用户ID。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
name	String	参数解释：用户名称。约束限制：不涉及。取值范围：最小长度：2，最大长度：64。默认取值：不涉及。
nick_name	String	参数解释：用户昵称。约束限制：不涉及。取值范围：最小长度：2，最大长度：30。默认取值：不涉及。

请求示例

修改工时

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
  }
}