Help Center/ CodeArts Repo/ API Reference/ APIs/ Repository/ Obtaining Warehouse Combination Request Details

Updated on 2023-05-06 GMT+08:00

View PDF

Obtaining Warehouse Combination Request Details

Function

URI

GET /v2/repositories/{repository_id}/merge_request/{merge_request_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
repository_id	Yes	Integer	Warehouse Short ID
merge_request_id	Yes	Integer	Combination request ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies a user token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
error	Error object	Response error.
result	MergeInfoResult object	Result
status	String	Status code in a response

**Table 4** Error
Parameter	Type	Description
code	String	Error Codes
message	String	Error message

**Table 5** MergeInfoResult
Parameter	Type	Description
approval_merge_request_approvers	Array of ApprovalMergeRequestApproversItem objects	Reviewer
author	Author object	Author
closed_at	String	Closing time
created_at	String	Creation Time
description	String	Combination Request Description
devcloud_source_branch	String	Source Branch
id	Double	Combination request ID.
iid	Double	Sequence number of a combination request in the current warehouse.
is_source_branch_exist	Boolean	Whether the source branch exists
merge_request_assignee_list	Array of MergeRequestAssigneeListItem objects	Reviewer
merge_request_diff	MergeRequestDiff object	Combining Differences
merge_status	String	Can Be Merged?
source_branch	String	Source Branch
state	String	Combination Request Status
target_branch	String	Target Branch
title	String	Title
updated_at	String	Update time.

**Table 6** ApprovalMergeRequestApproversItem
Parameter	Type	Description
id	Double	User ID
name	String	User Name
nick_name	String	Nickname of the user.
state	String	Status
username	String	User iamId

**Table 7** Author
Parameter	Type	Description
id	Double	User ID.
name	String	User Name
state	String	Status
username	String	User iamId

**Table 8** MergeRequestAssigneeListItem
Parameter	Type	Description
id	Double	User ID.
name	String	User Name
state	String	Status
username	String	User iamId

**Table 9** MergeRequestDiff
Parameter	Type	Description
base_commit_sha	String	Submitting a Base
commits_count	Double	Number of Submitted SMs
created_at	String	Created
head_commit_sha	String	Submitting the head
merge_request_id	Double	Combination request ID.
start_commit_sha	String	Start Submission
updated_at	String	Update time.

Example Requests

GET https://{endpoint}/v2/repositories/907199/merge_request/9011

Example Responses

Status code: 200

{
  "result" : {
    "iid" : 1,
    "approval_merge_request_approvers" : [ {
      "nick_name" : "emily",
      "name" : "emily",
      "id" : 7513,
      "state" : "optional",
      "username" : "0c1de3e61c80d56b1f7dc01164788784"
    }, {
      "nick_name" : "lmptest02",
      "name" : "lmptest02",
      "id" : 7745,
      "state" : "optional",
      "username" : "2ef8c2c835424e988ff33a8339ee1cb4"
    } ],
    "description" : "merge \"branch123\" into \"master\"\nCreate the dsadsad11 file.",
    "created_at" : "2021-12-08T16:34:49.000+08:00",
    "title" : "tesafrds.",
    "source_branch" : "branch123",
    "updated_at" : "2021-12-09T11:21:02.000+08:00",
    "id" : 6670,
    "state" : "opened",
    "closed_at" : "2021-12-08T16:34:50.000+08:00",
    "author" : {
      "name" : "repo",
      "id" : 6879,
      "state" : "active",
      "username" : "e0c068bf68c44bfab87b763ff85da277"
    },
    "is_source_branch_exist" : true,
    "target_branch" : "master",
    "merge_status" : "unchecked",
    "merge_request_diff" : {
      "merge_request_id" : 6670,
      "head_commit_sha" : "715fc146292edc31a588fbc74349a2b8d18dbc27",
      "updated_at" : "2021-12-09T11:20:58.000+08:00",
      "start_commit_sha" : "02f0482056d3b949699eb69683914466c84529af",
      "created_at" : "2021-12-09T11:20:58.000+08:00",
      "base_commit_sha" : "6e90282f6334433a9fe3be809a7c1eed1afbf10b",
      "commits_count" : 2
    },
    "devcloud_source_branch" : "branch123",
    "merge_request_assignee_list" : [ {
      "name" : "Flying snow in June",
      "id" : 6743,
      "state" : "active",
      "username" : "a618e34bd5704be3ae3395dfede06041"
    }, {
      "name" : "General administrator account",
      "id" : 6747,
      "state" : "active",
      "username" : "42dd0277cfb048dea856e4ee352e937d"
    } ]
  },
  "status" : "success"
}