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

Updated on 2025-03-25 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	Project ID.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
component_id	Yes	String	Microservice ID.
limit	Yes	Integer	Page size.
offset	Yes	Integer	Offset.
statuses	Yes	Array of strings	Change status.
title	No	String	Change name.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
total	Integer	Number of records.
data	Array of ChangeRequestVO objects	Change records.

**Table 4** ChangeRequestVO
Parameter	Type	Description
id	String	Change ID.
component_id	String	Microservice ID.
status	String	Status.
title	String	Title.
repos	Array of repos objects	Information of the change code repository.
workitem_ids	Array of strings	Work item ID.
release_time	String	Release time.
creator_id	String	Creator ID.
creator_name	String	Creator name.
create_time	String	Creation time.
updater_id	String	Updater ID.
updater_name	String	Updater name.
update_time	String	Update time.

**Table 5** repos
Parameter	Type	Description
repo_id	String	Repo code repository ID.
http_url	String	HTTP address of the code repository.
git_url	String	Git address of the code repository.
feature_branch	String	Feature branch.
main_branch	String	Default branch.
delete_branch_after_released	Boolean	Whether to 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

Change records on each page.

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