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

Querying the Work Item List

Function

This API is used to query the work item list.

Calling Method

For details, see Calling APIs.

URI

POST /v1/ipdprojectservice/projects/{project_id}/issues/query

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

issue_type

Yes

String

Definition:

Work item type, which is case sensitive. If an incorrect work item type is transferred, no data is returned. For system device and standalone software projects, if issue_type is set to a work item type without parent-child relationship, only the data of the first work item type is returned.

Constraints:

Multiple values are supported. Use commas (,) to separate them.

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.

Default value:

N/A

Request Parameters

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

filter

No

Array of Map<String,ConditionVO> objects

Definition:

Query filter.

Constraints:

Maximum length: 200 characters.

filter_mode

No

String

Definition:

Filter mode.

Constraints:

Maximum length: 512 characters.

Options:

N/A

Default value:

N/A

page

No

PageInfoVO object

Definition:

Pagination information.

Constraints:

N/A

sort

No

Array of SortInfo objects

Definition:

Sorting criteria.

Constraints:

N/A

return_fields

No

Array of strings

Definition:

Returned field.

Constraints:

N/A

model_ids

No

Array of strings

Definition:

Model ID.

Value range:

10001: system device

10002: standalone software

10003: self-operated software/cloud service

Constraints:

N/A

Table 4 ConditionVO

Parameter

Mandatory

Type

Description

values

No

Array of strings

Definition:

Condition array.

Constraints:

Maximum length: 200 characters.

operator

No

String

Definition:

Operator.

Constraints:

N/A

Options:

N/A

Default value:

N/A

Table 5 PageInfoVO

Parameter

Mandatory

Type

Description

page_no

No

Integer

Definition:

Page index.

Constraints:

N/A

Options:

Minimum value: 1. Maximum value: 10,000.

Default value:

N/A

page_size

No

Integer

Definition:

Number of records displayed on each page

Constraints:

N/A

Options:

Minimum value: 5. Maximum value: 200.

Default value:

N/A

Table 6 SortInfo

Parameter

Mandatory

Type

Description

field

No

String

Definition:

Sorting field.

Constraints:

N/A

Options:

N/A

Default value:

N/A

asc

No

Boolean

Definition:

Whether the data is sorted by ascending order.

Constraints:

N/A

Options:

true: yes

false: no

Default value:

N/A

Response Parameters

Status code: 200

Table 7 Response body parameters

Parameter

Type

Description

status

String

Definition:

Status.

Options:

N/A

message

String

Definition:

Information.

Options:

N/A

result

Map<String,Object>

Definition:

Result data.

Status code: 400

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

Post https://{endpoint}/v1/ipdprojectservice/projects/{project_id}/issues/query?issue_type=IR,US

{
  "filter" : [ {
    "descendants.plan_pi" : {
      "values" : [ "956200745322848257" ],
      "operator" : "||"
    },
    "descendants.plan_iteration" : {
      "values" : [ "956200745322848257-child" ],
      "operator" : "||"
    }
  }, {
    "descendants.priority" : {
      "values" : [ "Medium" ],
      "operator" : "||"
    }
  }, {
    "descendants.assignee" : {
      "values" : [ "a360371833bf4c558f796fd707b44daf" ],
      "operator" : "||"
    }
  }, {
    "descendants.status" : {
      "values" : [ "Start" ],
      "operator" : "||"
    }
  }, {
    "parent_id" : {
      "values" : [ "" ],
      "operator" : "||"
    }
  } ],
  "page" : {
    "page_no" : 1,
    "page_size" : 20
  }
}

Example Responses

Status code: 200

OK

{
  "status" : "success",
  "message" : null,
  "result" : {
    "total" : 1,
    "issues" : [ {
      "promised" : null,
      "type" : "raw requirement",
      "src_domain" : {
        "id" : "965714701520515072",
        "name" : "IPD-System Device-0217",
        "title" : "IPD-System Device-0217",
        "project_id" : "e4b0424709934bd1a54753e70336564d",
        "parent_id" : null,
        "category" : "Project",
        "created_by" : "a360371833bf4c558f796fd707b44daf",
        "model_id" : "10001"
      },
      "domain_id" : {
        "id" : "965714701520515072",
        "name" : "IPD-System Device-0217",
        "title" : "IPD-System Device-0217",
        "project_id" : "e4b0424709934bd1a54753e70336564d",
        "parent_id" : null,
        "category" : "Project",
        "created_by" : "a360371833bf4c558f796fd707b44daf",
        "model_id" : "10001"
      },
      "send_from" : "",
      "number" : "RR20240402742063",
      "send_to" : "",
      "convolution_actual_hours" : null,
      "workload_man_day" : null,
      "id" : "981935538274476033",
      "state" : "Working",
      "stay_days" : 1,
      "assigned_cc" : null,
      "submit_time" : "1712041275000",
      "workitem2label" : null,
      "close_time" : null,
      "priority" : {
        "id" : "965714705672876036",
        "display_value" : "Medium",
        "value" : "Medium",
        "code" : "Medium",
        "value_py" : "2",
        "sequence" : 2,
        "level" : 1,
        "domain_id" : "965714701520515072",
        "belong_definition_type" : "5"
      },
      "modified_date" : "1712041276000",
      "created_by" : {
        "watcher" : null,
        "user_id" : "a360371833bf4c558f796fd707b44daf",
        "user_num_id" : 4091,
        "user_name" : "devcloud_devcloud_s00404480_01",
        "domain_id" : "4e919d73499648e3b0292cd3cbef806a",
        "domain_name" : "devcloud_devcloud_s00404480_01",
        "nick_name" : "Test account",
        "role_id" : "8dc2cd191a104148a77f937681f9a5d6,6af50476ba89492698d237fb6fa456d6",
        "role_name" : "Project administrator, Project manager",
        "role_code" : "project_admin,Project manager",
        "image_id" : null,
        "region" : null,
        "has_removed" : null
      },
      "break_status" : {
        "id" : "965714705672876041",
        "display_value" : "Not broken down",
        "value" : "undecomposed",
        "code" : "undecomposed",
        "value_py" : "undecomposed",
        "sequence" : 2,
        "level" : 1,
        "domain_id" : "965714701520515072",
        "belong_definition_type" : "5"
      },
      "status_modified_date" : "1712041276000",
      "canceled" : null,
      "expect_delivery_time" : null,
      "parent_id" : null,
      "assignee" : {
        "watcher" : null,
        "user_id" : "a360371833bf4c558f796fd707b44daf",
        "user_num_id" : 4091,
        "user_name" : "devcloud_devcloud_s00404480_01",
        "domain_id" : "4e919d73499648e3b0292cd3cbef806a",
        "domain_name" : "devcloud_devcloud_s00404480_01",
        "nick_name" : "Test account",
        "role_id" : "8dc2cd191a104148a77f937681f9a5d6,6af50476ba89492698d237fb6fa456d6",
        "role_name" : "Project administrator, Project manager",
        "role_code" : "project_admin,Project manager",
        "image_id" : null,
        "region" : null,
        "has_removed" : null
      },
      "region" : "region01",
      "status" : {
        "id" : "965714705815482388",
        "belonging" : "START",
        "space_id" : "965714701520515072",
        "name" : "Analyzing",
        "status_category" : null,
        "code" : "Analyse",
        "definition_type" : "5",
        "belong_definition_type" : 3,
        "belong_scope" : null,
        "display_value" : "Analyzing",
        "position" : 2,
        "displayable" : 1,
        "editable" : 1,
        "deletable" : 1,
        "mutable" : 1,
        "title_py" : "fx",
        "builtin" : null,
        "label" : null,
        "description" : null,
        "created_by" : "a360371833bf4c558f796fd707b44daf",
        "created_userinfo" : null,
        "created_on" : null,
        "created_date" : 1708202727000,
        "modified_date" : 1708202727000,
        "modified_by" : "a360371833bf4c558f796fd707b44daf",
        "category_code" : null,
        "editing_fields" : null,
        "associate" : null,
        "linkage_node_fields" : false
      },
      "tenant_id" : "4e919d73499648e3b0292cd3cbef806a",
      "link" : "",
      "is_suspended" : null,
      "change_status" : null,
      "title" : "RR-01",
      "sum_workload_man_day" : null,
      "plan_end_date" : null,
      "rr2ir" : "",
      "convolution_plan_hours" : null,
      "submitted_by" : [ {
        "watcher" : null,
        "user_id" : "a360371833bf4c558f796fd707b44daf",
        "user_num_id" : 4091,
        "user_name" : "devcloud_devcloud_s00404480_01",
        "domain_id" : "4e919d73499648e3b0292cd3cbef806a",
        "domain_name" : "devcloud_devcloud_s00404480_01",
        "nick_name" : "Test account",
        "role_id" : "8dc2cd191a104148a77f937681f9a5d6,6af50476ba89492698d237fb6fa456d6",
        "role_name" : "Project administrator, Project manager",
        "role_code" : "project_admin,Project manager",
        "image_id" : null,
        "region" : null,
        "has_removed" : null
      } ],
      "rr2us" : "",
      "cascade_delete" : "none",
      "recipient" : [ {
        "watcher" : null,
        "user_id" : "a360371833bf4c558f796fd707b44daf",
        "user_num_id" : 4091,
        "user_name" : "devcloud_devcloud_s00404480_01",
        "domain_id" : "4e919d73499648e3b0292cd3cbef806a",
        "domain_name" : "devcloud_devcloud_s00404480_01",
        "nick_name" : "Test account",
        "role_id" : "8dc2cd191a104148a77f937681f9a5d6,6af50476ba89492698d237fb6fa456d6",
        "role_name" : "Project administrator, Project manager",
        "role_code" : "project_admin,Project manager",
        "image_id" : null,
        "region" : null,
        "has_removed" : null
      } ],
      "modified_by" : {
        "watcher" : null,
        "user_id" : "a360371833bf4c558f796fd707b44daf",
        "user_num_id" : 4091,
        "user_name" : "devcloud_devcloud_s00404480_01",
        "domain_id" : "4e919d73499648e3b0292cd3cbef806a",
        "domain_name" : "devcloud_devcloud_s00404480_01",
        "nick_name" : "Test account",
        "role_id" : "8dc2cd191a104148a77f937681f9a5d6,6af50476ba89492698d237fb6fa456d6",
        "role_name" : "Project administrator, Project manager",
        "role_code" : "project_admin,Project manager",
        "image_id" : null,
        "region" : null,
        "has_removed" : null
      },
      "created_date" : "1712041275000",
      "closed_flag" : null,
      "category" : "RR",
      "collaborative_status" : [ ],
      "setup" : true,
      "parent_status" : "no"
    } ]
  }
}

Status Codes

Status Code

Description

200

OK

400

Error message.

Error Codes

See Error Codes.