Create a Change

Function

Creating a change.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{cloudProjectId}/change-request/create

**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.
title	Yes	String	Change title.
type	No	String	Change type. The default value is code.
workitem_ids	Yes	Array of strings	Work item ID.
repos	Yes	Array of repos objects	Information of the change code repository.

**Table 3** repos
Parameter	Mandatory	Type	Description
repo_id	Yes	String	Repo code repository ID.
http_url	Yes	String	HTTP address of the code repository.
git_url	Yes	String	Git address of the code repository.
feature_branch	Yes	String	Feature branch.
main_branch	Yes	String	Default branch.
delete_branch_after_released	Yes	Boolean	Whether to delete the feature branch after release.

Response Parameters

Status code: 200

**Table 4** Response body parameters
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 http://{endpoint}/v2/2d09f712e9504b61b034cc8f40e475a8/change-request/create

{
  "component_id" : "f7ced2341b204d2b82c607c6f0de5b4a",
  "title" : "aaaaa",
  "type" : "code",
  "workitem_ids" : [ "2332711" ],
  "repos" : [ {
    "http_url" : "http://example.com/test00001/maven.git",
    "git_url" : "git@example.com:test00001/maven.git",
    "feature_branch" : "aaaaaa",
    "main_branch" : "master",
    "delete_branch_after_released" : false,
    "repo_id" : "804934"
  } ]
}

Example Responses

Status code: 200

{
  "id" : "495d94a305d4456f9a8a1efaaf2d34e0",
  "component_id" : "f7ced2341b204d2b82c607c6f0de5b4a",
  "status" : "developing",
  "title" : "aaaa",
  "repos" : [ {
    "repo_id" : "804934",
    "http_url" : "http://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" : [ "2332711" ],
  "release_time" : null,
  "creator_id" : "05d8ca972f114765a8984795a8aa4d41",
  "creator_name" : "p_test5",
  "create_time" : "1719217063",
  "updater_id" : "05d8ca972f114765a8984795a8aa4d41",
  "updater_name" : "p_test5",
  "update_time" : "1719217063"
}