获取工作项关联的wiki列表 - ShowIpdAttachedWiki
功能介绍
获取工作项关联的wiki列表
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
URI
GET /v1/ipdprojectservice/projects/{project_id}/issue/get-attached-wikis
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目32位ID,项目唯一标识,通过查询IPD项目列表获取,响应消息体中的id字段的值就是项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| issue_id | 是 | String | 参数解释: 工作项唯一ID。可以通过查询工作项列表或者查询树状工作项接口获取,响应消息体中的id字段的值就是工作项ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| category | 否 | String | 参数解释: 工作项类型。 约束限制: 正则表达式:([A-Za-z_,]{2,32})。 取值范围: 系统设备类项目可选值为:RR/SF/IR/SR/AR/Task/Bug,独立软件类项目可选值为:RR/SF/IR/US/Task/Bug,云服务类项目可选值为:RR/Epic/FE/US/Task/Bug;或评审单类型,可选值为CR/BR/GR,如果查询评审单关联的wiki,category字段必填。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 最小长度:10,最大长度:32768。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Integer | 总数 |
| data | Array of GetAttachedWikiDetail objects | 参数解释: wiki数据对象。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| region | String | 参数解释: 区域。 取值范围: 不涉及。 |
| project | project object | 参数解释: wiki所属的项目信息。 取值范围: 不涉及。 |
| wiki_id | String | 参数解释: wiki ID。 取值范围: 不涉及。 |
| title | String | 参数解释: wiki 标题。 取值范围: 不涉及。 |
| issue_id | String | 参数解释: wiki关联的工作项ID。 取值范围: 不涉及。 |
| type | String | 参数解释: wiki的类型。 取值范围: 不涉及。 |
| created_date | String | 参数解释: wiki创建时间。 取值范围: 不涉及。 |
| author | author object | 参数解释: wiki的作者信息。 取值范围: 不涉及。 |
| identifier | String | 参数解释: wiki的存储id。 取值范围: 不涉及。 |
| sm_level_sequence | String | 参数解释: wiki的密级,如果环境非涉密则无需关注此字段。 取值范围: 不涉及。 |
| code | String | 参数解释: wiki的编码。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| project_id | String | 参数解释: 项目id。 取值范围: 不涉及。 |
| name | String | 参数解释: 项目名称。 取值范围: 不涉及。 |
| project_type | String | 参数解释: 项目类型,固定为"ipd" 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: wiki的创建者id。 取值范围: 不涉及。 |
| name | String | 参数解释: wiki的创建者名字。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误描述,对error_code的补充解释。 取值范围: 不涉及。 |
请求示例
/v1/ipdprojectservice/projects/2f9fe4cc8d434ee788be972bbe482b28/issue/get-attached-wikis?category=IR&issue_id=1176214762635960321
响应示例
状态码:200
成功响应
{
"total" : 1,
"data" : [ {
"identifier" : "8a9c4b2e587b423aa66fa0a65151c897",
"code" : "",
"issue_id" : "1182824050077601793",
"author" : {
"name" : "test",
"id" : "639f1285b6ff4dda80f88d90571c8bf2"
},
"sm_level_sequence" : "0",
"project" : {
"project_type" : "ipd",
"project_id" : "6c01fd31aa13485c80716e6f44c0683d",
"name" : "QUN-M1-0926-ZY"
},
"created_date" : "2025-10-08 23:20:55",
"region" : "roma-dev-1-ar",
"title" : "tt1",
"type" : "1",
"wiki_id" : "0436f97d56784cdebdd9c6db14236956"
} ]
} 状态码:400
错误原因
{
"error_code" : "PM.02176709",
"error_msg" : "无查看权限"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 成功响应 |
| 400 | 错误原因 |
错误码
请参见错误码。