文档首页/ 需求管理 CodeArts Req/ API参考/ API/ Scrum项目的工作项/ 查询工作项中已离项的用户信息
更新时间:2025-09-11 GMT+08:00
分享

查询工作项中已离项的用户信息

功能介绍

查询工作项中已离项的用户信息。

调用方法

请参见如何调用API

URI

GET /v1/related-user/{project_id}/all

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

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

取值范围

不涉及。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

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

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

result

result object

参数解释:

返回结果。

status

String

参数解释:

返回状态。

取值范围:

success:返回成功。

error:返回失败。

表4 result

参数

参数类型

描述

related_assignee_list

Array of RelatedUserDetail objects

参数解释:

工作项中已离项的当前责任人。

related_author_list

Array of RelatedUserDetail objects

参数解释:

工作项中已离项的创建人。

related_developer_list

Array of RelatedUserDetail objects

参数解释:

工作项中已离项的开发人员。

表5 RelatedUserDetail

参数

参数类型

描述

user_name

String

参数解释:

用户名。

取值范围:

不涉及。

user_num_id

Integer

参数解释:

用户数字id。

取值范围:

不涉及。

nick_name_py

String

参数解释:

用户昵称拼音。

取值范围:

不涉及。

user_id

String

参数解释:

用户32位uuid。

取值范围:

不涉及。

domain_id

String

参数解释:

用户租户id。

取值范围:

不涉及。

domain_name

String

参数解释:

用户的租户名称。

取值范围:

不涉及。

请求示例

GET http://{endpoint}/v1/related_user/f385a0028b184fe3ae6d593db128c0e5/all

响应示例

状态码:200

查询工作项中已离项的用户信息接口成功的响应。

{
  "result" : {
    "related_author_list" : [ ],
    "related_assignee_list" : [ {
      "domain_id" : "xxxxxx",
      "domain_name" : "xxxxxx",
      "user_num_id" : 1111,
      "user_id" : "xxxxxx",
      "user_name" : "xxxxxx",
      "nick_name_py" : ""
    } ],
    "related_developer_list" : [ ]
  },
  "status" : "success"
}

状态码

状态码

描述

200

查询工作项中已离项的用户信息接口成功的响应。

错误码

请参见错误码

相关文档