Advanced Query Work Item

Updated on 2023-06-12 GMT+08:00

View PDF

Function

Queries work items based on filter criteria.

URI

POST /v4/projects/{project_id}/issues

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the 32-bit ID of the devcloud project. Minimum: 32 Maximum: 32

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token. Minimum: 10 Maximum: 32768

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
assigned_ids	No	Array of integers	Specifies the processor ID.
creator_ids	No	Array of integers	Creator ID.
developer_ids	No	Array of integers	Developer ID, which corresponds to the numeric ID of the user information.
domain_ids	No	Array of integers	ID, domain, 14'Performance', 15'Function', 16'Reliability', 17'Cyber Security', 18'Maintainability', 19'Other DFX', 20'Availability',
done_ratios	No	Array of integers	Completion Rate
iteration_ids	No	Array of integers	Identifies a sprint.
limit	No	Integer	Number of records on each page. Minimum: 1 Maximum: 100
offset	No	Integer	Specifies the paging index and offset. offset is an integer multiple of limit. limit=10,offset=0,10,20... Minimum: 0
module_ids	No	Array of integers	Specifies the module ID.
priority_ids	No	Array of integers	Priority
query_type	No	String	Query type backlog feature epic
severity_ids	No	Array of integers	Search Type
status_ids	No	Array of integers	Status ID, New 1, 2 in progress, 3 resolved, 4 in the test, 5 closed, 6 rejected,
story_point_ids	No	Array of integers	Story point ID.
tracker_ids	No	Array of integers	Work item type. The options are as follows: 2: task; 3: defect /Bug,5Epic,6Feature,7Story.
include_deleted	No	Boolean	true: The queried work items contain the work items that have been logically deleted. false: The queried work items do not contain the work items that have been deleted.
updated_time_interval	No	String	Query work items according to the update time of work items (query start time and query end time).
custom_fields	No	Array of custom_fields objects	Custom Parameter

**Table 4** custom_fields
Parameter	Mandatory	Type	Description
custom_field	No	String	Customized Attribute Field
value	No	String	Value of a customized attribute.

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
issues	Array of ListIssueItemResponse objects	Work Item List
total	Integer	Total

**Table 6** ListIssueItemResponse
Parameter	Type	Description
actual_work_hours	Double	Indicates the actual person-hours.
assigned_cc_user	Array of IssueUser objects	Copy To
assigned_user	IssueUser object
begin_time	String	Estimated start time, in the format of year-month-day.
created_time	String	Creation time Year-Month-Day Hour:Minute:Second
creator	IssueUser object
custom_fields	Array of CustomField objects	Customized attribute value, which is not recommended. You are advised to refer to the new_custom_fields field.
new_custom_fields	Array of NewCustomField objects	Attribute Value
developer	IssueUser object
domain	domain object	ID, domain 14, 'Performance', 15, 'Function', 16, 'Reliability' 17,'Network security' 18, 'Maintainability' 19,'Other DFX' 20, 'Availability'
done_ratio	Integer	Work Item Progress Value
end_time	String	Estimated end time, in the format of year-month-day.
expected_work_hours	Double	Expected
id	Integer	Work Item ID
project	IssueProjectResponseV4 object	Project Information
iteration	iteration object	Iteration
module	module object	Module
name	String	Title
parent_issue	parent_issue object	Parent Work Item
priority	priority object	Work Item Priority
severity	severity object	Work Item Importance
status	status object	Work Item Statuses
tracker	tracker object	Work item type. The options are as follows: 2: task; 3: defect /Bug,5Epic,6Feature,7Story.
updated_time	String	Update time (year-month-day hour:minute:second)
closed_time	String	Close Time Year-Month-Day Hour:Minute:Second
deleted	Boolean	Indicates whether the data has been deleted. The value true indicates that the data has been deleted, and the value false indicates that the data has not been deleted.

**Table 7** IssueUser
Parameter	Type	Description
user_id	String	uuid
user_num_id	Integer	id
id	Integer	Specifies the user ID.
name	String	User Name
nick_name	String	Nickname

**Table 8** CustomField
Parameter	Type	Description
name	String	Custom Attribute
value	String	Value of a customized attribute.
new_name	String	Custom Attribute

**Table 9** NewCustomField
Parameter	Type	Description
custom_field	String	Custom Parameter
field_name	String	Custom field name
value	String	Value of a customized attribute. Use commas (,) to separate multiple values.

**Table 10** domain
Parameter	Type	Description
id	Integer	Identifies a domain.
name	String	fields

**Table 11** IssueProjectResponseV4
Parameter	Type	Description
project_id	String	Project ID
project_name	String	Project
project_num_id	Integer	Project ID

**Table 12** iteration
Parameter	Type	Description
id	Integer	Identifies a sprint.
name	String	Iteration Name

**Table 13** module
Parameter	Type	Description
id	Integer	Specifies the module ID.
name	String	Module

**Table 14** parent_issue
Parameter	Type	Description
id	Integer	Parent Work Item ID
name	String	Parent Work Item

**Table 15** priority
Parameter	Type	Description
id	Integer	Identifies a priority.
name	String	Priority

**Table 16** severity
Parameter	Type	Description
id	Integer	Identifies a severity.
name	String	Indicates the level of severity.

**Table 17** status
Parameter	Type	Description
id	Integer	Identifies a status.
name	String	Event Name

**Table 18** tracker
Parameter	Type	Description
id	Integer	Type ID
name	String	Object

Status code: 400

**Table 19** Response body parameters
Parameter	Type	Description
error_msg	String	Description
error_code	String	Error Codes

Status code: 401

**Table 20** Response body parameters
Parameter	Type	Description
error_msg	String	Description
error_code	String	Error Codes

Example Requests

POST https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/issues

{
  "status_ids" : [ 1 ]
}

Example Responses

Status code: 200

{
  "issues" : [ {
    "actual_work_hours" : 0,
    "assigned_cc_user" : [ {
      "id" : 4091,
      "name" : "demo_user_name",
      "nick_name" : ""
    } ],
    "assigned_user" : {
      "id" : 4091,
      "name" : "demo_user_name",
      "nick_name" : ""
    },
    "begin_time" : "2020-09-12",
    "created_time" : "2020-09-13 14:40:11",
    "creator" : {
      "id" : 4091,
      "name" : "demo_user_name",
      "nick_name" : ""
    },
    "custom_fields" : [ {
      "name" : "customField16",
      "value" : "",
      "new_name" : "custom_field16"
    } ],
    "new_custom_fields" : [ {
      "custom_field" : "custom_field16",
      "field_name" : "field_name",
      "value" : "2"
    } ],
    "developer" : {
      "id" : 4091,
      "name" : "demo_user_name",
      "nick_name" : ""
    },
    "domain" : {
      "id" : 14,
      "name" : ""
    },
    "done_ratio" : 0,
    "end_time" : "2020-09-19",
    "expected_work_hours" : 9,
    "id" : 4567,
    "project" : {
      "project_id" : "526cefde62004de2b62b5e8dd2c2b3af",
      "project_name" : "testDemo",
      "project_num_id" : 78953
    },
    "iteration" : {
      "id" : 456,
      "name" : ""
    },
    "module" : {
      "id" : 456,
      "name" : "Project"
    },
    "name" : "",
    "parent_issue" : {
      "id" : 123,
      "name" : ""
    },
    "priority" : {
      "id" : 1,
      "name" : ""
    },
    "severity" : {
      "id" : 12,
      "name" : ""
    },
    "status" : {
      "id" : 1,
      "name" : ""
    },
    "tracker" : {
      "id" : 7,
      "name" : "story"
    },
    "updated_time" : "2020-09-14 14:40:11",
    "closed_time" : "2020-09-15 14:40:11",
    "deleted" : false
  } ],
  "total" : 1
}