文档首页/需求管理 CodeArts Req/API参考/API/Scrum项目的工作项/查询当前工作项已经关联的关联Wiki
更新时间：2025-05-22 GMT+08:00
查看PDF
分享

查询当前工作项已经关联的关联Wiki

功能介绍

查询当前工作项已经关联的关联Wiki

URI

GET /v4/projects/{project_id}/issues/{issue_id}/associated-wikis

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

devcloud项目的32位id

issue_id

是

Integer

工作项ID

表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

每页数量

offset

否

Integer

偏移量

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

wikis

Array of AttachWikiDetail objects

关联的wiki列表

total

Integer

总数

表5 AttachWikiDetail

参数

参数类型

描述

issue_id

Integer

工作项ID

wiki_title

String

Wiki标题

wiki_author

SimpleUser object

用户信息

project

SimpleProject object

项目信息

created_date

String

创建时间

wiki_id

String

wiki ID

region

String

region值

表6 SimpleUser

参数

参数类型

描述

user_num_id

Integer

用户数字id

user_id

String

用户uuid

user_name

String

账号名

nick_name

String

用户昵称

表7 SimpleProject

参数

参数类型

描述

project_name

String

项目名称

project_id

String

项目id

状态码：400

表8 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

状态码：401

表9 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

请求示例

GET https://{endpoint}/v4/projects/{project_id}/issues/{issue_id}/associated-wikis

响应示例

状态码：200

{
  "wikis" : [ {
    "issue_id" : 1234,
    "wiki_title" : "wikidemo",
    "wiki_author" : {
      "user_num_id" : 4091,
      "user_id" : "a360371833bf4c558f796fd707b44daf",
      "user_name" : "demo_user_name_xiongzhitest001",
      "nick_name" : "demo"
    },
    "project" : {
      "project_name" : "demo",
      "project_id" : "58d9050550c847c89885c1797a718b0c"
    },
    "created_date" : "2021-11-18 19:47:34",
    "wiki_id" : "1839097",
    "region" : "cn-north-xxx"
  } ],
  "total" : "success"
}

状态码

状态码

描述

200

ok

400

Bad Request

401

Unauthorized

错误码

请参见错误码。