文档首页/ 需求管理 CodeArts Req/ API参考/ API/ Scrum项目的工作项/ 工时类型列表V5 - ListWorkHoursTypeV5
更新时间:2026-09-15 GMT+08:00
分享

工时类型列表V5 - ListWorkHoursTypeV5

功能介绍

工时类型列表。

调用方法

请参见如何调用API。

授权信息

当前API调用无需身份策略权限。

URI

GET /v5/projects/{project_uuid}/work-hours-type

表1 路径参数

参数

是否必选

参数类型

描述

project_uuid

是

String

参数解释:

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

约束限制:

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

取值范围:

不涉及。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

status

否

Integer

参数解释:

工时类型是否有效。

约束限制:

不涉及。

取值范围:

0表示被删除

1表示有效

2表示废弃。

默认取值:

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及。

取值范围:

长度为10~32768个字符。

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

result

result object

参数解释:

返回结果。

status

String

参数解释:

返回状态

取值范围:

success:返回成功。

error:返回失败。

表5 result

参数

参数类型

描述

total_count

Integer

参数解释:

工时类型的总个数。

取值范围:

不涉及。

list

Array of list objects

参数解释:

工时类型列表。

表6 list

参数

参数类型

描述

id

Integer

参数解释:

工时类型的主键id。

取值范围:

不涉及。

project_num_id

Integer

参数解释:

项目数字id。

取值范围:

不涉及。

name

String

参数解释:

工时类型的名称。

取值范围:

不涉及。

created

String

参数解释:

工时类型的创建时间(格式:yyyy-MM-dd HH:mm:ss.z,格式示例:2025-08-06 10:00:51.0)。

取值范围:

不涉及。

modified

String

参数解释:

工时类型的修改时间(格式:yyyy-MM-dd HH:mm:ss.z,格式示例:2025-08-06 10:00:51.0)。

取值范围:

不涉及。

position

Integer

参数解释:

工时类型在列表中的位置。

取值范围:

不涉及。

status

Integer

参数解释:

工时类型是否有效。

取值范围:

0表示被删除

1表示有效

2表示废弃。

in_use

Boolean

参数解释:

工时类型是否已被使用。

取值范围:

true:已被使用的工时类型

false:未被使用的工时类型

请求示例

GET https://{endpoint}/v5/projects/c15cc54e338d4506afd9bd8103071ff0/work-hours-type?status=1

响应示例

状态码:200

{
  "result" : {
    "total_count" : 2,
    "list" : [ {
      "id" : 21,
      "project_num_id" : 6345282,
      "name" : "研发设计",
      "created" : "2025-08-06 10:00:51.0",
      "modified" : "2025-08-06 10:00:51.0",
      "position" : 1,
      "status" : 1,
      "in_use" : true
    }, {
      "id" : 22,
      "project_num_id" : 6345282,
      "name" : "后端开发",
      "created" : "2025-08-06 10:00:51.0",
      "modified" : "2025-08-06 10:00:51.0",
      "position" : 2,
      "status" : 1
    } ]
  },
  "status" : "success"
}

状态码

状态码

描述

200

工时类型列表接口成功的响应。

错误码

请参见错误码。

相关文档