Querying Work Item Details V2

Function

This API is used to query work item details. Only basic information about the work item is returned. Associated work items and child work items are not returned.

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:workitem:get	Read	-	codeartsreq:Model codeartsreq:ProjectId	-	-

URI

GET /v2/ipdprojectservice/projects/{project_id}/issues/{issue_id}

**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
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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
category	Yes	String	Definition Work item type. Constraints N/A Range Multiple work item types are supported, separated by commas (,). System device projects: RR, SF, IR, SR, AR, Task, and Bug. Standalone software projects: RR, SF, IR, US, Task, and Bug. Custom requirement model projects: Obtain the value by calling the Obtaining the Model Tree Configuration API. The code in the response body is the work item type code. Default Value N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
status	String	Definition Response status. Range success: The response is returned successfully. error: The response fails.
message	String	Definition Returned information of the request. Range N/A
data	IssueInfoVO object	Definition Work item details.

**Table 4** IssueInfoVO
Parameter	Type	Description
id	String	Definition ID of the work item to be updated. Range N/A
title	String	Definition Work item title. Range N/A
description	String	Definition Work item description field. Range N/A
type	String	Definition Work item category definition. Range requirement: R&D requirement. bug: Defect. task: Task. feature: Feature. raw_requirement: Raw requirement.
number	String	Definition Work item ID. Range N/A
category	String	Definition Work item type. Range Multiple work item types are supported, separated by commas (,). System device projects: RR, SF, IR, SR, AR, Task, and Bug. Standalone software projects: RR, SF, IR, US, Task, and Bug. Cloud service projects: RR, Epic, FE, US, Task, and Bug.
parent_id	String	Definition Parent work item ID. Range N/A
project_id	String	Definition 32-character UUID of a project, which must be unique. Range N/A
status	String	Definition Work item status code. Range Start: Initial. Analyse: To be analyzed. Develop: Developing. Test: Testing. Finish: Completed.
state	String	Definition Work item lifecycle. Range In use: work items that can be operated properly Discarded: soft-deleted work items that can be restored from the recycle bin
assignee	UserEntity object	Definition Work item owner.
assigned_cc	Array of UserEntity objects	Definition Cc recipient of a work item. Multiple Cc recipients are supported. A work item can be copied to a maximum of 50 recipients.
created_by	UserEntity object	Definition Work item creator.
created_time	String	Definition Work item creation time, which is a Unix timestamp (unit: millisecond). Range N/A
modified_by	UserEntity object	Definition Latest updater of a work item.
modified_time	String	Definition Last update time of the work item, which is a Unix timestamp (unit: millisecond). Range N/A
plan_end_date	String	Definition Planned end date of a work item, which is a Unix timestamp (unit: millisecond). Range N/A
close_time	String	Definition Work item closure time, which is a Unix timestamp (unit: millisecond). Range N/A
workload	String	Definition Planned workloads of a work item. One decimal place is reserved. The value ranges from 0 to 999999999.9. Range 0-999999999.9
workload_sum	String	Definition Actual workloads of a work item. Range 0-999999999.9
tenant_id	String	Definition ID of the tenant to which the work item belongs. Obtain the value from the Querying Tree-shaped Work Items API. The value is tenant_id in the response body. Range N/A
link	String	Definition IDs of associated items of a work item. Range N/A
suspended	Boolean	Definition Whether a work item is suspended. Range true and false
status_modified_time	String	Definition Time when the work item status changes, which can be used to calculate the number of days that the work item stays in the current status. The value is a Unix timestamp, in milliseconds. Range N/A
labels	Array of LabelEntity objects	Definition Work item label.
custom_fields	Array of FieldCodeValuePair objects	Definition Work item custom field mapping. System fields added by users are also listed here. The structure is as follows: "code": Field code. "value": Field value.
children	Array of IssueInfoVO objects	Definition Child work item set of a work item.
path	String	Definition Path of a child work item. Range N/A
ir2feature	String	Definition Association field of IRs and SFs.
need_break	String	Definition Whether a work item needs to be broken down. Range yes: Breakdown is required. no: Breakdown is not required.
break_status	String	Definition Decomposition status. decomposed: Decomposed. undecomposed: Undecomposed. --: N/A. Range decomposed: Decomposed. undecomposed: Undecomposed. --: N/A.
baseline	String	Definition Work item baseline status. Range null: not baselined baselined baseline-reviewing: baseline review in progress
priority	String	Definition Work item priority. Some work items have this field. Range Low Medium High
related_network_security	String	Definition Whether network security is involved. Range yes: Network security is involved. no: Network security is not involved.
collaboratives	String	Definition R&D requirement collaboration task ID. Obtain the value from the Querying Tree-shaped Work Items API. The value is collaboratives in the response body. Range N/A
business_domain	String	Definition Domain field. Range software soft-hardware hardware Performance Functions O&M Operations User experience Privacy protection Compliance Resilience (reliability/availability) Resilience (hazard detection and recovery) Transparent Harmless Security API Cost Maintainability Other DFX Availability others
plan_pi	String	Definition Work item release plan ID. Range N/A
plan_iteration	String	Definition ID of the sprint plan in which the work item is completed. The field is the fixing sprint plan ID for bugs. Range N/A
change_status	String	Definition Work item change status. change-reviewing: Change reviewing. changed: Changed. unchange or null: Not changed. Range change-reviewing: Change reviewing. changed: Changed. unchanged: Not changed. null: Not changed.
no_break_reason	String	Definition Reason for no breakdown required. Range 0 to 512 characters.
submitted_by	Array of UserEntity objects	Definition Work item proposer.
ir2rr	String	Definition ID of the RR associated with the IR. Use commas (,) to separate multiple IDs. Range N/A
feature_set	String	Definition Feature set ID. Range N/A
expected_repair_date	String	Definition Expected fixing time. This field is available only for bugs. The value is a Unix timestamp, in milliseconds. Range N/A
found_pi	String	Definition ID of the release plan where a bug is found. This field is available only for bugs. Range N/A
found_iteration	String	Definition ID of the sprint plan where a bug is found. This field is available only for bugs. Range N/A
reason_analysis	String	Definition Reason analysis. Range 0 to 50,000 characters.
repair_solution	String	Definition Fix solution. This field is available only for bugs. Range N/A
test_report	String	Definition Test report. This field is available only for bugs. Range N/A
sys_no_repair_reason	String	Definition Reason why rectification is not required. This field is available only for bugs. Range N/A
sys_activation_reason	String	Definition Activation reason. This field is available only for bugs. Range N/A
sys_return_reason	String	Definition Reason for return. This field is available only for bugs. Range N/A
test_failures_times	Integer	Definition Number of times that regression failed. This field is available only for bugs. Range N/A
close_type	String	Definition Closure type. Among preset fields, only bugs have this field. The optional values are: problem_solved: Closed as problem solved. problem_to_requirement: Closed as problem converted to requirement. duplicate_problem: Closed as a duplicate problem. not_a_problem: Closed as not a problem. These correspond to problem solved closure, problem converted to requirement closure, duplicate problem closure, and non-problem closure, respectively. Range problem_solved: Closed as problem solved. problem_to_requirement: Closed as problem converted to requirement. duplicate_problem: Closed as a duplicate problem. not_a_problem: Closed as not a problem.

**Table 5** UserEntity
Parameter	Type	Description
id	String	Definition User ID. Obtain it by calling the API for querying project members. The value of id in the response message body is the user ID. Range N/A
name	String	Definition Username. Range 2 to 64 characters.
nick_name	String	Definition User alias. Range 2 to 30 characters

**Table 6** LabelEntity
Parameter	Type	Description
id	String	Definition Label ID, which is the value of id in the response body returned by calling the API for querying the label list. Range A string of 18 to 19 digits.
category_types	Array of strings	Definition Code of the work item type to which a label belongs.
label_type	String	Definition Type of the work item to which the label belongs, corresponding to the type field of the work item. The options are as follows. Range raw requirement feature (system feature) requirement (R&D requirement) task bug
color	String	Definition Label RGB color. Range The available color codes and their descriptions are as follows: #86CAFF: light sky blue #6DDEBB: aquamarine #A6DD82: light green #FAC20A: golden yellow #FA9841: sandy orange #F66F6A: light coral #F3689A: pink #A97AF8: medium purple #71757F: slate gray #5E7CE0: soft blue #207AB3: steel blue #169E6C: sea green #6CA83B: olive green #B58200: dark golden yellow #B54E04: burnt orange #B02121: dark red #AD215B: dark pink #572DB3: deep violet #4F4F4F: dark gray #3C51A6: indigo blue
title	String	Definition Label title. Range N/A

**Table 7** FieldCodeValuePair
Parameter	Type	Description
code	String	Definition Code of a custom field of a work item. Obtain the value from the Querying Field Templates API. The value is code in the response body. Range N/A
value	String	Definition Custom field value of a work item. Range N/A

**Table 8** SecurityLevelResult
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

**Table 9** 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

Querying R&D requirement details

GET https://{endpoint}/v2/ipdprojectservice/projects/ce075137bdb74086a700ce80dfd5f08a/issues/1027299517722046465?category=IR

Example Responses

Status code: 200

{
  "status" : "success",
  "message" : null,
  "data" : {
    "id" : "1027299517722046465",
    "title" : "11111",
    "description" : "<p>[Requirement background]</p><p><br></p>[Requirement value]</p> <p><br></p><p>[Requirement details]</p>",
    "type" : "requirement",
    "number" : "IR20240805197935",
    "category" : "IR",
    "project_id" : "ce075137bdb74086a700ce80dfd5f08a",
    "status" : "Start",
    "state" : "Working",
    "assignee" : {
      "id" : "a360371833bf4c558f796fd707b44daf",
      "name" : "devcloud_devcloud_01",
      "nick_name" : "Test alias"
    },
    "created_by" : {
      "id" : "a360371833bf4c558f796fd707b44daf",
      "name" : "devcloud_devcloud_01",
      "nick_name" : "Test alias"
    },
    "modified_by" : {
      "id" : "a360371833bf4c558f796fd707b44daf",
      "name" : "devcloud_devcloud_01",
      "nick_name" : "Test alias"
    },
    "tenant_id" : "4e919d73499648e3b0292cd3cbef806a",
    "link" : "",
    "labels" : [ ],
    "custom_fields" : [ ],
    "path" : "/1027299517722046465",
    "ir2feature" : "",
    "need_break" : "yes",
    "break_status" : "decomposed",
    "priority" : "Medium",
    "related_network_security" : "no",
    "business_domain" : "software",
    "submitted_by" : [ {
      "id" : "a360371833bf4c558f796fd707b44daf",
      "name" : "devcloud_devcloud_01",
      "nick_name" : "Test alias"
    } ],
    "ir2rr" : "1027242599229992961"
  }
}

Status code: 400

{
  "error_code" : "PM.02174103",
  "error_msg" : "No permission."
}

Status Codes

Status Code	Description
200	OK
400	Response upon a request failure. For example, the user does not have the operation permission or the project does not exist.

Error Codes

See Error Codes.

Parent topic: IPD Work Item Management

Previous topic: Creating Work Items in Batches

Next topic: Querying Work Item List on the Personal Workbench