更新issue关联的看板字段¶

PUT /api/v5/repos/{owner}/{repo}/issues/{number}/kanban_values

该接口用于更新指定 issue 关联的看板字段，通过指定看板标识（kanban_id）并提交字段名称及对应的字段值列表，可批量修改该 issue 在看板中的字段取值，完成后返回更新后的看板名称、描述及字段值详情。

访问令牌支持说明¶

AtomGit 用户访问令牌（AtomGit user access tokens）

是否允许匿名访问¶

此接口不允许匿名访问

请求参数¶

参数名	位置	类型	必填	说明
`owner`	path	string	是	仓库所属空间地址（组织或个人的地址 path）
`repo`	path	string	是	仓库路径（path）
`number`	path	string	是	issue 编号
`access_token`	query	string	是	用户授权码

Request Body:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "kanban_id": {
      "description": "看板 id",
      "type": "integer"
    },
    "field_values": {
      "description": "看板字段值列表",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field_name": {
            "description": "字段名称",
            "type": "string"
          },
          "value": {
            "description": "字段值，如果是选项类型，填入选项的值",
            "type": "string"
          }
        }
      }
    }
  },
  "required": ["kanban_id", "field_values"]
}

响应参数¶

字段	类型	必返	可为空	说明
`kanban_id`	integer	是	—	看板 id
`name`	string	是	—	看板名称
`description`	string	是	—	看板描述
`values`	array	是	—	看板字段值列表

values 数组元素对象

字段	类型	必返	可为空	说明
`values[].field_name`	string	是	—	字段名称
`values[].field_type`	string	是	—	字段类型
`values[].value`	object	是	—	字段值

`values[].value` 对象¶

字段	类型	必返	可为空	说明
`values[].value.color`	string	是	—	颜色
`values[].value.value`	string	是	—	值
`values[].value.position`	integer	是	—	位置
`values[].value.description`	string	否	—	描述

失败响应¶

400 参数错误

{
  "error": "invalid_request",
  "message": "参数 kanban_id 不能为空",
  "field": "kanban_id"
}

401 未认证

{
  "error": "unauthorized",
  "message": "缺少或无效的访问令牌"
}

Note: 以上失败响应示例中的错误字段名以后端实际返回为准，字段名可能略有差异。

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`400`	参数错误（Bad Request）
`401`	需要认证（Requires authentication）
`403`	禁止访问（Forbidden）
`404`	资源不存在（Not Found）
`500`	系统内部错误（Internal Server Error）

请求示例¶

参数说明¶

<owner> 替换为仓库所属空间地址（组织或个人的地址 path）；<repo> 替换为仓库路径；<number> 替换为 issue 编号；<token> 替换为你的 AtomGit 用户访问令牌。

cURL¶

curl -X PUT 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/issues/<number>/kanban_values?access_token=<token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
    "kanban_id": 1,
    "field_values": [
      {
        "field_name": "priority",
        "value": "high"
      }
    ]
  }'

JavaScript¶

// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch(
  "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/issues/<number>/kanban_values?access_token=<token>",
  {
    method: "PUT",
    headers: {
      "Accept": "application/json",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      kanban_id: 1,
      field_values: [{ field_name: "priority", value: "high" }],
    }),
  }
);

if (!response.ok) {
  throw new Error(`请求失败: ${response.status}`);
}

const data = await response.json();
console.log(data);

Python¶

import requests

resp = requests.put(
    "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/issues/<number>/kanban_values",
    params={"access_token": "<token>"},
    json={
        "kanban_id": 1,
        "field_values": [{"field_name": "priority", "value": "high"}],
    },
    headers={"Accept": "application/json"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

{
  "kanban_id": 0,
  "name": "string",
  "description": "string",
  "values": [
    {
      "field_name": "string",
      "field_type": "string",
      "value": {
        "color": "string",
        "value": "string",
        "position": 0,
        "description": "string"
      }
    }
  ]
}

错误码¶

错误码	说明
`400`	参数错误或请求无法解析
`401`	未认证或凭证无效（缺少/无效的访问凭证）
`404`	请求路径不存在
`405`	请求方法不支持
`429`	请求过于频繁，触发限流
`500`	系统内部错误

本页原文 Markdown：在 AtomGit 查看·内容源自开源项目 gitcode-dev/atomgit-api-doc