文档首页/ 需求管理 CodeArts Req/ API参考/ API/ Scrum项目的工作项/ 查询卡片模式缓存
更新时间：2025-09-11 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询卡片模式缓存

功能介绍

查询卡片模式缓存。

调用方法

请参见如何调用API。

URI

GET /v3/projects/{project_id}/jobcache/board

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目的32位uuid，项目唯一标识，通过查询项目列表接口获取，响应消息体中的project_id字段的值就是项目ID。

约束限制：

32位的数字和字母组成的字符串。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

必传。

取值范围：

最小长度：10，最大长度：32768。

默认取值：

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

result

result object

参数解释：

返回结果。

status

String

参数解释：

返回状态。

取值范围：

success：返回成功。

error：返回失败。
表4 result

参数

参数类型

描述

fields

Array of fields objects

参数解释：

卡片字段的缓存数据。

id

Integer

参数解释：

缓存主键id。

取值范围：

不涉及。
表5 fields

参数

参数类型

描述

id

String

参数解释：

字段id。

取值范围：

不涉及。

header

String

参数解释：

字段名称。

取值范围：

不涉及。

type

String

参数解释：

字段的内容格式（示例：number、text等）。

取值范围：

不涉及。

show

String

参数解释：

字段是否展示。

取值范围：

true：展示。

false：不展示。

请求示例

GET http://{endpoint}/v3/projects/c15cc54e338d4506afd9bd8103071ff0/jobcache/board?type=board&region=xxxxxx

响应示例

状态码：200

查询卡片模式缓存接口成功的响应。

{
  "result" : {
    "id" : 1111,
    "fields" : [ {
      "id" : "id",
      "header" : "编号",
      "type" : "number",
      "show" : true
    }, {
      "id" : "subject",
      "header" : "标题",
      "type" : "text",
      "show" : true
    } ]
  },
  "status" : "success"
}

状态码

状态码

描述

200

查询卡片模式缓存接口成功的响应。

错误码

请参见错误码。

相关文档