On this page

Function
Calling Method
URI
Request Parameters
Response Parameters
Example Requests
Example Responses
Status Codes
Error Codes

Show all

Help Center/ CodeArts Pipeline/ API Reference/ API/ Change Management/ Querying the Change List

Querying the Change List

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

Online Debugging

CLI Examples

View PDF

Function

This API is used to query the change list.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{cloudProjectId}/change-requests/search

**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

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
statuses	No	Array of strings	Definition: Change status. Constraints: N/A Value range: N/A Default value: N/A
creator_ids	No	String	Definition: Creator ID. Constraints: N/A Value range: The value consists of 32 characters, including digits and letters. Default value: N/A
title	No	String	Definition: Change name. Constraints: N/A Value range: N/A Default value: N/A
component_id	Yes	String	Definition: Pipeline microservice ID. Obtain the ID by calling the API for querying microservices. data.id indicates the microservice ID. Constraints: N/A Value range: The value consists of 32 characters, including only digits and letters. Default value: N/A
offset	Yes	Integer	Definition: Offset where the query starts. Constraints: N/A Value range: The offset value must be no less than 0. Default value: N/A
limit	Yes	Integer	Definition: Number of records of each query. Constraints: N/A Value range: The value is no less than 0. Default value: N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
total	Integer	Definition: Total number of change records. Value range: N/A
data	Array of ChangeRequestVO objects	Definition: Change history details. Value range: N/A

**Table 4** ChangeRequestVO
Parameter	Type	Description
id	String	Definition: Change ID. Value range: The value consists of 32 characters, including digits and letters.
component_id	String	Definition: Microservice ID. Value range: The value consists of 32 characters, including digits and letters.
status	String	Definition: Status. Value range: N/A
title	String	Definition: Title. Value range: N/A
repos	Array of repos objects	Definition: Code repository of a change. Value range: N/A
workitem_ids	Array of strings	Definition: Work item ID. Value range: N/A
release_time	String	Definition: Release time. Value range: N/A
creator_id	String	Definition: Creator ID. Value range: The value consists of 32 characters, including digits and letters.
creator_name	String	Definition: Creator name. Value range: N/A
create_time	String	Definition: Creation time. Value range: N/A
updater_id	String	Definition: Updater ID. Value range: The value consists of 32 characters, including digits and letters.
updater_name	String	Definition: Updater name. Value range: N/A
update_time	String	Definition: Update time. Value range: N/A

**Table 5** repos
Parameter	Type	Description
repo_id	String	Definition: Repo ID. Value range: N/A
http_url	String	Definition: HTTP address of the code repository. Value range: N/A
git_url	String	Definition: Git address of the code repository. Value range: N/A
feature_branch	String	Definition: Feature branch. Value range: N/A
main_branch	String	Definition: Default branch. Value range: N/A
delete_branch_after_released	Boolean	Definition: Whether to delete the feature branch after release. Value range: true: Delete the feature branch after release. false: Do not delete the feature branch after release.

Example Requests

POST https://{endpoint}/v2/2d09f712e9504b61b034cc8f40e475a8/change-requests/search

{
  "statuses" : [ "developing", "releasing", "to_be_released" ],
  "creator_ids" : null,
  "title" : "",
  "component_id" : "f7ced2341b204d2b82c607c6f0de5b4a",
  "offset" : 0,
  "limit" : 10
}

Example Responses

Status code: 200

{
  "total" : 1,
  "data" : [ {
    "id" : "adebc0cd4e9f44dfb92a6f5ad5106c2b",
    "component_id" : "f7ced2341b204d2b82c607c6f0de5b4a",
    "status" : "developing",
    "title" : "11",
    "repos" : [ {
      "repo_id" : "804934",
      "http_url" : "https://example.com/test00001/maven.git",
      "git_url" : "git@example.com:test00001/maven.git",
      "feature_branch" : "aaa",
      "main_branch" : "master",
      "delete_branch_after_released" : false
    } ],
    "workitem_ids" : null,
    "release_time" : null,
    "creator_id" : "05d8ca972f114765a8984795a8aa4d41",
    "creator_name" : "test5",
    "create_time" : "1719231005",
    "updater_id" : "05d8ca972f114765a8984795a8aa4d41",
    "updater_name" : "test5",
    "update_time" : "1719231005"
  } ]
}

Status Codes


Status Code	Description
200	ok

Error Codes

See Error Codes.

Parent Topic: Change Management

Previous topic: Modifying the Code Repository of a Change

Next topic: Querying Changes in a Pipeline

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