全部产品

查询合并请求列表

该接口用于查询合并请求列表

请求方式GET/api/v4/merge_requests/advanced_search

请求Action:ListMergeRequests

请求参数:

参数名

类型

说明

是否必须

默认值

Page

long

页数,最小值为1

1

PageSize

long

每页条数,范围[1, 100]

20

GroupIdList

string

代码组ID列表,用于查询指定组下的合并请求;多个组ID用逗号分隔。

示例:组ID为123及456,传参为 123,456

ProjectIdList

string

代码库ID列表,用于查询指定库下的合并请求;多个库ID用逗号分隔。

示例:库ID为123及456,传参为 123,456

AuthorCodeupIdList

string

创建用户ID列表,用于查询指定用户创建的合并请求;多个用户ID用逗号分隔。

示例:用户ID为123及456,传参为 123,456

AuthorIdList

string

创建用户云效ID列表,用于查询指定用户创建的合并请求;多个用户ID用逗号分隔。

示例:用户ID为5e71882123123833284f6ff3及5e71882321321833284f6ff3,传参为 5e71882123123833284f6ff3,5e71882321321833284f6ff3

AssigneeCodeupIdList

string

评审人用户ID列表,用于查询指定用户评审的合并请求;多个用户ID用逗号分隔。

示例:用户ID为123及456,传参为 123,456

AssigneeIdList

string

评审人用户云效ID列表,用于查询指定用户评审的合并请求;多个用户ID用逗号分隔。

示例:用户ID为5e71882123123833284f6ff3及5e71882321321833284f6ff3,传参为 5e71882123123833284f6ff3,5e71882321321833284f6ff3

State

string

合并请求状态,用于查询指定状态的合并请求。

可选值:

  1. opened:已开启的评审
  2. merged:已合并的评审
  3. closed:已关闭的评审
  4. all:所有评审

Search

string

搜索字段,用于搜索标题含有指定搜索字段的合并请求。

Order

string

排序字段,用于指定查询结果排序逻辑。

可选:

  1. created_at:创建时间逆序
  2. updated_at:更新时间逆序

AfterDate

string

开始时间,用于指定查询某个时间后的合并请求,格式按照yyyy-MM-dd。

注:开始时间需要和结束时间同时传入才会生效。

示例:查询2021年1月18日0点后的合并请求,传入参数:2020-01-18

BeforeDate

string

结束时间,用于指定查询某个时间前的合并请求,格式按照yyyy-MM-dd。

注:开始时间需要和结束时间同时传入才会生效。

示例:查询截至2021年1月20日24点的合并请求,传入参数:2020-01-21

返回 body :

{
   "RequestId": "",
   "Success":true,
   "Total": 1,
   "Result": [
  {
   "Id": 1,
   "ProjectId": 1,
   "Title": "string",
   "Description": "string",
   "State": "string",
   "MergeStatus": "string",
   "CreatedAt": "string",
   "UpdatedAt": "string",
   "SourceBranch": "string",
   "TargetBranch": "string",
   "WebUrl": "string",
   "AcceptedRevision": "string",
   "MergeError": "string",
   "MergedRevision": "string",
   "NameWithNamespace": "string",
   "MergeType": "string",
   "AheadCommitCount": 0,
   "BehindCommitCount": 0,
   "AssigneeList": [
    {
     "Id": 1,
     "ExternUserId": "string",
     "AvatarUrl": "string",
     "Name": "string"
     "Status": "string",
     "Email": "string",
    }
   ],
   "Author": {
    "Id": 1,
    "ExternUserId": "string",
    "AvatarUrl": "string",
    "Name": "string"
   },
   "ApproveCheckResult": {
    "TotalCheckResult": "string",
    "SatisfiedCheckResults": [
     "CheckStatus": "string",
     "CheckName": "string",
     "CheckType": "string",
     "ExtraUsers": [
      {
       "Id": 1,
       "ExternUserId": "string",
       "AvatarUrl": "string",
       "Name": "string"
      }
     ],
     "SatisfiedItems": [],
     "UnSatisfiedItems": []
    ],
    "UnsatisfiedCheckResult": []
   }
  }
    ]
}

返回结果说明:

参数名

类型

说明

Id

long

合并请求id

ProjectId

long

代码库id

Title

string

合并请求标题

Description

string

合并请求描述

State

string

合并请求状态,

包括:打开的(opened,reopened)、关闭的(closed)、评审通过(未合并,accepted),评审通过(已合并,merged),合并中(locked)

MergeStatus

string

合并请求合并状态,包括:未检查(unchecked)、可以合并(can_be_merged)、不可以合并(cannot_be_merged)

CreatedAt

string

创建时间

UpdatedAt

string

更新时间

SourceBranch

string

源分支

TargetBranch

string

目标分支

WebUrl

string

Web地址

AcceptedRevision

string

评审通过时的版本

MergeError

string

合并异常信息

MergedRevision

string

合并版本

NameWithNamespace

string

名称(含父路径)

MergeType

string

合并方式

AheadCommitCount

string

源分支领先目标分支的commit数量

BehindCommitCount

string

目标分支领先源分支的commit数量

AssigneeList

Assignee list

评审人列表

Author

struct

创建者

ApproveCheckResult

struct

卡点详情

Assignee 结构:

参数名

类型

说明

Id

long

Codeup 用户id

ExternUserId

string

云效用户id

AvatarUrl

string

用户头像地址

Name

string

用户姓名

Status

string

评审状态。

approved:已经同意

comment:发表过评论

pending:没有进行过review

Email

string

邮箱

Author 结构:

参数名

类型

说明

Id

long

Codeup 用户id

ExternUserId

string

云效用户id

AvatarUrl

string

用户头像地址

Name

string

用户姓名

ApproveCheckResult结构:

参数名

类型

说明

TotalCheckResult

string

总体检查结果:

SATISFIED,UNSATISFIED

SatisfiedCheckResults

list CheckResult

通过的卡点

UnsatisfedCheckResults

list CheckResult

未通过的卡点

CheckResults结构:

参数名

类型

说明

CheckStatus

string

卡点状态:

SATISFIED,UNSATISFIED

CheckName

卡点名称

SatisfiedItems

list string

满足条件的子项

UnsatisfiedItems

list string

不满足条件的子项

CheckType

string

卡点类型

ExtraUsers

list UserBasic

人员信息

UserBasic结构:

参数名

类型

说明

Id

long

Codeup 用户id

ExternUserId

string

云效用户id

AvatarUrl

string

用户头像地址

Name

string

用户姓名