获取企业里程碑可以关联的项目列表¶
GET /api/v8/enterprises/{enterprise}/groups/projects
用户调用此接口,获取企业里程碑可以关联的项目列表。
访问令牌支持说明¶
- AtomGit 用户访问令牌(AtomGit user access tokens)
是否允许匿名访问¶
此接口不允许匿名访问
请求参数¶
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
enterprise |
path | string | 是 | 企业id |
access_token |
query | string | 是 | 用户授权码 |
group_name |
query | string | 否 | 组织名称 |
响应参数¶
响应体为 JSON 数组,数组中的每个元素是一个项目对象:
project 对象(数组元素)
| 字段 | 类型 | 必返 | 可为空 | 说明 |
|---|---|---|---|---|
id |
integer | 是 | 否 | id |
full_name |
string | 是 | 否 | 包含 namespace 的路径 |
human_name |
string | 是 | 否 | 包含 namespace 的名称 |
path |
string | 是 | 否 | 项目路径 |
name |
string | 是 | 否 | 项目名称 |
created_at |
string | 是 | 否 | 创建时间 |
updated_at |
string | 是 | 否 | 更新时间 |
失败响应¶
400 参数错误
401 未认证
403 禁止访问
HTTP 响应状态码¶
| 状态码 | 说明 |
|---|---|
200 |
成功(OK) |
304 |
未修改(Not modified) |
401 |
需要认证(Requires authentication) |
403 |
禁止访问(Forbidden) |
请求示例¶
参数说明¶
<enterprise>替换为企业 id;<token>替换为你的 AtomGit 用户访问令牌;<group_name>替换为组织名称(可选)。
cURL¶
curl -X GET 'https://api.atomgit.com/api/v8/enterprises/<enterprise>/groups/projects?access_token=<token>' \
-H 'Accept: application/json'
JavaScript¶
// 原生 fetch (Node.js 18+ / 浏览器)
const enterprise = "<enterprise>";
const token = "<token>";
const url = `https://api.atomgit.com/api/v8/enterprises/${enterprise}/groups/projects?access_token=${token}`;
const response = await fetch(url, {
headers: {
"Accept": "application/json",
},
});
if (!response.ok) {
throw new Error(`请求失败: ${response.status}`);
}
const data = await response.json();
console.log(data);
Python¶
import requests
enterprise = "<enterprise>"
token = "<token>"
resp = requests.get(
f"https://api.atomgit.com/api/v8/enterprises/{enterprise}/groups/projects",
params={"access_token": token},
headers={"Accept": "application/json"},
timeout=10,
)
resp.raise_for_status()
print(resp.json())
响应示例¶
状态码: 200
[
{
"id": 1,
"full_name": "org/repo",
"human_name": "组织/仓库",
"path": "repo",
"name": "repo",
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-02T00:00:00Z"
}
]
错误码¶
| 错误码 | 说明 |
|---|---|
401 |
未认证或凭证无效(缺少/无效的访问凭证) |
400 |
参数错误或请求无法解析 |
404 |
请求路径不存在 |
405 |
请求方法不支持 |
429 |
请求过于频繁,触发限流 |
500 |
系统内部错误 |
本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 gitcode-dev/atomgit-api-doc