慧企星助 开放平台文档

新增便签。成功时响应 data 返回新建便签 Id（Guid），后续详情、共享、修改等操作应使用该 Id。

{
  "name": "开放平台便签",
  "content": "便签内容",
  "parentId": "便签包或便签夹 Guid，可选",
  "priority": 3,
  "type": 1,
  "score": 0,
  "dueAt": "2026-08-22T17:32:50+08:00",
  "assigneeVirtualIds": ["负责人 virtualId"],
  "checkerVirtualId": "审核人 virtualId",
  "ccVirtualIds": [],
  "labelIds": [],
  "attachmentUrls": []
}

获取当前员工可见便签列表。统一使用 page、pageSize 和 keyword 分页筛选；可选 startAt、endAt、group、noteType。

列表响应字段

Note 通用字段

GET /api/openplatform/notes、/notes/search、/notes/shares、/notePackages/{id}/notes 的 items 单项，以及 GET /api/openplatform/notes/{id} 的详情，均使用以下公开资源字段。

获取便签详情。另有 /search、/shares、/records、/{id}/shareRecord 查询接口。

响应字段：返回一个完整 Note 对象，字段、类型和含义见上方“Note 通用字段”。

便签写操作的 action：delete、star、share、cancelShare、editPermission、lock、unlock、toPackage、singleEdit、send、setTop、uploadAttachment。所有写操作均使用当前动作资源路径。

路径中的 {id} 为便签 Id。除下表标明的参数外，动作请求体传空对象 {}。员工参数必须使用当前 API Key 下的 virtualId，不能传真实员工 Guid。

singleEdit 的 noteType 参数

全量替换便签标签：以请求中的标签 Id 集合为最终状态，需要新增与移除的标签由平台自动补差完成，与工作台标签维护同链路（操作人需有便签权限）。同步处理，返回成功即已生效。

请求示例：

PUT /api/openplatform/notes/a1b2c3d4-e5f6-7890-abcd-ef1234567890/labels
Content-Type: application/json
X-Employee-Virtual-Id: emp_T7dQ2mYk8rLp4cN1sVx3bH9wAe6fJuKz

{
  "labelIds": [
    "2f6e8a10-3c4b-4d5e-9f80-a1b2c3d4e5f6"
  ]
}

新增便签包，请求字段为 name、content、sharedEmployeeVirtualIds。成功时响应 data 返回新建便签包 Id（Guid）。便签夹使用 POST /api/openplatform/notePackages/folders，字段为 parentId、name、folderType，成功时同样返回新建便签夹 Id。

获取便签包列表。其他查询包括 /{id}、/{id}/notes、/search、/tree、/tree/all、/{id}/shareRecord；/tree 的 parentId 可省略，省略时返回根节点。

列表和详情响应字段

便签包或便签夹 action：delete、deleteFolder、edit、editFolder、singleEdit、star、share、cancelShare、editPermission、toPackage、toNote、toPlan、move。

路径中的 {id} 为便签包或便签夹 Id。除下表标明的参数外，动作请求体传空对象 {}。员工参数必须使用当前 API Key 下的 virtualId。