Querying the Code Submission Records or Branch Creation Records Associated with the Current Work Item
Function
This API is used to query the code submission records or branch creation records associated with the current work item.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.
URI
GET /v4/projects/{project_id}/issues/{issue_id}/associated-commits
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition A 32-character UUID. It uniquely identifies a project. Obtain a project ID by calling the API for querying projects. The value of project_id in the response message body is a project ID. Constraints A string of 32 characters consisting of letters and digits. Range N/A Default Value N/A |
| issue_id | Yes | Integer | Definition Work item ID, which can be obtained from the API for performing advanced query of work items. The value of the id field in the response body is the work item ID. Constraints N/A Range ≥ 0 Default Value N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| type | Yes | String | Definition: Query type. Constraints: N/A Value range: commit (commits) branch (branches) Default value: N/A |
| limit | No | Integer | Definition Page size. Constraints N/A Range 1–1000 Default Value 10 |
| offset | No | Integer | Definition Start page number. The value starts from 0 and is an integer multiple of limit. Constraints Start from 0. Range 0–10000 Default Value 0 |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | Definition User token. Obtain a token by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Constraints N/A Range The value contains 10 to 32,768 characters. Default Value N/A |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| commits | Array of CommitRecordDetail objects | Definition: Commit record list. |
| total | Integer | Definition: Total number. Options: N/A |
| Parameter | Type | Description |
|---|---|---|
| branch_name | String | Definition: Branch name. Options: N/A |
| commit_id | String | Definition Commit ID. In Git, each commit generates a unique identifier, called Commit ID. It is usually a 40-character SHA-1 hash value, which uniquely identifies each commit. Range N/A |
| commit_msg | String | Definition: Commit information. Each time you submit a commit, you need to provide a description, called Commit Msg. It is used to describe the specific changes made in the commit, helping other developers understand the purpose and content of the commit. Options: N/A |
| commit_short_id | String | Definition Short ID of a commit. It is a short version of commit ID, which is usually 7 characters long. It is used to simplify the operation of referencing a specific commit while maintaining sufficient uniqueness. Range N/A |
| commit_url | String | Definition Commit URL. It is the URL that points to a specific commit. You can use the link to access the details page of the commit, to check its author, time, and changes. Range N/A |
| create_date | String | Definition: Creation time. Options: N/A |
| repository_id | String | Definition: Repository ID. In Git, it is an identifier used to uniquely identify a repository. Options: N/A |
| type | String | Definition: Query type. Value range: commit (commits) branch (branches) |
| update_date | String | Definition: Update time. Options: N/A |
| user | SimpleUser object | Definition: User information. |
| Parameter | Type | Description |
|---|---|---|
| nick_name | String | Definition User alias. You can obtain the nick_name field of a specified project member using the API for obtaining the user list of a specified project. Range N/A |
| user_id | String | Definition User UUID. You can obtain the user_id field of a specified project member using the API for obtaining the user list of a specified project. Range N/A |
| user_name | String | Definition Account name. You can obtain the user_name field of a specified project member using the API for obtaining the user list of a specified project. Range N/A |
| user_num_id | Integer | Definition User digital ID. You can obtain the user_num_id field of a specified project member using the API for obtaining the user list of a specified project. Range N/A |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Definition: Error code. Value range: N/A |
| error_msg | String | Definition: Error description. Value range: N/A |
Status code: 401
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Definition: Error code. Value range: N/A |
| error_msg | String | Definition: Error description. Value range: N/A |
| request_id | String | Definition Request ID, which is automatically generated by the system. Range N/A |
Example Requests
GET https://{endpoint}/v4/projects/a360371833bf4c558f796fd707b44daf/issues/122344/associated-commits?type=commit&limit=1&offset=10 Example Responses
Status code: 200
{
"commits" : [ {
"repository_id" : "1865706",
"branch_name" : "master",
"commit_id" : "f608b02311d90f311c41711fdf67003c31305b89",
"commit_short_id" : "f608b023",
"commit_msg" : "demo",
"commit_url" : "https://xxx.xxx/xxxx/commit/791877f7d0e0b2032bc5e38425c1245e804e8741?ref=master",
"user" : {
"user_num_id" : 4091,
"user_id" : "a360371833bf4c558f796fd707b44daf",
"user_name" : "demo_user_name_001",
"nick_name" : "bear"
},
"type" : "branch",
"create_date" : "2025-09-29T01:39:06.000+00:00",
"update_date" : "2025-09-29T01:39:06.000+00:00"
} ],
"total" : "success"
} SDK Sample Code
The SDK sample code is as follows.
Java
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 | package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.projectman.v4.region.ProjectManRegion; import com.huaweicloud.sdk.projectman.v4.*; import com.huaweicloud.sdk.projectman.v4.model.*; public class ListIssueAssociatedCommitsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); ProjectManClient client = ProjectManClient.newBuilder() .withCredential(auth) .withRegion(ProjectManRegion.valueOf("<YOUR REGION>")) .build(); ListIssueAssociatedCommitsRequest request = new ListIssueAssociatedCommitsRequest(); request.withProjectId("{project_id}"); request.withIssueId({issue_id}); try { ListIssueAssociatedCommitsResponse response = client.listIssueAssociatedCommits(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkprojectman.v4.region.projectman_region import ProjectManRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkprojectman.v4 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = ProjectManClient.new_builder() \ .with_credentials(credentials) \ .with_region(ProjectManRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListIssueAssociatedCommitsRequest() request.project_id = "{project_id}" request.issue_id = {issue_id} response = client.list_issue_associated_commits(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" projectman "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := projectman.ProjectManClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := projectman.NewProjectManClient(hcClient) request := &model.ListIssueAssociatedCommitsRequest{} request.ProjectId = "{project_id}" request.IssueId = int32({issue_id}) response, err := client.ListIssueAssociatedCommits(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
| Status Code | Description |
|---|---|
| 200 | Response to the request for querying the code commit or branch creation records associated with current work item. |
| 400 | Bad Request |
| 401 | Unauthorized |
Error Codes
See Error Codes.
What is your overall rating for this page?
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.
For any further questions, feel free to contact us through the chatbot.
Chatbot