更新时间:2025-09-10 GMT+08:00

增加工作项工时记录V3

功能介绍

增加工作项工时记录。

调用方法

请参见如何调用API

URI

POST /v3/projects/{project_uuid}/issues/{issue_id}/work-hours

表1 路径参数

参数

是否必选

参数类型

描述

project_uuid

String

参数解释

项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。

约束限制

32位的数字和字母组成的字符串。

取值范围

不涉及。

默认取值

不涉及。

issue_id

String

参数解释:

工作项id,可通过高级查询工作项接口获取,响应消息体中的id字段的值就是工作项id。

约束限制:

长度在1位到10位之间的纯数字。

取值范围:

最小长度:1,最大长度:10。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

最小长度:10,最大长度:32768。

默认取值:

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

start_date_timestamp

Integer

参数解释:

开始时间,时间戳格式(示例:1839340800000)。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

due_date_timestamp

Integer

参数解释:

截止时间,时间戳格式(示例:1839340800000)。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

start_date

String

参数解释:

开始时间,时间格式(格式:yyyy-MM-dd,示例:2025-07-25)。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

due_date

String

参数解释:

截止时间,时间格式(格式:yyyy-MM-dd,示例:2025-07-25)。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

use_timestamp

Boolean

参数解释:

是否使用时间戳。

约束限制:

不涉及。

取值范围:

true(是)

false(不是)

默认取值:

不涉及。

work_hours

Integer

参数解释:

工时(单位:人/时)。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

include_weekends

Integer

参数解释:

工时是否包含周末。

约束限制:

不涉及。

取值范围:

0(不包含)

1(包含)

默认取值:

不涉及。

type

Integer

参数解释:

时间区间总工时。

约束限制:

不涉及。

取值范围:

0(时间区间总计8小时)

1(每天8小时)

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

result

result object

参数解释:

返回结果。

status

String

参数解释:

返回状态。

取值范围:

success:返回成功。

error:返回失败。

表5 result

参数

参数类型

描述

list

Array of list objects

参数解释:

工时记录列表。

表6 list

参数

参数类型

描述

id

String

参数解释:

工时记录id。

取值范围:

不涉及。

issue_id

Integer

参数解释:

工作项id。

取值范围:

不涉及。

user_id

String

参数解释:

用户id。

取值范围:

不涉及。

user_num_id

Integer

参数解释:

用户数字id。

取值范围:

不涉及。

user_name

String

参数解释:

用户名称。

取值范围:

不涉及。

nick_name

String

参数解释:

用户昵称。

取值范围:

不涉及。

work_date

String

参数解释:

工作时间,时间格式(格式:yyyy/MM/dd,示例:2025/07/25)。

取值范围:

不涉及。

work_date_timestamp

String

参数解释:

工作时间,时间戳格式(示例:1839340800000)。

取值范围:

不涉及。

work_hours

String

参数解释:

工时(单位:人/时)。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

region

String

参数解释:

区域。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求示例

/v3/projects/381fcca9c056482d92da3e8b9da71db5/issues/69813204/work-hours

{
  "start_date_timestamp" : 1753372800000,
  "due_date_timestamp" : 1753459199999,
  "start_date" : "2025-07-25",
  "due_date" : "2025-07-25",
  "use_timestamp" : true,
  "work_hours" : 1,
  "include_weekends" : 0,
  "type" : 0
}

响应示例

状态码:200

添加工作项工时接口成功的响应。

{
  "result" : {
    "list" : [ {
      "id" : "78c74003692311f0aa95fa163e60f658",
      "issue_id" : 69813204,
      "user_id" : "073a9e23188025b31f06c0104a74c376",
      "user_num_id" : 233087,
      "user_name" : "hw_008618814464665_01",
      "nick_name" : "asdf4",
      "work_date" : "2025/07/25",
      "work_date_timestamp" : "1753372800000",
      "work_hours" : "1.0",
      "region" : "example"
    } ]
  },
  "status" : "success"
}

状态码

状态码

描述

200

添加工作项工时接口成功的响应。

错误码

请参见错误码