Help Center/ CodeArts Req/ API Reference/ APIs/ Work Items of the Scrum Project/ Queries the associated Wikis associated with the current work item.

Updated on 2023-06-12 GMT+08:00

View PDF

Queries the associated Wikis associated with the current work item.

Function

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the 32-bit ID of the devcloud project. Minimum: 32 Maximum: 32
issue_id	Yes	Integer	Work Item ID

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Number of records on each page
offset	No	Integer	Offset

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies a user token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token. Minimum: 10 Maximum: 32768

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
wikis	Array of AttachWikiDetail objects	Associated wiki list
total	Integer	Total

**Table 5** AttachWikiDetail
Parameter	Type	Description
issue_id	Integer	Work Item ID
wiki_title	String	Wiki Title
wiki_author	SimpleUser object
project	SimpleProject object
created_date	String	Created
wiki_id	String	wiki ID
region	String	Indicates the region value.

**Table 6** SimpleUser
Parameter	Type	Description
user_num_id	Integer	User ID
user_id	String	Indicates the user UUID.
user_name	String	Account name
nick_name	String	Nickname of the user.

**Table 7** SimpleProject
Parameter	Type	Description
project_name	String	Project name
project_id	String	Project ID

Status code: 400

**Table 8** Response body parameters
Parameter	Type	Description
error_msg	String	Description
error_code	String	Error Codes

Status code: 401

**Table 9** Response body parameters
Parameter	Type	Description
error_msg	String	Description
error_code	String	Error Codes

Example Requests

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

Example Responses

Status code: 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"
}