文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 用例关联关系管理/ 查询需求更新提醒功能开关
更新时间：2024-11-19 GMT+08:00
查看PDF
分享

查询需求更新提醒功能开关

功能介绍

查询需求更新提醒功能开关

URI

GET /v4/projects/{project_id}/issue-update-notification

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目id，对应"需求管理 CodeArts Req"项目唯一标识，测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值

约束限制:

不涉及

取值范围:

项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字

默认取值:

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

owner_id

是

String

用户id

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

status

String

success|error;

result

ResultValueDisplayIssueDynamicVo object

请求的返回的数据对象

error

ApiError object

失败时的error信息

request_id

String

由接口调用方传入，建议使用UUID保证请求的唯一性。

server_address

String

本次请求的受理的服务地址
表5 ResultValueDisplayIssueDynamicVo

参数

参数类型

描述

total

Integer

起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值

value

DisplayIssueDynamicVo object

实际的数据类型：单个对象，集合 或 NULL

reason

String

业务失败的提示内容

page_size

Integer

每页展示条数

page_no

Integer

页码

has_more

Boolean

是否有更多
表6 DisplayIssueDynamicVo

参数

参数类型

描述

is_display_issue_dynamic

String

需求更新自定开关
表7 ApiError

参数

参数类型

描述

code

String

业务失败的错误码

reason

String

业务失败的提示内容

状态码： 400

表8 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码： 401

表9 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码： 404

表10 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码： 500

表11 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

请求示例

查询需求更新提醒功能开关

get https://{endpoint}/v4/projects/300c6295a54c4c698608c878f47ddd59/issue-update-notification?owner_id=e8d27b5521a64fb28a8fd9c99cd66eb3

响应示例

状态码： 200

OK

{
  "status" : "success",
  "result" : {
    "value" : {
      "is_display_issue_dynamic" : "1"
    }
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

相关文档