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

查询关联新版wiki信息V5

功能介绍

查询关联新版wiki信息。

调用方法

请参见如何调用API

URI

GET /v5/{project_id}/issue/attach-wiki

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

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

取值范围

不涉及。

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

issue_id

Integer

参数解释:

工作项id,可通过高级查询工作项接口获取,响应消息体中的id字段的值就是工作项id。

约束限制:

长度在1位到10位之间的纯数字。

取值范围:

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

默认取值:

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

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

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

data

Array of AssociateWiki objects

参数解释:

关联wiki数据列表。

total

Integer

参数解释:

关联wiki的总条数。

取值范围:

不涉及。

表5 AssociateWiki

参数

参数类型

描述

region

String

参数解释:

所属区域。

取值范围:

不涉及。

project

ProjectWikiVO object

参数解释:

项目信息。

issue_id

Integer

参数解释:

工作项数字id。

取值范围:

不涉及。

title

String

参数解释:

关联wiki的名称。

取值范围:

不涉及。

wiki_id

String

参数解释:

关联wiki的主键id。

取值范围:

不涉及。

type

String

参数解释:

关联项的类型。

取值范围:

Wiki。

author

User object

参数解释:

关联wiki的操作人。

created_date

String

参数解释:

关联wiki的操作时间(格式:yyyy-MM-dd HH:mm:ss,格式示例:2025-08-07 10:08:05)。

取值范围:

不涉及。

identifier

String

参数解释:

工作项32位uuid。

取值范围:

不涉及。

表6 ProjectWikiVO

参数

参数类型

描述

project_id

String

参数解释:

项目uuid

取值范围:

不涉及。

name

String

参数解释:

项目名称

取值范围:

不涉及。

id

Integer

参数解释:

项目数字id

取值范围:

不涉及。

project_type

String

参数解释:

项目类型

取值范围:

scrum。

表7 User

参数

参数类型

描述

name

String

参数解释:

带租户信息的用户名(租户_用户名)。

取值范围:

不涉及。

id

Integer

参数解释:

用户数字id。

取值范围:

不涉及。

nick_name

String

参数解释:

用户昵称。

取值范围:

不涉及。

uuid

String

参数解释:

用户32位uuid。

取值范围:

不涉及。

请求示例

GET https://{endpoint}/v5/c15cc54e338d4506afd9bd8103071ff0/issue/attach-wiki?issue_id=9178848&_=1753243179592

响应示例

状态码:200

OK

{
  "total" : 1,
  "data" : [ {
    "region" : "example",
    "project" : {
      "id" : 34243525,
      "project_id" : "a8ac165097ff4e42bcfb234dd27d30a6",
      "name" : "test",
      "project_type" : "scrum"
    },
    "issue_id" : "9164403",
    "title" : "test",
    "wiki_id" : "bed0de10b38a41f4b1118766c100f175",
    "type" : "Wiki",
    "author" : {
      "id" : 4091,
      "uuid" : "xxxxxx",
      "name" : "xxxxxx",
      "nick_name" : "xxxxxx"
    },
    "created_date" : "2025-08-07 10:08:05",
    "identifier" : "59bc7e5da34f430687f23bba00b5e861"
  } ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档