文档首页/ 需求管理 CodeArts Req/ API参考/ API/ OpenAPI管理/ 创建工时
更新时间：2025-10-15 GMT+08:00
在线调试
CLI示例
查看PDF
分享

创建工时

功能介绍

创建工时

调用方法

请参见如何调用API。

URI

POST /v1/ipdprojectservice/projects/{project_id}/work-items/{workitem_id}/work-hour

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

workitem_id

是

String

工作项id

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

work_hour_category

否

String

工时类型唯一标识取值为value，页面展示取值为display_value

work_date_begin

是

String

工时开始日期

work_date_end

是

String

工时结束日期

work_hours

是

String

工时数值

work_hour_type

是

String

工时类型：1：总数 2：每天

include_weekend

是

Boolean

是否包含周末

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，可通过获取当前用户信息（WorkSpace服务）接口获取，响应消息体中的id字段的值就是用户id。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

name

String

参数解释：

用户名称。

约束限制：

最小长度：2，最大长度：64。

取值范围：

不涉及。

默认取值：

不涉及。

nick_name

String

参数解释：

用户昵称。

约束限制：

最小长度：2，最大长度：30。

取值范围：

不涉及。

默认取值：

不涉及。

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述，对error_code的补充解释。

请求示例

创建总数为100，开始时间从2024/02/01至2024/02/06，工时类型为研发设计，包含周末的工时数据

POST https://{endpoint}/v1/ipdprojectservice/projects/05c7d8bcf3db4829bc841e4ba93aaea5/work-items/976857692367659008/work-hour?_=1708329665577

{
  "work_hour_category" : "研发设计",
  "work_date_begin" : "2024/02/01",
  "work_date_end" : "2024/02/02",
  "work_hours" : "12",
  "work_hour_type" : 1,
  "include_weekend" : true,
  "description" : "工作内容工作内容工作内容"
}

响应示例

状态码：200

创建工时返回体

{
  "status" : "success",
  "message" : null,
  "result" : {
    "data" : [ {
      "work_date" : "1745337600000",
      "modified_by" : "testuser",
      "work_hour_category" : {
        "id" : "1",
        "display_value" : "后端开发",
        "value" : "后端开发",
        "value_py" : "hdkf",
        "sequence" : 2,
        "level" : 1,
        "domain_id" : "1",
        "created_by" : "testuser",
        "created_date" : 1744750470000,
        "modified_by" : "testuser",
        "modified_date" : 1744750470000,
        "belong_definition_type" : "5"
      },
      "description" : null,
      "operation_id" : "1",
      "id" : "1",
      "work_hours" : 0.5,
      "title" : null,
      "created_by" : "testuser"
    } ],
    "work_hours_total" : 1
  }
}

状态码

状态码

描述

200

创建工时返回体

400

失败返回体

错误码

请参见错误码。

父主题： OpenAPI管理

相关文档