Przeglądaj źródła

更新接口描述

dengdx 13 godzin temu
rodzic
commit
e572a446e4
1 zmienionych plików z 189 dodań i 95 usunięć
  1. 189 95
      docs/DR.md

+ 189 - 95
docs/DR.md

@@ -612,9 +612,149 @@ zh_CN
 - System/SimulatorFPD  探测器仿真模式
 
 
-## 13	管理平台
+## 13	获取文件
 
-## 13.1	获取PACS节点列表
+## 13.1	获取缩略图文件(pub)
+
+> GET  /api/v1/pub/thumbnail/{filename}
+### 接口说明
+> 获取缩略图文件
+### 地址参数(Path Variable)
+| 参数名称 | 默认值 | 描述 |
+| ------ | ------ | ------ |
+|filename||缩略图文件名|
+### 请求头
+| 参数名称 | 默认值 | 描述 |
+| ------ | ------ | ------ |
+|Authorization|Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NTEyNzc5NzAsImlkIjoxLCJuYW1lIjoiYWRtaW4ifQ.ooTGwBXaNhtunbKbpqteWbjDwJLjnRmSIl80r5dp1pY||
+|Language||en_US 或 zh_CN|
+|Product|DROS|DROS 或 VETDROS|
+|Source|Electron|Electron 或 Browser 或 Android|
+### 响应体
+● 200: OK 响应数据格式:File
+```json
+文件
+```
+
+
+## 13.2	获取缩略图文件
+
+> GET  /api/v1/auth/f/thumbnail/{filename}
+### 接口说明
+> 获取缩略图文件
+### 地址参数(Path Variable)
+| 参数名称 | 默认值 | 描述 |
+| ------ | ------ | ------ |
+|filename||缩略图文件名|
+### 请求头
+| 参数名称 | 默认值 | 描述 |
+| ------ | ------ | ------ |
+|Authorization|Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NTEyNzc5NzAsImlkIjoxLCJuYW1lIjoiYWRtaW4ifQ.ooTGwBXaNhtunbKbpqteWbjDwJLjnRmSIl80r5dp1pY||
+|Language||en_US 或 zh_CN|
+|Product|DROS|DROS 或 VETDROS|
+|Source|Electron|Electron 或 Browser 或 Android|
+### 响应体
+● 200: OK 响应数据格式:File
+```json
+文件
+```
+
+
+## 13.3	获取dcm文件(pub)
+
+> GET  /api/v1/pub/dcm/{dcmfilename}
+### 接口说明
+> 获取dcm文件
+### 地址参数(Path Variable)
+| 参数名称 | 默认值 | 描述 |
+| ------ | ------ | ------ |
+|dcmfilename||dcm文件名|
+### 请求头
+| 参数名称 | 默认值 | 描述 |
+| ------ | ------ | ------ |
+|Authorization|Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NTEyNzc5NzAsImlkIjoxLCJuYW1lIjoiYWRtaW4ifQ.ooTGwBXaNhtunbKbpqteWbjDwJLjnRmSIl80r5dp1pY||
+|Language||en_US 或 zh_CN|
+|Product|DROS|DROS 或 VETDROS|
+|Source|Electron|Electron 或 Browser 或 Android|
+### 响应体
+● 200: OK 响应数据格式:File
+```json
+文件
+```
+
+
+## 13.4	获取dcm文件
+
+> GET  /api/v1/auth/f/dcm/{dcmfilename}
+### 接口说明
+> 获取dcm文件
+### 地址参数(Path Variable)
+| 参数名称 | 默认值 | 描述 |
+| ------ | ------ | ------ |
+|dcmfilename||dcm文件名|
+### 请求头
+| 参数名称 | 默认值 | 描述 |
+| ------ | ------ | ------ |
+|Authorization|Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NTEyNzc5NzAsImlkIjoxLCJuYW1lIjoiYWRtaW4ifQ.ooTGwBXaNhtunbKbpqteWbjDwJLjnRmSIl80r5dp1pY||
+|Language||en_US 或 zh_CN|
+|Product|DROS|DROS 或 VETDROS|
+|Source|Electron|Electron 或 Browser 或 Android|
+### 响应体
+● 200: OK 响应数据格式:File
+```json
+文件
+```
+
+
+## 13.5	获取图像(pub)
+
+> GET  /api/v1/pub/capture/{filename}
+### 接口说明
+> 获取图像
+### 地址参数(Path Variable)
+| 参数名称 | 默认值 | 描述 |
+| ------ | ------ | ------ |
+|filename||图像文件名|
+### 请求头
+| 参数名称 | 默认值 | 描述 |
+| ------ | ------ | ------ |
+|Authorization|Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NTEyNzc5NzAsImlkIjoxLCJuYW1lIjoiYWRtaW4ifQ.ooTGwBXaNhtunbKbpqteWbjDwJLjnRmSIl80r5dp1pY||
+|Language||en_US 或 zh_CN|
+|Product|DROS|DROS 或 VETDROS|
+|Source|Electron|Electron 或 Browser 或 Android|
+### 响应体
+● 200: OK 响应数据格式:File
+```json
+文件
+```
+
+
+## 13.6	获取图像
+
+> GET  /api/v1/auth/f/capture/{filename}
+### 接口说明
+> 获取图像
+### 地址参数(Path Variable)
+| 参数名称 | 默认值 | 描述 |
+| ------ | ------ | ------ |
+|filename||图像文件名|
+### 请求头
+| 参数名称 | 默认值 | 描述 |
+| ------ | ------ | ------ |
+|Authorization|Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NTEyNzc5NzAsImlkIjoxLCJuYW1lIjoiYWRtaW4ifQ.ooTGwBXaNhtunbKbpqteWbjDwJLjnRmSIl80r5dp1pY||
+|Language||en_US 或 zh_CN|
+|Product|DROS|DROS 或 VETDROS|
+|Source|Electron|Electron 或 Browser 或 Android|
+### 响应体
+● 200: OK 响应数据格式:File
+```json
+文件
+```
+
+
+## 14	管理平台
+
+## 14.1	获取PACS节点列表
 
 > GET  /api/v1/auth/manage/pacs
 ### 接口说明
@@ -671,7 +811,7 @@ zh_CN
 请求示例
 
 
-## 13.2	增加PACS节点
+## 14.2	增加PACS节点
 
 > POST  /api/v1/auth/manage/pacs
 ### 接口说明
@@ -707,7 +847,7 @@ zh_CN
 请求示例
 ![  ](http://f1-xyj.fangdeco.cn/attachment/2025/10/8/2LxW6Zq9QdE/bc6cf3e6958c49099f60e15add37cac1)
 
-## 13.3	修改PACS节点
+## 14.3	修改PACS节点
 
 > PUT  /api/v1/auth/manage/pacs/{id}
 ### 接口说明
@@ -748,7 +888,7 @@ zh_CN
 ![  ](http://f1-xyj.fangdeco.cn/attachment/2025/10/8/2LxW3RCiZqS/99516b6f16134ab0bee9bc6a47b7a749)
 
 
-## 13.4	删除PACS节点
+## 14.4	删除PACS节点
 
 > DELETE  /api/v1/auth/manage/pacs/{id}
 ### 接口说明
@@ -777,9 +917,9 @@ zh_CN
 ![  ](http://f1-xyj.fangdeco.cn/attachment/2025/10/8/2LxVytRZBlw/23780f4ef34d404ca604608b7b73547f)
 
 
-## 14	协议
+## 15	协议
 
-## 14.1	获取患者类型
+## 15.1	获取患者类型
 
 > GET  /dr/api/v1/auth/protocol/patient_type
 ### 请求头
@@ -830,7 +970,7 @@ zh_CN
 ```
 
 
-## 14.2	获取身体部位
+## 15.2	获取身体部位
 
 > GET  /dr/api/v1/auth/protocol/body_part
 ### 接口说明
@@ -889,7 +1029,7 @@ zh_CN
 ```
 
 
-## 14.3	获取协议列表
+## 15.3	获取协议列表
 
 > GET  /dr/api/v1/auth/protocol/procedure
 ### 接口说明
@@ -1013,7 +1153,7 @@ zh_CN
 ```
 
 
-## 14.4	获取体位列表
+## 15.4	获取体位列表
 
 > GET  /dr/api/v1/auth/protocol/view
 ### 接口说明
@@ -1148,7 +1288,7 @@ zh_CN
 ```
 
 
-## 14.5	获取体位列表(通过procedure_id)
+## 15.5	获取体位列表(通过procedure_id)
 
 > GET  /dr/api/v1/auth/protocol/procedure/{id}/view
 ### 接口说明
@@ -1277,7 +1417,7 @@ zh_CN
 ```
 
 
-## 14.6	获取体位详情
+## 15.6	获取体位详情
 
 > GET  /dr/api/v1/auth/protocol/view/{id}
 ### 接口说明
@@ -1360,7 +1500,7 @@ zh_CN
 ```
 
 
-## 14.7	获取APR详情(通过view_id)
+## 15.7	获取APR详情(通过view_id)
 
 > GET  /dr/api/v1/auth/protocol/view/{id}/apr
 ### 接口说明
@@ -1571,7 +1711,7 @@ zh_CN
 ```
 
 
-## 14.8	获取APR详情
+## 15.8	获取APR详情
 
 > GET  /dr/api/v1/auth/protocol/apr/{id}
 ### 接口说明
@@ -1782,7 +1922,7 @@ zh_CN
 ```
 
 
-## 14.9	获取APR设备信息
+## 15.9	获取APR设备信息
 
 > GET  /dr/api/v1/auth/protocol/apr/{id}/device
 ### 接口说明
@@ -1831,7 +1971,7 @@ zh_CN
 ```
 
 
-## 14.10	获取APR默认曝光参数
+## 15.10	获取APR默认曝光参数
 
 > GET  /dr/api/v1/auth/protocol/apr/{id}/tech
 ### 接口说明
@@ -1894,7 +2034,7 @@ zh_CN
 ```
 
 
-## 14.11	通过厚度获取APR
+## 15.11	通过厚度获取APR
 
 > GET  /dr/api/v1/auth/protocol/thickness/{thickness}/apr
 ### 接口说明
@@ -1929,9 +2069,9 @@ zh_CN
 ```
 ![  ](http://f1-xyj.fangdeco.cn/attachment/2025/10/8/2LxGRVB7LUG/bc6ab340f36a45ed8c311215835b394d)
 
-## 15	传输队列
+## 16	传输队列
 
-## 15.1	节点连通性测试
+## 16.1	节点连通性测试
 
 > POST  /api/v1/auth/scp/echo
 ### 接口说明
@@ -1969,7 +2109,7 @@ zh_CN
 请求示例
 ![  ](http://f1-xyj.fangdeco.cn/attachment/2025/10/9/2LzEU2sUaFU/57083fd3c51b416e8a2c4a7095e8edc9)
 
-## 15.2	获取PACS节点列表
+## 16.2	获取PACS节点列表
 
 > GET  /api/v1/auth/scp/pacs
 ### 接口说明
@@ -2028,7 +2168,7 @@ zh_CN
 请求示例
 ![  ](http://f1-xyj.fangdeco.cn/attachment/2025/10/11/2M2HRxPLai0/761eb4441cfe4a5aa308cdf1859d32c3)
 
-## 15.3	获取发送队列(PACS)
+## 16.3	获取发送队列(PACS)
 
 > GET  /api/v1/auth/scp/store
 ### 接口说明
@@ -2086,7 +2226,7 @@ zh_CN
 请求示例
 ![  ](http://f1-xyj.fangdeco.cn/attachment/2025/10/11/2M2RwohGYQy/4cebd746f7d349ac992e83d1656ca8b2)
 
-## 15.4	删除发送任务(批量)
+## 16.4	删除发送任务(批量)
 
 > DELETE  /api/v1/auth/scp/task
 ### 接口说明
@@ -2112,7 +2252,7 @@ zh_CN
 ![  ](http://f1-xyj.fangdeco.cn/attachment/2025/10/11/2M2HVKxHy8u/3d8b16fc08844c80930402f17e389dc2)
 
 
-## 15.5	发送图像
+## 16.5	发送图像
 
 > POST  /api/v1/auth/scp/store
 ### 接口说明
@@ -2146,7 +2286,7 @@ zh_CN
 请求示例
 ![  ](http://f1-xyj.fangdeco.cn/attachment/2025/10/10/2M0jbE69VxY/be2c33a1b0e344f1954927b726b18fa4)
 
-## 15.6	发送图像(按Study批量发送)
+## 16.6	发送图像(按Study批量发送)
 
 > POST  /api/v1/auth/scp/study_store
 ### 接口说明
@@ -2180,7 +2320,7 @@ zh_CN
 请求示例
 ![  ](http://f1-xyj.fangdeco.cn/attachment/2025/10/10/2M0jbE69VxY/be2c33a1b0e344f1954927b726b18fa4)
 
-## 15.7	重试发送任务
+## 16.7	重试发送任务
 
 > POST  /api/v1/auth/scp/store_reply
 ### 接口说明
@@ -2213,7 +2353,7 @@ zh_CN
 请求示例
 ![  ](http://f1-xyj.fangdeco.cn/attachment/2025/10/11/2M2HYvSokoS/13f07b5d144c465daff5ca8b70cc82c2)
 
-## 16	登记检查信息
+## 17	登记检查信息
 
 > POST  /dr/api/v1/auth/study
 ### 接口说明
@@ -2412,7 +2552,7 @@ zh_CN
 ```
 
 
-## 17	变更登记信息
+## 18	变更登记信息
 
 > PUT  /dr/api/v1/auth/study/{id}
 ### 接口说明
@@ -2607,7 +2747,7 @@ zh_CN
 ```
 
 
-## 18	锁定检查信息(不可删除)
+## 19	锁定检查信息(不可删除)
 
 > PUT  /dr/api/v1/auth/study/{id}/lock
 ### 接口说明
@@ -2641,7 +2781,7 @@ lock可选项
 Locked
 Unlocked
 
-## 19	获取检查信息列表
+## 20	获取检查信息列表
 
 > GET  /dr/api/v1/auth/study/
 ### 接口说明
@@ -2805,7 +2945,7 @@ Completed|
 ```
 
 
-## 20	获取检查信息
+## 21	获取检查信息
 
 > GET  /dr/api/v1/auth/study/{id}
 ### 接口说明
@@ -3039,7 +3179,7 @@ Completed|
 ```
 
 
-## 21	获取检查信息状态
+## 22	获取检查信息状态
 
 > GET  /dr/api/v1/auth/study/{id}/stat
 ### 接口说明
@@ -3071,7 +3211,7 @@ Completed|
 ```
 
 
-## 22	删除检查信息(批量)
+## 23	删除检查信息(批量)
 
 > DELETE  /dr/api/v1/auth/study
 ### 接口说明
@@ -3106,7 +3246,7 @@ Completed|
 ```
 
 
-## 23	[Study]存储拍摄的急诊患者影像
+## 24	[Study]存储拍摄的急诊患者影像
 
 > POST  /api/v1/auth/study/portrait
 ### 接口说明
@@ -3142,7 +3282,7 @@ Completed|
 ```
 
 
-## 24	[Study]批量添加体位和协议
+## 25	[Study]批量添加体位和协议
 
 > POST  /dr/api/v1/auth/image
 ### 接口说明
@@ -3257,7 +3397,7 @@ Completed|
 ```
 
 
-## 25	[Study]复制体位
+## 26	[Study]复制体位
 
 > POST  /dr/api/v1/auth/image/copy
 ### 接口说明
@@ -3321,7 +3461,7 @@ Completed|
 ```
 
 
-## 26	[Study]体位重新排序
+## 27	[Study]体位重新排序
 
 > POST  /dr/api/v1/auth/image/sort
 ### 接口说明
@@ -3371,7 +3511,7 @@ Completed|
 ```
 
 
-## 27	[Study]删除体位
+## 28	[Study]删除体位
 
 > DELETE  /dr/api/v1/auth/image/:id
 ### 接口说明
@@ -3399,7 +3539,7 @@ Completed|
 示例请求
 DELETE {{drurl}}/api/v1/auth/image/1.2.276.0.1000000.5.1.4.701601461.19649.1749539018.668478
 
-## 28	[Study]存储后处理dcm
+## 29	[Study]存储后处理dcm
 
 > POST  /api/v1/auth/image/post_proc
 ### 接口说明
@@ -3433,7 +3573,7 @@ DELETE {{drurl}}/api/v1/auth/image/1.2.276.0.1000000.5.1.4.701601461.19649.17495
 ```
 
 
-## 29	报告预览
+## 30	报告预览
 
 > POST  /dr/api/v1/auth/report/preview
 ### 接口说明
@@ -3491,7 +3631,7 @@ DELETE {{drurl}}/api/v1/auth/image/1.2.276.0.1000000.5.1.4.701601461.19649.17495
 宠物示例:
 ![  ](http://f1-xyj.fangdeco.cn/attachment/2025/9/23/2LYIk58dZYG/74547ae49660497f90c3db8806c87a72)
 
-## 30	保存报告
+## 31	保存报告
 
 > POST  /dr/api/v1/auth/study/{id}/report
 ### 接口说明
@@ -3557,7 +3697,7 @@ DELETE {{drurl}}/api/v1/auth/image/1.2.276.0.1000000.5.1.4.701601461.19649.17495
 示例
 ![  ](http://f1-xyj.fangdeco.cn/attachment/2025/9/19/2LRW3rk4TRY/74ef9c252fcb4627bafd24e0e0752204)
 
-## 31	获取报告
+## 32	获取报告
 
 > GET  /dr/api/v1/auth/study/{id}/report
 ### 接口说明
@@ -3578,7 +3718,7 @@ DELETE {{drurl}}/api/v1/auth/image/1.2.276.0.1000000.5.1.4.701601461.19649.17495
 请求示例
 /api/v1/auth/study/20250912063732016/report
 
-## 32	[Device]打开设备
+## 33	[Device]打开设备
 
 > POST  /api/v1/auth/device/open
 ### 接口说明
@@ -3609,7 +3749,7 @@ DELETE {{drurl}}/api/v1/auth/image/1.2.276.0.1000000.5.1.4.701601461.19649.17495
 ```
 
 
-## 33	[Device]执行Get
+## 34	[Device]执行Get
 
 > POST  /api/v1/auth/device/get
 ### 接口说明
@@ -3641,7 +3781,7 @@ DELETE {{drurl}}/api/v1/auth/image/1.2.276.0.1000000.5.1.4.701601461.19649.17495
 ```
 
 
-## 34	[Device]执行Action
+## 35	[Device]执行Action
 
 > POST  /api/v1/auth/device/action
 ### 接口说明
@@ -3676,7 +3816,7 @@ DELETE {{drurl}}/api/v1/auth/image/1.2.276.0.1000000.5.1.4.701601461.19649.17495
 ```
 
 
-## 35	[Task]开始检查
+## 36	[Task]开始检查
 
 > POST  /api/v1/auth/task/inspection/start
 ### 接口说明
@@ -3711,7 +3851,7 @@ DELETE {{drurl}}/api/v1/auth/image/1.2.276.0.1000000.5.1.4.701601461.19649.17495
 ```
 
 
-## 36	[Task]获取全局状态
+## 37	[Task]获取全局状态
 
 > GET  /api/v1/auth/task/inspection/status
 ### 接口说明
@@ -3758,7 +3898,7 @@ Topic: MODULE/TASK/STATUS/GLOBAL
 ```
 
 
-## 37	[Task]软曝光(包含状态推送说明)
+## 38	[Task]软曝光(包含状态推送说明)
 
 > POST  /api/v1/auth/task/inspection/trigger
 ### 接口说明
@@ -3818,7 +3958,7 @@ Topic: MODULE/TASK/STATUS/GLOBAL
 ```
 
 
-## 38	[Task]接受拒绝图像
+## 39	[Task]接受拒绝图像
 
 > POST  /api/v1/auth/task/inspection/judge
 ### 接口说明
@@ -3854,7 +3994,7 @@ Topic: MODULE/TASK/STATUS/GLOBAL
 ```
 
 
-## 39	[Task]挂起或完成study
+## 40	[Task]挂起或完成study
 
 > POST  /api/v1/auth/task/inspection/leave
 ### 接口说明
@@ -3885,49 +4025,3 @@ Topic: MODULE/TASK/STATUS/GLOBAL
 }
 ```
 
-
-## 40	获取dcm文件
-
-> GET  /api/v1/auth/image/dcm/{dcmfilename}
-### 接口说明
-> 获取dcm文件
-### 地址参数(Path Variable)
-| 参数名称 | 默认值 | 描述 |
-| ------ | ------ | ------ |
-|dcmfilename||dcm文件名|
-### 请求头
-| 参数名称 | 默认值 | 描述 |
-| ------ | ------ | ------ |
-|Authorization|Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NTEyNzc5NzAsImlkIjoxLCJuYW1lIjoiYWRtaW4ifQ.ooTGwBXaNhtunbKbpqteWbjDwJLjnRmSIl80r5dp1pY||
-|Language||en_US 或 zh_CN|
-|Product|DROS|DROS 或 VETDROS|
-|Source|Electron|Electron 或 Browser 或 Android|
-### 响应体
-● 200: OK 响应数据格式:File
-```json
-文件
-```
-
-
-## 41	获取缩略图文件
-
-> GET  /api/v1/auth/image/thumbnail/{filename}
-### 接口说明
-> 获取缩略图文件
-### 地址参数(Path Variable)
-| 参数名称 | 默认值 | 描述 |
-| ------ | ------ | ------ |
-|filename||缩略图文件名|
-### 请求头
-| 参数名称 | 默认值 | 描述 |
-| ------ | ------ | ------ |
-|Authorization|Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NTEyNzc5NzAsImlkIjoxLCJuYW1lIjoiYWRtaW4ifQ.ooTGwBXaNhtunbKbpqteWbjDwJLjnRmSIl80r5dp1pY||
-|Language||en_US 或 zh_CN|
-|Product|DROS|DROS 或 VETDROS|
-|Source|Electron|Electron 或 Browser 或 Android|
-### 响应体
-● 200: OK 响应数据格式:File
-```json
-文件
-```
-