Help Center/ CodeArts Req/ API Reference/ API/ IPD Workflow/ Obtaining Details of a Workflow and Its Transition Lines

Updated on 2025-07-01 GMT+08:00

Online Debugging

CLI Examples

View PDF

Obtaining Details of a Workflow and Its Transition Lines

Function

This API is used to obtain details of a workflow and its transition lines.

Calling Method

For details, see Calling APIs.

URI

GET /v1/ipdprojectservice/projects/{project_id}/workflow-template

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Description: 32-bit UUID of a project, which uniquely identifies a project. You can obtain the project ID by calling the API for querying the project list. The value of project_id in the response body is the project ID. Constraints: regular expression, ^[A-Za-z0-9]{32}$ Default value: N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
issue_category	Yes	String	Definition: Work item type. Constraints: Regular expression: ^(RR\|IR\|AR\|SR\|Bug\|FE\|Task\|US\|Epic\|SF) Options: RR, IR, AR, SR, Bug, FE, Task, US, Epic, and SF Default value: N/A

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	Definition: User token. Obtain the token by calling theObtaining a User TokenIAM API. In the returned response header, X-Subject-Token is the desired user token. Constraints: Mandatory. Range: Minimum length: 10 character. Maximum length: 32,768 characters. Default value: N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
result	WorkflowTemplateVO object	Definition: Query result. Options: N/A
status	String	Definition: Status code. Options: N/A
message	String	Definition: Response message. Options: N/A

**Table 5** WorkflowTemplateVO
Parameter	Type	Description
processNodes	Array of WorkflowTemplateNodesVO objects	Definition: Status information in a status flow. Options: N/A
processFlows	Array of WorkflowTemplateFlowsVO objects	Definition: Transition line information in a status flow. Options: N/A

**Table 6** WorkflowTemplateNodesVO
Parameter	Type	Description
name	String	Definition: Status name. Options: N/A

**Table 7** WorkflowTemplateFlowsVO
Parameter	Type	Description
before_rule_validator	Array of WorkflowTemplateConfigsVO objects	Definition: Pre-transition verification. Options: N/A
before_rule_configs	Array of WorkflowTemplateConfigsVO objects	Definition: In-transition page configuration. Options: N/A
from_code	String	Definition: Entry status of a transition line. Options: N/A
to_code	String	Definition: Exit status of a transition line. Options: N/A

**Table 8** WorkflowTemplateConfigsVO
Parameter	Type	Description
configValue	Array of Map<String,String> objects	Definition: Operation item configuration. Options: N/A

Example Requests

GEThttps://{endpoint}/v1/ipdprojectservice/projects/39d30be0842e4e5d8e28ee7e1712c6a2/workflow-template?issue_category=RR

Example Responses

Status code: 200

Success response.

{
  "status" : "success",
  "message" : null,
  "result" : {
    "process_nodes" : [ {
      "code" : "Analyse",
      "name" : "Analysis"
    } ],
    "process_flows" : [ {
      "code" : "Analyse2ToBeConfirmed",
      "name" : "Turn back",
      "from_code" : "Analyse",
      "to_code" : "ToBeConfirmed",
      "before_rule_configs" : [ ],
      "before_rule_validator" : [ ]
    } ]
  }
}