更新时间:2025-07-28 GMT+08:00
分享

查询工作项状态列表

功能介绍

查询工作项状态列表

调用方法

请参见如何调用API

URI

GET /v1/ipdprojectservice/projects/{project_id}/status

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

正则表达式,^[A-Za-z0-9]{32}$。

取值范围

不涉及。

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

categories

String

参数解释:

工作项类型。

约束限制:

最小长度2,最大长度128。

取值范围:

系统设备类项目可选值为:RR/SF/IR/SR/AR/Task/Bug;

独立软件类项目可选值为:RR/SF/IR/US/Task/Bug;

云服务类项目可选值为:RR/Epic/FE/US/Task/Bug。

支持多种工作项类型,使用英文逗号分隔,如category=IR,SR,AR。传项目外的工作项类型会被过滤掉。

默认取值:

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

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

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

result

StatusListResult object

参数解释:

状态列表。

status

String

参数解释:

查询结果状态。

取值范围:

不涉及。

message

String

参数解释:

错误信息。

取值范围:

不涉及。

表5 StatusListResult

参数

参数类型

描述

status

Array of StatusEntity objects

参数解释:

状态列表。

表6 StatusEntity

参数

参数类型

描述

id

String

参数解释:

状态id。

取值范围:

不涉及。

belonging

String

参数解释:

工作项的状态属性。

取值范围:

START、IN_PROGRESS、END。

display_value

String

参数解释:

状态名。

取值范围:

不涉及。

code

String

参数解释:

状态唯一标识。

取值范围:

不涉及。

created_by

String

参数解释:

状态创建人。

取值范围:

不涉及。

created_time

String

参数解释:

状态创建时间。

取值范围:

不涉及。

modified_by

String

参数解释:

状态修改人。

取值范围:

不涉及。

modified_time

String

参数解释:

状态最近修改时间。

取值范围:

不涉及。

category_code

Array of strings

参数解释:

状态被哪些工作项使用。

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

https://{endpoint}/v1/ipdprojectservice/projects/336ad84c67ea4783b2edc1bb5a112da0/status?categories=FE,IR

响应示例

状态码:200

OK

{
  "status" : "success",
  "message" : null,
  "result" : {
    "status" : [ {
      "id" : "954399210965348356",
      "belonging" : "START",
      "display_value" : "初始",
      "code" : "Start",
      "created_by" : "a360371833bf4c558f796fd707b44daf",
      "created_time" : "1705476103000",
      "modified_by" : "a360371833bf4c558f796fd707b44daf",
      "modified_time" : "1705476103000",
      "category_code" : [ "IR", "SR" ]
    }, {
      "id" : "954399210965348363",
      "belonging" : "START",
      "display_value" : "分析",
      "code" : "Analyse",
      "created_by" : "a360371833bf4c558f796fd707b44daf",
      "created_time" : "1705476103000",
      "modified_by" : "a360371833bf4c558f796fd707b44daf",
      "modified_time" : "1705476103000",
      "category_code" : [ "Bug", "IR", "SR" ]
    }, {
      "id" : "958806581085904896",
      "belonging" : "IN_PROGRESS",
      "display_value" : "openapi-test",
      "code" : "s7150727397899378688",
      "created_by" : "a360371833bf4c558f796fd707b44daf",
      "created_time" : "1706526902000",
      "modified_by" : "a360371833bf4c558f796fd707b44daf",
      "modified_time" : "1706526902000",
      "category_code" : [ "IR" ]
    }, {
      "id" : "954399210965348376",
      "belonging" : "IN_PROGRESS",
      "display_value" : "测试",
      "code" : "Test",
      "created_by" : "a360371833bf4c558f796fd707b44daf",
      "created_time" : "1705476103000",
      "modified_by" : "a360371833bf4c558f796fd707b44daf",
      "modified_time" : "1705476103000",
      "category_code" : [ "Bug", "IR", "SR" ]
    }, {
      "id" : "954399210965348369",
      "belonging" : "IN_PROGRESS",
      "display_value" : "开发",
      "code" : "Develop",
      "created_by" : "a360371833bf4c558f796fd707b44daf",
      "created_time" : "1705476103000",
      "modified_by" : "a360371833bf4c558f796fd707b44daf",
      "modified_time" : "1705476103000",
      "category_code" : [ "IR", "SR" ]
    }, {
      "id" : "954399210961154063",
      "belonging" : "IN_PROGRESS",
      "display_value" : "确认",
      "code" : "ToBeConfirmed",
      "created_by" : "a360371833bf4c558f796fd707b44daf",
      "created_time" : "1705476103000",
      "modified_by" : "a360371833bf4c558f796fd707b44daf",
      "modified_time" : "1705476103000",
      "category_code" : [ "Bug" ]
    }, {
      "id" : "954399210965348354",
      "belonging" : "IN_PROGRESS",
      "display_value" : "修复",
      "code" : "Fixed",
      "created_by" : "a360371833bf4c558f796fd707b44daf",
      "created_time" : "1705476103000",
      "modified_by" : "a360371833bf4c558f796fd707b44daf",
      "modified_time" : "1705476103000",
      "category_code" : [ "Bug" ]
    }, {
      "id" : "954399210961154057",
      "belonging" : "IN_PROGRESS",
      "display_value" : "验收",
      "code" : "Checking",
      "created_by" : "a360371833bf4c558f796fd707b44daf",
      "created_time" : "1705476103000",
      "modified_by" : "a360371833bf4c558f796fd707b44daf",
      "modified_time" : "1705476103000",
      "category_code" : [ "Bug" ]
    }, {
      "id" : "954399210961154060",
      "belonging" : "END",
      "display_value" : "关闭",
      "code" : "Closed",
      "created_by" : "a360371833bf4c558f796fd707b44daf",
      "created_time" : "1705476103000",
      "modified_by" : "a360371833bf4c558f796fd707b44daf",
      "modified_time" : "1705476103000",
      "category_code" : [ "Bug" ]
    }, {
      "id" : "954399210965348381",
      "belonging" : "END",
      "display_value" : "完成",
      "code" : "Finish",
      "created_by" : "a360371833bf4c558f796fd707b44daf",
      "created_time" : "1705476103000",
      "modified_by" : "a360371833bf4c558f796fd707b44daf",
      "modified_time" : "1705476103000",
      "category_code" : [ "IR", "SR" ]
    } ]
  }
}

状态码:400

{

"error_code": "PM.02175903",

"error_msg": "工作项类型错误"

}

{
  "error_code" : "PM.02175000",
  "error_msg" : "系统繁忙,请稍后再试"
}

状态码

状态码

描述

200

OK

400

{

"error_code": "PM.02175903",

"error_msg": "工作项类型错误"

}

错误码

请参见错误码

相关文档