Updated on 2026-10-27 GMT+08:00

Querying Work Item Process Information

Function

This API is used to query work item process information.

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}/work-item/{issue_id}/flow/detail

**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
issue_category	Yes	String	Definition Work item type. Constraints N/A Range Multiple work item types are supported, separated by commas (,), for example, category=IR,SR,AR. 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

**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
status	String	Definition Status code. Range N/A
message	String	Definition Response message. Range N/A
result	WorkItemFlowInfoVO object	Definition Response body of workflow details. Range N/A

**Table 5** WorkItemFlowInfoVO
Parameter	Type	Description
process_instance	WorkItemFlowProcessInstanceVO object	Definition Work item workflow instance information. Range N/A
next_flow	Array of FlowsInfoVO objects	Definition Valid transition lines. Range N/A

**Table 6** WorkItemFlowProcessInstanceVO
Parameter	Type	Description
process_instance	WorkItemFlowProcessInstanceVO object	Definition Work item workflow instance information. Range N/A
next_flow	Array of FlowsInfoVO objects	Definition Valid transition lines. Range N/A
id	String	Definition ID of a work item workflow instance. Range N/A
flow_state	Integer	Definition Whether a workflow instance is suspended. Range 1: running 2: suspended

**Table 7** FlowsInfoVO
Parameter	Type	Description
code	String	Definition Transition line code. Range N/A
name	String	Definition Transition line name. Range N/A
description	String	Definition Transition line description. Range N/A
from_code	String	Definition Code of the current workflow node. Range N/A
to_code	String	Definition Code of the target workflow node. Range N/A

Example Requests

Query workflow information of work item IR with ID 1169236596358213632.

GET https://{endpoint}/v1/ipdprojectservice/projects/9df557a4017d4b1b9cd53b96e44a4a50/work-item/1169236596358213632/flow/detail?issue_category=IR

Example Responses

Status code: 200

{
  "status" : "success",
  "message" : null,
  "result" : {
    "process_instance" : {
      "id" : "1169236596680073217",
      "flow_state" : 1
    },
    "next_flow" : [ {
      "code" : "__virtual_Start__2__Analyse",
      "name" : "",
      "description" : null,
      "extra_config" : null,
      "from_code" : "Start",
      "to_code" : "Analyse"
    }, {
      "code" : "__virtual_Start__2__Develop",
      "name" : "",
      "description" : null,
      "extra_config" : null,
      "from_code" : "Start",
      "to_code" : "Develop"
    } ],
    "fail_result" : null
  }
}

Status Codes

Status Code	Description
200	Response to a successful request for querying the work item process information.

Error Codes

See Error Codes.

Parent topic: IPD Work Item Process