修改看板状态¶

PUT /api/v5/org/{owner}/kanban/{kanban_id}/state

该接口用于修改指定组织下看板的状态，可将看板设置为开启（open）或关闭（closed）。通过组织路径与看板 ID 定位目标看板，并在请求体中指定所需的状态值。

访问令牌支持说明¶

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

是否允许匿名访问¶

此接口允许匿名访问

请求参数¶

参数名	位置	类型	必填	说明
`owner`	path	string	是	组织的路径
`kanban_id`	path	integer	是	看板 id

Request Body:

请求体为 JSON 对象，指定要设置的看板状态。

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "state": {
      "description": "看板状态，关闭：closed；开启：open",
      "type": "string",
      "enum": ["closed", "open"]
    }
  },
  "required": ["state"]
}

响应参数¶

该接口成功时返回 200，无响应体内容。

失败响应¶

只有成功响应是不够的：调用方需要知道失败长什么样才能写错误处理。

400 参数错误

当 state 既不是 closed 也不是 open 时返回：

{
  "errorCode": 400,
  "errorCodeName": "BAD_REQUEST",
  "errorMessage": "The value of the state must be either 'closed' or 'open'",
  "traceId": ""
}

404 未找到

当组织不存在时返回：

{
  "errorCode": 404,
  "errorCodeName": "NOT_FOUND",
  "errorMessage": "Not Found",
  "traceId": ""
}

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`400`	参数错误（Bad Request）
`401`	需要认证（Requires authentication）
`403`	禁止访问（Forbidden）
`404`	未找到（Not Found）

请求示例¶

参数说明¶

示例必须与本文档其余部分自洽，照抄即可调用成功：

<owner> 替换为组织路径（企业、组织或个人的地址 path）；<kanban_id> 替换为看板 id；如携带令牌，<token> 替换为你的 AtomGit 用户访问令牌。

本接口允许匿名访问，可不携带令牌；携带时在 URL 上追加 ?access_token=<token>。

cURL¶

curl -X PUT 'https://api.atomgit.com/api/v5/org/<owner>/kanban/<kanban_id>/state' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{"state": "open"}'

携带访问令牌时：

curl -X PUT 'https://api.atomgit.com/api/v5/org/<owner>/kanban/<kanban_id>/state?access_token=<token>' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{"state": "open"}'

JavaScript¶

// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch("https://api.atomgit.com/api/v5/org/<owner>/kanban/<kanban_id>/state", {
  method: "PUT",
  headers: {
    "Content-Type": "application/json",
    "Accept": "application/json",
  },
  body: JSON.stringify({ state: "open" }),
});

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

Python¶

import requests

resp = requests.put(
    "https://api.atomgit.com/api/v5/org/<owner>/kanban/<kanban_id>/state",
    json={"state": "open"},
    headers={"Accept": "application/json"},
    timeout=10,
)
resp.raise_for_status()

响应示例¶

状态码： 200

该接口修改成功后不返回响应体。

错误码¶

错误码	说明
`400`	参数错误或请求无法解析（如 `state` 取值非法）
`401`	未认证或凭证无效（缺少/无效的访问凭证）
`403`	禁止访问
`404`	请求路径不存在或目标看板/组织不存在
`429`	请求过于频繁，触发限流
`500`	系统内部错误

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