标签接口
标签接口会按当前访问员工身份返回可见标签列表,因此必须传 X-Employee-Virtual-Id。
GET
/api/openplatform/labels
获取当前企业可用标签列表。
必填请求头:必须提供
X-Employee-Virtual-Id。未传时返回 403。{
"statusCode": 100,
"msg": "获取成功",
"data": {
"total": 2,
"page": 1,
"pageSize": 20,
"items": [
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "紧急",
"color": "#ff4d4f",
"groupName": "优先级"
},
{
"id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"name": "我的标签",
"color": "#1890ff",
"groupName": null
}
]
}
}响应字段
| 字段 | 类型 | 说明 |
|---|---|---|
data.total | long | 当前员工可见标签总数。 |
data.page | int | 当前页码,从 1 开始。 |
data.pageSize | int | 当前页返回条数上限,范围为 1 到 100。 |
data.items | Label[] | 当前页标签数据。 |
id | guid | 标签标识,可用于任务、便签等资源关联。 |
name | string | 标签名称。 |
color | string | 标签颜色值,例如 #ff4d4f。 |
groupName | string | null | 标签所属分组名称;个人标签为 null。 |
POST
/api/openplatform/labels
新增标签。团队标签(type=team)需要操作人具备企业标签维护权限且必须指定分组;个人标签(type=personal)仅操作人本人可见。
必填请求头:必须提供
X-Employee-Virtual-Id。未传时返回 403。写操作需 labels.write 权限。| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
name | string | 是 | 标签名称,同企业内不允许重名。 |
type | string | 否 | 标签类型(字符串枚举):team 团队标签(默认)、personal 个人标签。 |
groupId | guid | 否 | 标签分组 Id;type=team 时必填。 |
color | string | 否 | 标签颜色,如 #ff4d4f;团队标签取分组色、个人标签有默认色。 |
remark | string | 否 | 备注。 |
请求示例:
{
"name": "慧企星助AI助理",
"type": "team",
"groupId": "0c4e5a71-6f5e-4c22-9e2b-3d1a0f8b7c01"
}响应示例:
{
"statusCode": 100,
"msg": "保存成功!",
"data": { "id": "2f6e8a10-3c4b-4d5e-9f80-a1b2c3d4e5f6" }
}
PATCH
/api/openplatform/labels/{id}
修改标签名称与颜色。
必填请求头:必须提供
X-Employee-Virtual-Id。写操作需 labels.write 权限。| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
name | string | 是 | 标签名称。 |
color | string | 否 | 标签颜色。 |
DELETE
/api/openplatform/labels/{id}
删除标签。标签已被任务、便签等业务使用时是否允许删除由平台业务校验返回结果。写操作需 labels.write 权限,并需提供 X-Employee-Virtual-Id。