Help Center/ CodeArts Pipeline/ API Reference/ API/ Change Management/ Querying Changes Being Released

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

Online Debugging

CLI Examples

View PDF

Querying Changes Being Released

Function

This API is used to query changes being released.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{cloudProjectId}/change-request/releasing/query

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
cloudProjectId	Yes	String	Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
pipeline_id	Yes	String	Pipeline ID.
component_id	Yes	String	Microservice ID.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
[items]	Array of ChangeRequestVO objects	Change list.

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

GET https://{endpoint}/v2/2d09f712e9504b61b034cc8f40e475a8/change-request/releasing/query?pipeline_id=11f4460be6dd4f51970f624a5a8d676a&component_id=f7ced2341b204d2b82c607c6f0de5b4a

Example Responses

Status code: 200

Changes.

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