Help Center/ CodeArts Req/ API Reference/ API/ IPD Work Item Process/ Transitioning the Work Item Status
Updated on 2025-07-01 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Transitioning the Work Item Status

Function

This API is used to transition the status of a work item.

Calling Method

For details, see Calling APIs.

URI

POST /v1/ipdprojectservice/projects/{project_id}/work-item/flow/transfer

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

Request Parameters

Table 2 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
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

id

Yes

String

Definition:

Unique ID of a work item.

Constraints:

Regular expression: ^([0-9]{18,19})$

Options:

N/A

Default value:

N/A

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

flow_code

Yes

String

Definition:

Work item transition code.

Constraints:

Regular expression: ^[\s\S]{1,500}

Options:

N/A

Default value:

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

status

String

Definition:

Status code.

Options:

N/A

message

String

Definition:

Response message.

Options:

N/A

Example Requests

POST /v1/ipdprojectservice/projects/39d30be0842e4e5d8e28ee7e1712c6a2/work-item/flow/transfer

{
  "id" : "1135239465657217024",
  "issue_category" : "Bug",
  "flow_code" : "__virtual_Analyse__2__Fixed"
}

Example Responses

Status code: 200

Success response.

{
  "status" : "success",
  "message" : null
}

Status Codes

Status Code

Description

200

Success response.

Error Codes

See Error Codes.

Parent topic: IPD Work Item Process