Help Center/ CodeArts Req/ API Reference/ API/ IPD Status Management/ Querying the Work Item Status

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

Online Debugging

CLI Examples

View PDF

Querying the Work Item Status

Function

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

Calling Method

For details, see Calling APIs.

URI

GET /v1/ipdprojectservice/projects/{project_id}/category/{category_id}/statuses

**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
category_id	Yes	String	Definition: 5-digit ID of the work item type. Constraints: Regular expression: ^[\d]{5} Options: IPD-system device: 10021 (RR), 10065 (SF), 10020 (IR), 10022 (SR), 10029 (AR), 10027 (task), and 10033 (bug) IPD-standalone software: 10021 (RR), 10065 (SF), 10020 (IR), 10023 (US), 10027 (task), and 10033 (bug) IPD-self-operated software/cloud service: 10001 (epic), 10028 (FE), 10021 (RR), 10023 (US), 10027 (task), and 10033 (bug) 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

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
total	Integer	Definition: Total number of queried records. Options: N/A
result	Array of StatusVO objects	Definition: Query result. Options: N/A
status	String	Definition: Status code. Options: N/A
message	String	Definition: Response message. Options: N/A

**Table 4** StatusVO
Parameter	Type	Description
name	String	Definition: Status name. Options: N/A
belonging	String	Definition: Work item status. Options: START, IN_PROGRESS, and END

Example Requests

GET https://{endpoint}/v1/ipdprojectservice/projects/39d30be0842e4e5d8e28ee7e1712c6a2/category/10001/statuses

Example Responses

Status code: 200

{
  "status" : "success",
  "message" : null,
  "result" : [ {
    "code" : "Start",
    "name" : "Initial",
    "belonging" : "START"
  } ],
  "total" : 1
}