获取代码组下E2E设置信息
功能介绍
获取代码组下E2E设置信息
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v4/groups/{group_id}/e2e-setting
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
group_id |
是 |
Integer |
参数解释: 代码组id,代码组首页,Group ID后的数字Id 取值范围: 1-2147483647 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
e2e_policies |
E2ePolicyDto object |
参数解释: E2E公共设置信息。 |
req |
ReqSettingDto object |
参数解释: 可集成系统CodeArts Req设置信息。 |
link |
LinkSettingDto object |
参数解释: 可集成系统Link服务设置信息。 |
参数 |
参数类型 |
描述 |
---|---|---|
auto_extract |
Boolean |
参数解释: 是否开启单号自动提取。 取值范围: true:开启单号自动提取,false:未开启单号自动提取。 |
prefix_symbol |
String |
参数解释: 自动提取时的单号前缀合集,英文逗号分隔。 取值范围: 单个前缀长度最多200个字符,最多允许配置10个前缀。 |
separator |
String |
参数解释: 自动提取时的分隔符。 |
suffix_symbol |
String |
参数解释: 自动提取时的单号后缀。 |
参数 |
参数类型 |
描述 |
---|---|---|
active |
Boolean |
参数解释: 是否开启集成CodeArts Req 取值范围: true:开启集成CodeArts Req,false:未开启集成CodeArts Req。 |
branches |
String |
参数解释: 应用排除状态和可关联类别限制的分支列表,该分支指代合并请求的目标分支,可支持多个分支用英文逗号拼接或者正则表达式,在项目层级和代码组层级只支持配置正则表达式。 |
branches_type |
String |
参数解释: 分支的类型,文本或者正则表达式。 取值范围: plain代表文本,regex代表正则表达式。 枚举值:
|
project_type |
String |
参数解释: 关联的CodeArts Req项目类型。 取值范围: scrum代表scrum类型项目,ipd代表IPD类型项目, xboard为看板类型项目。 枚举值:
|
categories |
String |
参数解释: 可关联类型列表,逗号分隔。 |
category_codes |
String |
参数解释: 可关联类型编码列表,逗号分隔。 |
exclude_statuses |
String |
参数解释: 排除状态列表,逗号分隔。 |
exclude_status_codes |
String |
参数解释: 排除状态编码列表,逗号分隔。 |
参数 |
参数类型 |
描述 |
---|---|---|
active |
Boolean |
参数解释: 是否开启集成Link服务 取值范围: true:开启集成Link服务,false:未开启集成Link服务。 |
url |
String |
参数解释: Link服务的对接地址。 |
app_auth_type |
String |
参数解释: Link服务的对接鉴权类型,ak_sk代表使用ak和sk来鉴权。 枚举值:
|
app_ak |
String |
参数解释: Link服务的对接鉴权ak。 |
app_sk |
String |
参数解释: Link服务的对接鉴权sk,作为返回值时若已配置则返回掩码,掩码格式为************。 |
categories |
String |
参数解释: 可关联类型列表,逗号分隔。 |
exclude_statuses |
String |
参数解释: 排除状态列表,逗号分隔。 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
请求示例
GET https://{endpoint}/v4/groups/1/e2e-setting
响应示例
状态码:200
OK
{ "e2e_policies" : { "auto_extract" : true, "prefix_symbol" : "TicketNo", "separator" : ";", "suffix_symbol" : "\\\\n" }, "req" : { "active" : true, "branches" : "dev", "branches_type" : "plain", "categories" : "Epic,Story", "category_codes" : "5,7", "exclude_statuses" : "新建,已解决", "exclude_status_codes" : "1,3", "project_type" : "scrum" }, "link" : { "active" : true, "url" : "https://demo.com", "app_auth_type" : "ak_sk", "app_ak" : "testak", "app_sk" : "************", "categories" : "IR", "exclude_statuses" : "新建" } }
状态码:401
Unauthorized
{ "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" }
状态码:403
Bad Request
{ "error_code" : "CH.004403", "error_msg" : "您没有操作权限,请升级权限后重试。" }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
401 |
Unauthorized |
403 |
Bad Request |
错误码
请参见错误码。