Querying Work Item Details
Function
This API is used to query work item details.
Calling Method
For details, see Calling APIs.
Authorization Information
No identity policy-based permission required for calling this API.
URI
GET /v1/ipdprojectservice/projects/{project_id}/issues/{issue_id}
| 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 |
| 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 |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| issue_type | Yes | String | Definition Work item type. Constraints 1 to 32 characters. Range Epic, FE, SF, IR, RR, SR, US, AR, Bug, and Task Default Value N/A |
| domain_id | No | String | Definition Project space ID, which can be obtained by calling the API for querying the IPD project list. The value of domain_id in the response body is the project space ID. Constraints A string of 32 characters consisting of letters and digits. Range N/A Default Value N/A |
Request 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
| Parameter | Type | Description |
|---|---|---|
| status | String | Definition Response status. Range |
| message | String | Definition Information. Range N/A |
| result | Array of IssueDetailsResponse objects | Definition Query result. |
| Parameter | Type | Description |
|---|---|---|
| id | String | Definition Work item ID. Range N/A |
| number | String | Definition Work item ID. Range N/A |
| type | String | Definition Work item type. Range N/A |
| stay_days | Integer | Definition Number of stay days. Range N/A |
| tenant_id | String | Definition Tenant ID. Range N/A |
| created_date | String | Definition Creation time of a work item. Range N/A |
| title | String | Definition Work item title. Range N/A |
| Parameter | Type | Description |
|---|---|---|
| id | String | Definition Security level field ID. Range N/A |
| display_value | String | Definition Security level field name. Range N/A |
| value | String | Definition Value of a custom security level field. Range N/A |
| code | String | Definition Security level code. Range N/A |
| sequence | Double | Definition Security level sorting value. A larger value indicates a higher security level. Range N/A |
Status code: 400
| 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/e4b0424709934bd1a54753e70336564d/issues/981935538274476033?issue_type=RR Example Responses
Status code: 200
{
"status" : "success",
"message" : "",
"result" : [ {
"position_float" : "9999999996.0678440000",
"develop_owner" : null,
"project" : {
"id" : "1276960103044919297",
"state" : "In use",
"title" : "IPD-System device 0625001",
"project_id" : "9919c49270f24584bfd99cf468704688",
"category" : "Project",
"created_by" : "d3775f2d201f423f9eeaa0b06f8f1b8f",
"modified_by" : "d3775f2d201f423f9eeaa0b06f8f1b8f",
"tenant_id" : "7e110bd5ff4e49fbacb683a2da7f79da",
"model_id" : "10001",
"project_template_id" : "10001",
"category_template_id" : "10001",
"feature_template_id" : "10001",
"created_date" : "2026-06-25T17:43:33Z"
},
"child_issues" : [ ],
"type" : "requirement",
"plan_test_end_date" : null,
"domain_id" : {
"id" : "1276960103044919297",
"name" : "IPD-System device 0625001",
"title" : "IPD-System device 0625001",
"project_id" : "9919c49270f24584bfd99cf468704688",
"parent_id" : null,
"category" : "Project",
"created_by" : "d3775f2d201f423f9eeaa0b06f8f1b8f",
"model_id" : "10001",
"children" : [ ],
"project_template_id" : "10001",
"category_template_id" : "10001",
"category_template_name" : null,
"feature_template_id" : "10001",
"feature_template_name" : null,
"is_managed_by_tenant" : false,
"is_locked" : false
},
"number" : "IR20260630026183",
"path" : "/1278755202640818176",
"convolution_actual_hours" : null,
"upstream_change_flag" : null,
"workload_man_day" : null,
"children" : null,
"id" : "1278755202640818176",
"state" : "In use",
"stay_days" : 5,
"ir2feature" : "",
"need_break" : {
"id" : "1276960107109199995",
"field_id" : "10164",
"display_value" : "Yes",
"value" : "yes",
"code" : "yes",
"value_py" : "yes",
"sequence" : 1,
"level" : 1,
"domain_id" : "1276960103044919297",
"belong_definition_type" : "5"
},
"collaborative_history" : null,
"related_network_security" : {
"id" : "1276960107109199878",
"field_id" : "10258",
"display_value" : "No",
"value" : "no",
"code" : "no",
"value_py" : "no",
"sequence" : 2,
"level" : 1,
"domain_id" : "1276960103044919297",
"belong_definition_type" : "5"
},
"assigned_cc" : null,
"workitem2label" : null,
"baseline" : {
"id" : "1276960107109199903",
"field_id" : "10106",
"display_value" : "Baselined",
"value" : "baselined",
"code" : "baselined",
"value_py" : "baselined",
"sequence" : 2,
"level" : 1,
"domain_id" : "1276960103044919297",
"belong_definition_type" : "5"
},
"close_time" : null,
"priority" : {
"id" : "1276960107109199909",
"field_id" : "10042",
"display_value" : "Medium",
"value" : "Medium",
"code" : "Medium",
"value_py" : "2",
"sequence" : 2,
"level" : 1,
"domain_id" : "1276960103044919297",
"belong_definition_type" : "5"
},
"modified_date" : "1783073007920",
"created_by" : {
"user_id" : "029f95b680474fa396fcaba6a73954af",
"user_name" : "creq_chm2",
"domain_id" : "7e110bd5ff4e49fbacb683a2da7f79da",
"nick_name" : "",
"role_id" : "1cf8f0078f6847ee8ccc23b24fe4267f",
"role_name" : "Project manager",
"role_alias_name" : "Project manager",
"role_code" : "Project manager"
},
"break_status" : {
"id" : "1276960107109199918",
"field_id" : "10253",
"display_value" : "Undecomposed",
"value" : "undecomposed",
"code" : "undecomposed",
"value_py" : "undecomposed",
"sequence" : 2,
"level" : 1,
"domain_id" : "1276960103044919297",
"belong_definition_type" : "5"
},
"status_modified_date" : "1782808598494",
"important" : null,
"collaboratives" : null,
"parent_id" : null,
"business_domain" : {
"id" : "1276960107109199972",
"field_id" : "10024",
"display_value" : "Software",
"value" : "software",
"code" : "software",
"value_py" : "rj",
"sequence" : 1,
"level" : 1,
"domain_id" : "1276960103044919297",
"belong_definition_type" : "5"
},
"assignee" : {
"user_id" : "029f95b680474fa396fcaba6a73954af",
"user_name" : "creq_chm2",
"domain_id" : "7e110bd5ff4e49fbacb683a2da7f79da",
"nick_name" : "",
"role_id" : "1cf8f0078f6847ee8ccc23b24fe4267f",
"role_name" : "Project manager",
"role_alias_name" : "Project manager",
"role_code" : "Project manager"
},
"region" : "roma-dg-7",
"inherit_button" : "hide",
"status" : {
"id" : "1276960107478298626",
"belonging" : "START",
"space_id" : "1276960103044919297",
"name" : "Initial",
"code" : "Start",
"definition_type" : "5",
"belong_definition_type" : 3,
"display_value" : "Initial",
"position" : 1,
"displayable" : 1,
"editable" : 1,
"deletable" : 1,
"mutable" : 1,
"title_py" : "cs",
"created_by" : "d3775f2d201f423f9eeaa0b06f8f1b8f",
"created_date" : 1782380614394,
"modified_date" : 1782380614394,
"modified_by" : "d3775f2d201f423f9eeaa0b06f8f1b8f",
"linkage_node_fields" : false
},
"plan_pi" : null,
"tenant_id" : "7e110bd5ff4e49fbacb683a2da7f79da",
"plan_dev_end_date" : null,
"link" : "",
"description" : "<p>[Background]</p><p><br></p><p>[Value]</p><p><br></p><p>[Details]</p><img data-src=\"/api/ipdproject/v1/projects/9919c49270f24584bfd99cf468704688/imgs/63624517320d4df6953bd3a0e28fef13.png\" src=\"/api/ipdproject/v1/projects/9919c49270f24584bfd99cf468704688/imgs/63624517320d4df6953bd3a0e28fef13.png\" data-image-id=\"img0\" devui-editorx-image=\"true\" style=\"vertical-align: baseline;\">",
"is_suspended" : null,
"change_status" : null,
"title" : "IR-E2E tracing",
"descendants" : "1278755202640818176",
"sum_workload_man_day" : "12.0",
"ir2rr" : "",
"plan_end_date" : null,
"root_id" : "1278755202640818176",
"plan_start_date" : null,
"convolution_plan_hours" : null,
"category_layer_id" : "10001",
"no_break_reason" : null,
"submitted_by" : [ {
"user_id" : "029f95b680474fa396fcaba6a73954af",
"user_name" : "creq_chm2",
"domain_id" : "7e110bd5ff4e49fbacb683a2da7f79da",
"nick_name" : "",
"role_id" : "1cf8f0078f6847ee8ccc23b24fe4267f",
"role_name" : "Project manager",
"role_alias_name" : "Project manager",
"role_code" : "Project manager"
} ],
"cascade_delete" : "none",
"issue_opinion_id" : null,
"test_owner" : null,
"issue_review_id" : null,
"modified_by" : {
"user_id" : "d3775f2d201f423f9eeaa0b06f8f1b8f",
"user_name" : "creq_chm1",
"domain_id" : "7e110bd5ff4e49fbacb683a2da7f79da",
"nick_name" : "",
"role_id" : "1cf8f0078f6847ee8ccc23b24fe4267f,e8b7a70b3d0d4c639823889498e00afe",
"role_name" : "Project manager and project administrator",
"role_alias_name" : "Project manager,Project admin",
"role_code" : "Project manager,project_admin"
},
"setup" : true,
"created_date" : "1782808598427",
"closed_flag" : null,
"category" : "IR",
"collaborative_status" : null
} ]
} Status code: 400
{
"error_code" : "PM.02174103",
"error_msg" : "Insufficient permissions."
} SDK Sample Code
The SDK sample code is as follows.
Java
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 | package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.projectman.v4.region.ProjectManRegion; import com.huaweicloud.sdk.projectman.v4.*; import com.huaweicloud.sdk.projectman.v4.model.*; public class ShowIssueDetailSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); ProjectManClient client = ProjectManClient.newBuilder() .withCredential(auth) .withRegion(ProjectManRegion.valueOf("<YOUR REGION>")) .build(); ShowIssueDetailRequest request = new ShowIssueDetailRequest(); request.withProjectId("{project_id}"); request.withIssueId("{issue_id}"); try { ShowIssueDetailResponse response = client.showIssueDetail(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkprojectman.v4.region.projectman_region import ProjectManRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkprojectman.v4 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = ProjectManClient.new_builder() \ .with_credentials(credentials) \ .with_region(ProjectManRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowIssueDetailRequest() request.project_id = "{project_id}" request.issue_id = "{issue_id}" response = client.show_issue_detail(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" projectman "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := projectman.ProjectManClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := projectman.NewProjectManClient(hcClient) request := &model.ShowIssueDetailRequest{} request.ProjectId = "{project_id}" request.IssueId = "{issue_id}" response, err := client.ShowIssueDetail(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
| Status Code | Description |
|---|---|
| 200 | Success response |
| 400 | Error cause. |
Error Codes
See Error Codes.
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot