获取 issue 扩展配置¶

GET /api/v5/orgs/{org}/issue/extend/settings

该接口用于获取指定组织下 issue 的扩展配置，返回各 issue 类型（如需求、咨询）及其对应的状态配置信息。

访问令牌支持说明¶

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

是否允许匿名访问¶

此接口不允许匿名访问

请求参数¶

参数名	位置	类型	必填	说明
`org`	path	string	是	仓库所属空间地址（企业、组织 path）
`access_token`	query	string	是	用户授权码

响应参数¶

响应体为对象数组，数组的每个元素代表一种 issue 类型及其状态配置。

字段	类型	必返	可为空	说明
`type_name`	string	是	—	类型名称，如 `需求`、`咨询`
`type_id`	integer	是	—	类型 ID
`type_desc`	string	是	—	类型描述
`status`	object[]	是	—	该类型下的状态配置列表

status 对象

字段	类型	必返	可为空	说明
`status.status_name`	string	是	—	状态名称
`status.status_id`	integer	是	—	状态 ID
`status.status_desc`	string	是	—	状态描述
`status.gitcode_issue_status`	integer	是	—	GitCode issue 状态值

失败响应¶

该接口在未认证或访问凭证无效时返回 401。

401 未认证

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

Note: 错误响应字段名以后端实际返回为准。

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`401`	需要认证（Requires authentication）
`404`	请求路径不存在（Not found）
`500`	系统内部错误（Internal server error）

请求示例¶

参数说明¶

<org> 替换为组织路径名（企业或组织的地址 path）； <token> 替换为你的 AtomGit 用户访问令牌。

cURL¶

curl -X GET 'https://api.atomgit.com/api/v5/orgs/<org>/issue/extend/settings?access_token=<token>' \
  -H 'Accept: application/json'

JavaScript¶

// 原生 fetch (Node.js 18+ / 浏览器)
const org = "<org>";
const token = "<token>";

const response = await fetch(
  `https://api.atomgit.com/api/v5/orgs/${org}/issue/extend/settings?access_token=${token}`,
  {
    headers: {
      "Accept": "application/json"
    }
  }
);

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

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

Python¶

import requests

org = "<org>"
token = "<token>"

resp = requests.get(
    f"https://api.atomgit.com/api/v5/orgs/{org}/issue/extend/settings",
    params={"access_token": token},
    headers={"Accept": "application/json"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

[
  {
    "type_name": "需求",
    "type_id": 4,
    "type_desc": "定义和描述产品或项目中需要实现的新功能或改进",
    "status": [
      {
        "status_name": "未提单",
        "status_id": 11,
        "status_desc": "需求尚未正式提交，仍处于概念或讨论阶段，未进入系统管理流程",
        "gitcode_issue_status": 0
      },
      {
        "status_name": "修复中",
        "status_id": 20,
        "status_desc": "需求的解决方案在实施过程中发现问题，正在进行修复工作",
        "gitcode_issue_status": 0
      }
    ]
  },
  {
    "type_name": "咨询",
    "type_id": 36138,
    "type_desc": "",
    "status": [
      {
        "status_name": "未提单",
        "status_id": 11,
        "status_desc": "需求尚未正式提交，仍处于概念或讨论阶段，未进入系统管理流程",
        "gitcode_issue_status": 0
      },
      {
        "status_name": "已完成",
        "status_id": 14,
        "status_desc": "需求的所有相关工作已结束，成果已交付，进入归档状态",
        "gitcode_issue_status": 1
      }
    ]
  }
]

错误码¶

错误码	说明
`401`	未认证或凭证无效（缺少/无效的访问凭证）
`404`	请求路径不存在
`500`	系统内部错误

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