Help Center/ CodeArts Pipeline/ API Reference/ API/ Change Management/ Querying Work Items Associated with a Change
Updated on 2025-09-08 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Work Items Associated with a Change

Function

This API is used to query work items associated with a change.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{cloudProjectId}/change-request/{changeRequestId}/workitems/query

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

cloudProjectId

Yes

String

Definition:

Project ID. For details, see Obtaining a Project ID.

Constraints:

N/A

Value range:

The value consists of 32 characters, including digits and letters.

Default value:

N/A

changeRequestId

Yes

String

Definition:

Change ID of the change-triggered pipeline. Obtain the ID by calling the API for querying changes. data.id indicates the pipeline ID.

Constraints:

N/A

Value range:

The value consists of 32 characters, including digits and letters.

Default value:

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

[items]

Array of WorkItemVO objects

Definition:

Work items.

Value range:

N/A
Table 3 WorkItemVO

Parameter

Type

Description

work_item_id

String

Definition:

Work item ID.

Value range:

N/A

status

String

Definition:

Work item status.

Value range:

N/A

title

String

Definition:

Work item title.

Value range:

N/A

type

String

Definition:

Work item status.

Value range:

N/A

Example Requests

GET http://{endpoint}/v2/2d09f712e9504b61b034cc8f40e475a8/change-request/adebc0cd4e9f44dfb92a6f5ad5106c2b/workitems/query

Example Responses

Status code: 200

OK

[ {
  "work_item_id" : "2332711",
  "status" : "New",
  "title" : "asdsa",
  "type" : "Story"
} ]

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.

Parent Topic: Change Management