跳转到内容

Group(组合)

Group 是组合、团体、小队或乐队资源。

Group 与 Project 的成员关系由 ProjectGroup 表达,不写在 Group 主记录的单值字段上。

主属性描述 Group 自身。Core API 只返回数据库字段,不返回 logo 或其他媒体对象。

FieldTypesupportedDescription
idstringkey 生成的稳定公开 ID;客户端应视为 opaque。
keystring全局唯一稳定 key,用于过滤和跨域引用。
namestring规范名称。
imageColorstring组合印象色,使用 #RRGGBB

公开 OpenAPI 规范是路由契约的事实来源。

MethodPath说明
GET/api/v1/groups获取 Group 列表。
GET/api/v1/groups/{key}key 获取单个 Group。

列表路由支持 cursor 分页:

QueryType说明
limitnumber每页数量;默认 100,最大 500
cursoropaque string上一页响应 meta.nextCursor 返回的 opaque cursor。

列表响应包含 meta.limitmeta.cursormeta.nextCursormeta.hasMore

{
"id": "group_mygo",
"key": "mygo",
"name": "MyGO!!!!!",
"imageColor": "#3388BB"
}
{
"data": [
{
"id": "group_mygo",
"key": "mygo",
"name": "MyGO!!!!!",
"imageColor": "#3388BB"
}
],
"meta": {
"limit": 100,
"cursor": "",
"nextCursor": "",
"hasMore": false
}
}