Obtaining the Wikis Associated with a Work Item

Function

This API is used to obtain the wikis associated with a work item.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
codeartsreq:attachment:get	Read	-	codeartsreq:Model codeartsreq:ProjectId	-	-

URI

GET /v1/ipdprojectservice/projects/{project_id}/issue/get-attached-wikis

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition 32-character ID of a project, which must be unique. Obtain the value by calling the API for querying the IPD project list. The value of id in the response message body is the project ID. Constraints N/A Range A string of 32 characters consisting of letters and digits. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
category	No	String	Definition Work item type. Constraints 2 to 32 characters, including letters, underscores (_), and commas (,). Range Multiple values are supported. Use commas (,) to separate them. For system device projects, options include RR, SF, IR, SR, AR, Task, and Bug. For standalone software projects, options include RR, SF, IR, US, Task, and Bug. Review type: CR, BR, and GR (If you want to query the wiki associated with a review request, the category field is mandatory.) Default Value N/A
issue_id	Yes	String	Definition Unique ID of a work item. You can obtain the value from the Querying Work Items or Querying Tree-shaped Work Items API. The value is id in the response body. Constraints N/A Range A string of 18 to 19 digits. Default Value N/A

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. Obtain a token by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Constraints N/A Range 10 to 32,768 characters Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Integer	Total number.
data	Array of GetAttachedWikiDetail objects	Definition Wiki data object. Range N/A

**Table 5** GetAttachedWikiDetail
Parameter	Type	Description
region	String	Definition Region. Range N/A
project	project object	Definition Project to which a wiki belongs. Range N/A
wiki_id	String	Definition Wiki ID. Range N/A
title	String	Definition Wiki title. Range N/A
issue_id	String	Definition ID of the work item associated with the wiki. Range N/A
type	String	Definition Wiki type. Range N/A
created_date	String	Definition Wiki creation time. Range N/A
author	author object	Definition Wiki author. Range N/A
identifier	String	Definition Wiki storage ID. Range N/A
code	String	Definition Wiki code. Range N/A

**Table 6** project
Parameter	Type	Description
project_id	String	Definition Project ID. Range N/A
name	String	Definition Project name. Range N/A
project_type	String	Definition Project type. The value is fixed to ipd. Range N/A

**Table 7** author
Parameter	Type	Description
id	String	Definition Wiki creator ID. Range N/A
name	String	Definition Wiki creator name. Range N/A

Status code: 400

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code. Range N/A
error_msg	String	Definition Error description, which is a supplement to error_code. Range N/A

Example Requests

GET https://{endpoint}/v1/ipdprojectservice/projects/2f9fe4cc8d434ee788be972bbe482b28/issue/get-attached-wikis?category=IR&issue_id=1176214762635960321

Example Responses

Status code: 200

{
  "total" : 1,
  "data" : [ {
    "identifier" : "8a9c4b2e587b423aa66fa0a65151c897",
    "code" : "",
    "issue_id" : "1182824050077601793",
    "author" : {
      "name" : "test",
      "id" : "639f1285b6ff4dda80f88d90571c8bf2"
    },
    "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"
  } ]
}

Status code: 400

{
  "error_code" : "PM.02176709",
  "error_msg" : "No view permission"
}

Status Codes

Status Code	Description
200	Success response
400	Error cause

Error Codes

See Error Codes.

Parent topic: IPD Work Item Management

Previous topic: Querying Work Item Details

Next topic: Creating an IPD Project Work Item