Obtaining MR Details of a Repository

Description

This API is used to obtain MR details of a repository.

URI

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

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
repository_id	Yes	Integer	Repository short ID
merge_request_id	Yes	Integer	MR ID

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. 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	Response result
status	String	Response status

**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	Approver
author	Author object	Author
closed_at	String	Close time
created_at	String	Creation time
description	String	MR description
devcloud_source_branch	String	Source branch
id	Double	MR ID
iid	Double	Sequence number of an MR in the current repository
is_source_branch_exist	Boolean	Whether the source branch exists
merge_request_assignee_list	Array of MergeRequestAssigneeListItem objects	Merger
merge_request_diff	MergeRequestDiff object	Merge differences
merge_status	String	Whether it can be merged
source_branch	String	Source branch
state	String	MR status
target_branch	String	Target branch
title	String	Title
updated_at	String	Update time
merged_at	String	Merging time
merged_by	MergedByUser object	Merger
merge_request_related_work_items	Array of MergeRequestRelatedWorkItem objects	Associated work items

**Table 6** ApprovalMergeRequestApproversItem
Parameter	Type	Description
id	Double	User ID
name	String	Username
nick_name	String	Alias
state	String	User status
username	String	IAM user ID

**Table 7** Author
Parameter	Type	Description
id	Double	User ID
name	String	Username
state	String	User status
username	String	IAM user ID
avatar_url	String	Avatar URL
web_url	String	web url

**Table 8** MergeRequestAssigneeListItem
Parameter	Type	Description
id	Double	User ID
name	String	Username
state	String	User status
username	String	IAM user ID

**Table 9** MergeRequestDiff
Parameter	Type	Description
id	Double	MR difference ID
state	String	MR status
merge_request_id	Double	MR ID
created_at	String	Creation time
updated_at	String	Update time
base_commit_sha	String	Base commit
real_size	Double	Actual size
head_commit_sha	String	Head commit
start_commit_sha	String	Start commit
commits_count	Double	Number of commits
external_diff	String	External differences
external_diff_store	Double	External storage differences
stored_externally	Boolean	Whether external storage exists
added_lines	Double	Added lines
removed_lines	Double	Deleted lines

**Table 10** MergedByUser
Parameter	Type	Description
id	Double	User ID
name	String	Username
state	String	User status
username	String	IAM user ID
avatar_url	String	Avatar URL
web_url	String	Homepage URL

**Table 11** MergeRequestRelatedWorkItem
Parameter	Type	Description
id	Double	id
user_id	String	User ID
repo_id	Double	Repository ID
merge_request_id	Double	MR ID
target_branch	String	Target branch
source_branch	String	Source branch
merge_request_title	String	MR title
merge_request_url	String	MR URL
merge_request_state	String	MR status
related_id	String	Associated work item ID
related_title	String	Associated work item title
related_url	String	Associated work item URL
result	Double	Query result
create_at	String	Creation time
update_at	String	Update time

Request Examples

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

Response Examples

Status code: 200

Request succeeded

{
  "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"
    } ],
    "merged_at" : "2023-08-14T20:51:51.000+08:00",
    "merged_by" : {
      "id" : "9124,",
      "name" : "CodeHub_beta_dev",
      "username" : "c369c68f1ff84679b5a8ed904d8bff1c",
      "state" : "active",
      "avatar_url" : "",
      "web_url" : "https://devcloud.test.com/c369c68f1ff84679b5a8ed904d8bff1c"
    },
    "merge_request_related_work_items" : [ {
      "id" : 7343,
      "user_id" : "9124",
      "repo_id" : 2111746921,
      "merge_request_id" : 20637,
      "target_branch" : "master",
      "source_branch" : "test123",
      "merge_request_url" : "https://devcloud.test.com/codehub/2111746921/18/mergedetail?source=test123&target=master",
      "merge_request_state" : "opened",
      "related_id" : "6437435",
      "related_title" : "msm-0115-1000",
      "related_url" : "https://devcloud.test.com/projectman/scrum/e76c13e86364438d9183ca2f395371e1/task/detail/6437435",
      "result" : 1,
      "create_at" : "2023-09-18T20:29:59.000+08:00",
      "update_at" : "2023-09-18T20:29:59.000+08:00"
    } ]
  },
  "status" : "success"
}