chinaweal-claude-code/skills/chinaweal-quicknote/SKILL.md

---
name: chinaweal-quicknote
description: |
  众望通 PMS 系统速记相关 API 工具。用于管理个人速记、标签和附件。

  当用户提到以下场景时使用此 Skill：
  (1) 速记、新增速记、查询速记、删除速记
  (2) 速记标签管理
  (3) 速记附件上传/下载/删除
  (4) 用户提到 "速记"、"quicknote"、"快记"
version: 1.0.0
license: Apache-2.0
metadata:
  author: lirh
  category: development
  tags:
    - pms
    - chinaweal
    - quicknote
    - notes
---

# ChinaWeal 速记 API

## 概述

此 Skill 用于调用众望通 PMS 系统的速记相关 API，包括速记管理、标签管理和附件管理。

## 认证配置

使用此 Skill 前，需要配置环境变量 `CHINAWEAL_PMS_TOKEN`：

- **环境变量名称**: `CHINAWEAL_PMS_TOKEN`
- **用途**: PMS 系统的用户授权 Token

### 请求鉴权方式

所有 API 请求需要在请求头中携带 Authorization 信息：

```
Authorization: Bearer {CHINAWEAL_PMS_TOKEN}
```

## Base URL

```
https://www.chinaweal.com.cn/pms-api
```

## 功能清单

### 功能1: 新增速记

创建一条新的速记记录。

**接口地址**: `https://www.chinaweal.com.cn/pms-api/api/quicknote/save`

**请求方法**: POST

**请求头**:
```
Authorization: Bearer {CHINAWEAL_PMS_TOKEN}
Content-Type: application/json
```

**请求体 (PmsQuickNote)**:
| 字段 | 类型 | 描述 |
|------|------|------|
| noteContent | string | 速记内容 |
| noteDate | string (date) | 速记日期，格式: yyyy-MM-dd |
| noteTime | string (date-time) | 速记时间 |
| tagNames | array[string] | 标签列表 |
| tagNamesStr | string | 标签名称字符串，用逗号分隔 |

**响应**: `RestResultPmsQuickNote`
- `code` - 状态码
- `msg` - 消息
- `data` - 创建的速记对象

**使用示例**:
```
帮我新增一条速记
创建一条速记，内容是今天完成了xxx
新增速记：完成了项目评审
```

### 功能2: 更新速记

更新已有的速记记录。

**接口地址**: `https://www.chinaweal.com.cn/pms-api/api/quicknote/update`

**请求方法**: POST

**请求头**:
```
Authorization: Bearer {CHINAWEAL_PMS_TOKEN}
Content-Type: application/json
```

**请求体 (PmsQuickNote)**:
| 字段 | 类型 | 描述 |
|------|------|------|
| id | string | 速记ID（必填） |
| noteContent | string | 速记内容 |
| noteDate | string (date) | 速记日期 |
| noteTime | string (date-time) | 速记时间 |
| tagNames | array[string] | 标签列表 |
| tagNamesStr | string | 标签名称字符串，用逗号分隔 |

**响应**: `RestResultPmsQuickNote`

**使用示例**:
```
更新速记 ID 为 xxx 的内容
修改速记：把内容改成xxx
```

### 功能3: 删除速记

删除指定的速记记录。

**接口地址**: `https://www.chinaweal.com.cn/pms-api/api/quicknote/delete`

**请求方法**: POST

**请求头**:
```
Authorization: Bearer {CHINAWEAL_PMS_TOKEN}
```

**查询参数**:
| 参数 | 类型 | 描述 |
|------|------|------|
| id | string | 速记ID（必填） |

**响应**: `RestResultObject`

**使用示例**:
```
删除速记 ID 为 xxx
删除速记
```

### 功能4: 分页查询速记列表

分页查询速记列表，支持按日期、内容、标签筛选。

**接口地址**: `https://www.chinaweal.com.cn/pms-api/api/quicknote/list`

**请求方法**: POST

**请求头**:
```
Authorization: Bearer {CHINAWEAL_PMS_TOKEN}
Content-Type: application/json
```

**请求体 (BaseQueryPmsQuickNoteQueryDTO)**:
| 字段 | 类型 | 描述 |
|------|------|------|
| entity.noteDate | string (date) | 速记日期，格式: yyyy-MM-dd |
| entity.noteContent | string | 速记内容（模糊搜索） |
| entity.tagName | string | 标签名称 |
| current | integer | 当前页 |
| size | integer | 每页显示条数 |
| orderFields | array[string] | 排序字段 |
| orderSorts | array[string] | 排序规则 (asc/desc) |

**响应**: `RestResultIPagePmsQuickNote`
- `data.records` - 速记列表
- `data.total` - 总记录数
- `data.current` - 当前页
- `data.size` - 每页条数

**使用示例**:
```
查询速记列表
查看最近一周的速记
按标签筛选速记
查找包含xxx的速记
```

### 功能5: 查询速记详情

根据速记ID查询详情。

**接口地址**: `https://www.chinaweal.com.cn/pms-api/api/quicknote/detail/{id}`

**请求方法**: GET

**请求头**:
```
Authorization: Bearer {CHINAWEAL_PMS_TOKEN}
```

**路径参数**:
| 参数 | 类型 | 描述 |
|------|------|------|
| id | string | 速记ID（必填） |

**响应**: `RestResultPmsQuickNote`

**使用示例**:
```
查询速记 xxx 的详情
查看速记 ID 为 xxx 的详细信息
```

### 功能6: 获取速记的标签列表

根据速记ID获取该速记的所有标签。

**接口地址**: `https://www.chinaweal.com.cn/pms-api/api/quicknote/tag/{noteId}`

**请求方法**: GET

**请求头**:
```
Authorization: Bearer {CHINAWEAL_PMS_TOKEN}
```

**路径参数**:
| 参数 | 类型 | 描述 |
|------|------|------|
| noteId | string | 速记ID（必填） |

**响应**: `RestResultListString` - 标签列表

**使用示例**:
```
获取速记 xxx 的标签
查看速记的标签列表
```

### 功能7: 获取前10个常用标签

获取当前用户使用最多的前10个标签。

**接口地址**: `https://www.chinaweal.com.cn/pms-api/api/quicknote/tag/list`

**请求方法**: POST

**请求头**:
```
Authorization: Bearer {CHINAWEAL_PMS_TOKEN}
Content-Type: application/json
```

**响应**: `RestResultListString` - 标签列表

**使用示例**:
```
获取我常用的标签
查看我使用最多的标签
```

### 功能8: 上传速记附件

为速记上传附件。

**接口地址**: `https://www.chinaweal.com.cn/pms-api/api/quicknote/attachment/upload`

**请求方法**: POST

**请求头**:
```
Authorization: Bearer {CHINAWEAL_PMS_TOKEN}
Content-Type: application/json
```

**查询参数**:
| 参数 | 类型 | 描述 |
|------|------|------|
| noteId | string | 速记ID（必填） |

**请求体**:
| 字段 | 类型 | 描述 |
|------|------|------|
| file | string | 上传的文件（base64或binary） |

**响应**: `RestResultPmsQuickNoteAttachment`

**使用示例**:
```
上传附件到速记 xxx
为速记添加附件
```

### 功能9: 获取速记附件列表

获取指定速记的所有附件。

**接口地址**: `https://www.chinaweal.com.cn/pms-api/api/quicknote/attachment/list/{noteId}`

**请求方法**: GET

**请求头**:
```
Authorization: Bearer {CHINAWEAL_PMS_TOKEN}
```

**路径参数**:
| 参数 | 类型 | 描述 |
|------|------|------|
| noteId | string | 速记ID（必填） |

**响应**: `RestResultListPmsQuickNoteAttachment`

**附件字段**:
| 字段 | 类型 | 描述 |
|------|------|------|
| id | string | 附件ID |
| noteId | string | 速记ID |
| fileName | string | 文件名 |
| fileFormat | string | 文件格式 |
| fileSize | integer | 文件大小(字节) |
| createTime | string | 创建时间 |

**使用示例**:
```
获取速记 xxx 的附件列表
查看速记有哪些附件
```

### 功能10: 下载速记附件

下载指定的速记附件。

**接口地址**: `https://www.chinaweal.com.cn/pms-api/api/quicknote/attachment/download/{attachmentId}`

**请求方法**: GET

**请求头**:
```
Authorization: Bearer {CHINAWEAL_PMS_TOKEN}
```

**路径参数**:
| 参数 | 类型 | 描述 |
|------|------|------|
| attachmentId | string | 附件ID（必填） |

**响应**: 文件内容 (byte)

**使用示例**:
```
下载附件 xxx
下载速记附件
```

### 功能11: 删除速记附件

删除指定的速记附件。

**接口地址**: `https://www.chinaweal.com.cn/pms-api/api/quicknote/attachment/delete`

**请求方法**: POST

**请求头**:
```
Authorization: Bearer {CHINAWEAL_PMS_TOKEN}
```

**查询参数**:
| 参数 | 类型 | 描述 |
|------|------|------|
| attachmentId | string | 附件ID（必填） |

**响应**: `RestResultObject`

**使用示例**:
```
删除附件 xxx
删除速记附件
```

## 调用方式

使用 Bash 工具执行 curl 命令进行 API 调用。

### 环境变量

```bash
CHINAWEAL_PMS_TOKEN="your-token-here"
```

### 示例命令

**新增速记**:
```bash
curl -X POST "https://www.chinaweal.com.cn/pms-api/api/quicknote/save" \
  -H "Authorization: Bearer ${CHINAWEAL_PMS_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{"noteContent":"今天完成了项目评审","noteDate":"2026-04-10","tagNames":["工作","项目"]}'
```

**查询速记列表**:
```bash
curl -X POST "https://www.chinaweal.com.cn/pms-api/api/quicknote/list" \
  -H "Authorization: Bearer ${CHINAWEAL_PMS_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{"current":1,"size":10}'
```

**查询速记详情**:
```bash
curl -X GET "https://www.chinaweal.com.cn/pms-api/api/quicknote/detail/{id}" \
  -H "Authorization: Bearer ${CHINAWEAL_PMS_TOKEN}"
```

**删除速记**:
```bash
curl -X POST "https://www.chinaweal.com.cn/pms-api/api/quicknote/delete?id={id}" \
  -H "Authorization: Bearer ${CHINAWEAL_PMS_TOKEN}"
```

## 注意事项

1. 确保环境变量 `CHINAWEAL_PMS_TOKEN` 已正确配置
2. 速记ID `id` 需要从 PMS 系统获取
3. 日期格式：`noteDate` 使用 `yyyy-MM-dd` 格式
4. 附件上传大小限制请参考 PMS 系统配置