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

Updated on 2025-09-10 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying the Work Item Status List

Function

This API is used to query the work item status list.

Calling Method

For details, see Calling APIs.

URI

GET /v1/ipdprojectservice/projects/{project_id}/status

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: 32-character UUID of a project, which uniquely identifies a project. Obtain the value of this parameter from the project_id field in the response body of the Querying the Project List API. Constraints: Regular expression: ^[A-Za-z0-9]{32}$ Options: N/A Default value: N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
categories	Yes	String	Definition: Work item type. Constraints: Minimum length: 2 characters. Maximum length: 128 characters. Options: For system device projects, options include RR, SF, IR, SR, AR, Task, and Bug. For standalone software projects, options include RR, SF, IR, US, Task, and Bug. For cloud service projects, options include RR, Epic, FE, US, Task, and Bug. Multiple work item types can be supported, which are separated by commas (,), for example, IR,SR,AR. Work item types that are not transferred to the project are filtered out. 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	StatusListResult object	Definition: Status list.
status	String	Definition: Query result status. Options: N/A
message	String	Definition: Error message. Options: N/A

**Table 5** StatusListResult
Parameter	Type	Description
status	Array of StatusEntity objects	Definition: Status list.

**Table 6** StatusEntity
Parameter	Type	Description
id	String	Definition: Status ID. Options: N/A
belonging	String	Definition: Work item status. Options: START, IN_PROGRESS, and END
display_value	String	Definition: Status. Options: N/A
code	String	Definition: Unique status ID. Options: N/A
created_by	String	Definition: Status creator. Options: N/A
created_time	String	Definition: Status creation time. Options: N/A
modified_by	String	Definition: Status modifier. Options: N/A
modified_time	String	Definition: Latest modification time of a status. Options: N/A
category_code	Array of strings	Definition: Work items that use the status.

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

https://{endpoint}/v1/ipdprojectservice/projects/336ad84c67ea4783b2edc1bb5a112da0/status?categories=FE,IR

Example Responses

Status code: 200

{
  "status" : "success",
  "message" : null,
  "result" : {
    "status" : [ {
      "id" : "954399210965348356",
      "belonging" : "START",
      "display_value" : "Initial",
      "code" : "Start",
      "created_by" : "a360371833bf4c558f796fd707b44daf",
      "created_time" : "1705476103000",
      "modified_by" : "a360371833bf4c558f796fd707b44daf",
      "modified_time" : "1705476103000",
      "category_code" : [ "IR", "SR" ]
    }, {
      "id" : "954399210965348363",
      "belonging" : "START",
      "display_value" : "Analysis",
      "code" : "Analyse",
      "created_by" : "a360371833bf4c558f796fd707b44daf",
      "created_time" : "1705476103000",
      "modified_by" : "a360371833bf4c558f796fd707b44daf",
      "modified_time" : "1705476103000",
      "category_code" : [ "Bug", "IR", "SR" ]
    }, {
      "id" : "958806581085904896",
      "belonging" : "IN_PROGRESS",
      "display_value" : "openapi-test",
      "code" : "s7150727397899378688",
      "created_by" : "a360371833bf4c558f796fd707b44daf",
      "created_time" : "1706526902000",
      "modified_by" : "a360371833bf4c558f796fd707b44daf",
      "modified_time" : "1706526902000",
      "category_code" : [ "IR" ]
    }, {
      "id" : "954399210965348376",
      "belonging" : "IN_PROGRESS",
      "display_value" : "Test",
      "code" : "Test",
      "created_by" : "a360371833bf4c558f796fd707b44daf",
      "created_time" : "1705476103000",
      "modified_by" : "a360371833bf4c558f796fd707b44daf",
      "modified_time" : "1705476103000",
      "category_code" : [ "Bug", "IR", "SR" ]
    }, {
      "id" : "954399210965348369",
      "belonging" : "IN_PROGRESS",
      "display_value" : "Development",
      "code" : "Develop",
      "created_by" : "a360371833bf4c558f796fd707b44daf",
      "created_time" : "1705476103000",
      "modified_by" : "a360371833bf4c558f796fd707b44daf",
      "modified_time" : "1705476103000",
      "category_code" : [ "IR", "SR" ]
    }, {
      "id" : "954399210961154063",
      "belonging" : "IN_PROGRESS",
      "display_value" : "Confirm",
      "code" : "ToBeConfirmed",
      "created_by" : "a360371833bf4c558f796fd707b44daf",
      "created_time" : "1705476103000",
      "modified_by" : "a360371833bf4c558f796fd707b44daf",
      "modified_time" : "1705476103000",
      "category_code" : [ "Bug" ]
    }, {
      "id" : "954399210965348354",
      "belonging" : "IN_PROGRESS",
      "display_value" : "Recovery",
      "code" : "Fixed",
      "created_by" : "a360371833bf4c558f796fd707b44daf",
      "created_time" : "1705476103000",
      "modified_by" : "a360371833bf4c558f796fd707b44daf",
      "modified_time" : "1705476103000",
      "category_code" : [ "Bug" ]
    }, {
      "id" : "954399210961154057",
      "belonging" : "IN_PROGRESS",
      "display_value" : "Acceptance",
      "code" : "Checking",
      "created_by" : "a360371833bf4c558f796fd707b44daf",
      "created_time" : "1705476103000",
      "modified_by" : "a360371833bf4c558f796fd707b44daf",
      "modified_time" : "1705476103000",
      "category_code" : [ "Bug" ]
    }, {
      "id" : "954399210961154060",
      "belonging" : "END",
      "display_value" : "Closure",
      "code" : "Closed",
      "created_by" : "a360371833bf4c558f796fd707b44daf",
      "created_time" : "1705476103000",
      "modified_by" : "a360371833bf4c558f796fd707b44daf",
      "modified_time" : "1705476103000",
      "category_code" : [ "Bug" ]
    }, {
      "id" : "954399210965348381",
      "belonging" : "END",
      "display_value" : "Completed",
      "code" : "Finish",
      "created_by" : "a360371833bf4c558f796fd707b44daf",
      "created_time" : "1705476103000",
      "modified_by" : "a360371833bf4c558f796fd707b44daf",
      "modified_time" : "1705476103000",
      "category_code" : [ "IR", "SR" ]
    } ]
  }
}

Status code: 400

{

"error_code": "PM.02175903",

"error_msg": "Work item type error"

}

{
  "error_code" : "PM.02175000",
  "error_msg" : "System busy. Try again later."
}

Status Codes

Status Code	Description
200	OK
400	{ "error_code": "PM.02175903", "error_msg": "Work item type error" }

Status Code

Description

200

400

{

"error_code": "PM.02175903",

"error_msg": "Work item type error"

}

Error Codes

See Error Codes.

Parent topic: IPD Configuration Management

Previous topic: Querying Fields

Next topic: IPD Project Plan Management

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot