Help Center/ CodeArts Pipeline/ API Reference/ API/ Change Management/ Querying Changes in a Pipeline

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

Online Debugging

CLI Examples

View PDF

Querying Changes in a Pipeline

Function

This API is used to query changes in a pipeline.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{cloudProjectId}/pipeline/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
component_id	Yes	String	Definition: 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 digits and letters. 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
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
statuses	Yes	Array of strings	Definition: Change status. Constraints: N/A Value range: N/A Default value: N/A
title	No	String	Definition: Change name. Constraints: N/A Value range: N/A 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/pipeline/change-requests/search

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

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"
  } ]
}