Bläddra i källkod

docs: 更新DR接口文档

改动文件:
- docs/DR.md
sw 3 dagar sedan
förälder
incheckning
5a0f0d33ac
1 ändrade filer med 253 tillägg och 80 borttagningar
  1. 253 80
      docs/DR.md

+ 253 - 80
docs/DR.md

@@ -614,11 +614,11 @@ zh_CN
 
 ## 13	管理平台
 
-## 13.1	节点连通性测试
+## 13.1	获取PACS节点列表
 
-> POST  /api/v1/auth/scp/echo
+> GET  /api/v1/auth/manage/pacs
 ### 接口说明
-> 节点连通性测试
+> 获取PACS节点列表
 ### 请求头
 | 参数名称 | 默认值 | 描述 |
 | ------ | ------ | ------ |
@@ -626,15 +626,6 @@ zh_CN
 |Language||en_US 或 zh_CN|
 |Product|DROS|DROS 或 VETDROS|
 |Source|Electron|Electron 或 Browser 或 Android|
-### 请求体(Request Body)
-| 参数名称 | 数据类型 | 默认值 | 不为空 | 描述 |
-| ------ | ------ | ------ | ------ | ------ |
-| verbose|boolean|false|true|返回详细信息|
-| debug|boolean|false|true|返回调试信息|
-| address|string||true|IPv4地址,且不能为0.0.0.0|
-| port|number||true|端口,1~65536|
-| aet|string||true|被叫节点名,长度1~16|
-| aec|string||true|主叫节点名,长度1~16|
 ### 响应体
 ● 200: OK 响应数据格式:JSON
 ```json
@@ -643,52 +634,46 @@ zh_CN
   "description": "Success",
   "solution": "",
   "data": {
-    "@type": "type.googleapis.com/dr.task.EchoReply",
-    "ok": true,
-    "output": "I: Requesting Association\nI: Association Accepted (Max Send PDV: 16372)\nI: Sending Echo Request (MsgID 1)\nI: Received Echo Response (Success)\nI: Releasing Association\n"
+    "@type": "type.googleapis.com/dr.study.ScpList",
+    "scp": [
+      {
+        "id": 3,
+        "name": "pacs2",
+        "type": "PACS",
+        "address": "192.168.1.4",
+        "port": 6299,
+        "aet": "testscp",
+        "aec": "testscu",
+        "is_enabled": true,
+        "is_default": false,
+        "params": {
+          "a": "b"
+        }
+      },
+      {
+        "id": 1,
+        "name": "pacs1",
+        "type": "PACS",
+        "address": "192.168.1.3",
+        "port": 6299,
+        "aet": "testscp",
+        "aec": "testscu",
+        "is_enabled": true,
+        "is_default": false,
+        "params": {
+          "a": "b"
+        }
+      }
+    ]
   }
 }
 ```
 请求示例
-![  ](http://f1-xyj.fangdeco.cn/attachment/2025/10/9/2LzEU2sUaFU/57083fd3c51b416e8a2c4a7095e8edc9)
 
-## 13.2	发送图像
 
-> POST  /api/v1/auth/scp/store
-### 接口说明
-> 发送图像
-### 请求头
-| 参数名称 | 默认值 | 描述 |
-| ------ | ------ | ------ |
-|Authorization|Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NTEyNzc5NzAsImlkIjoxLCJuYW1lIjoiYWRtaW4ifQ.ooTGwBXaNhtunbKbpqteWbjDwJLjnRmSIl80r5dp1pY||
-|Language||en_US 或 zh_CN|
-|Product|DROS|DROS 或 VETDROS|
-|Source|Electron|Electron 或 Browser 或 Android|
-### 请求体(Request Body)
-| 参数名称 | 数据类型 | 默认值 | 不为空 | 描述 |
-| ------ | ------ | ------ | ------ | ------ |
-| sop_instance_uid|string||true|图像id|
-| pacs_name|string||true|pacs节点名称|
-### 响应体
-● 200: OK 响应数据格式:JSON
-```json
-{
-  "code": "0x000000",
-  "description": "Success",
-  "solution": "",
-  "data": {
-    "@type": "type.googleapis.com/dr.task.StoreReply",
-    "ok": true,
-    "output": "...D: ======================= END DIMSE MESSAGE =======================\nI: Releasing Association\n"
-  }
-}
-```
-请求示例
-![  ](http://f1-xyj.fangdeco.cn/attachment/2025/10/10/2M0jbE69VxY/be2c33a1b0e344f1954927b726b18fa4)
-
-## 13.3	获取PACS节点列表
+## 13.2	获取PACS节点列表
 
-> GET  /api/v1/auth/manage/pacs
+> GET  /api/v1/auth/scp/pacs
 ### 接口说明
 > 获取PACS节点列表
 ### 请求头
@@ -743,7 +728,7 @@ zh_CN
 请求示例
 
 
-## 13.4	增加PACS节点
+## 13.3	增加PACS节点
 
 > POST  /api/v1/auth/manage/pacs
 ### 接口说明
@@ -779,7 +764,122 @@ zh_CN
 请求示例
 ![  ](http://f1-xyj.fangdeco.cn/attachment/2025/10/8/2LxW6Zq9QdE/bc6cf3e6958c49099f60e15add37cac1)
 
-## 13.5	修改PACS节点
+## 13.4	获取发送队列(PACS)
+
+> GET  /api/v1/auth/scp/store
+### 接口说明
+> 获取发送队列(PACS)
+### 请求头
+| 参数名称 | 默认值 | 描述 |
+| ------ | ------ | ------ |
+|Authorization|Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NTEyNzc5NzAsImlkIjoxLCJuYW1lIjoiYWRtaW4ifQ.ooTGwBXaNhtunbKbpqteWbjDwJLjnRmSIl80r5dp1pY||
+|Language||en_US 或 zh_CN|
+|Product|DROS|DROS 或 VETDROS|
+|Source|Electron|Electron 或 Browser 或 Android|
+### 请求参数(Query Param)
+| 参数名称 | 默认值 | 描述 |
+| ------ | ------ | ------ |
+|start_time||RFC3339Nano格式|
+|end_time||RFC3339Nano格式|
+### 响应体
+● 200: OK 响应数据格式:JSON
+```json
+{
+	"code": "0x000000",
+	"data": [
+		{
+			"task_id": "0199cd46-82f0-76c5-b1d3-9399668a1a05",
+			"patient_name": "1update3",
+			"patient_id": "1update2",
+			"priority": "Medium",
+			"status": "ARRIVED",
+			"destination": "pacs3"
+		},
+		{
+			"task_id": "0199cd46-460d-770e-ac8e-549939a4a7d4",
+			"patient_name": "1update3",
+			"patient_id": "1update2",
+			"priority": "Medium",
+			"status": "ARRIVED",
+			"destination": "pacs3"
+		},
+		{
+			"task_id": "0199cd45-dff6-70e4-92e3-2339f0bee57a",
+			"patient_name": "1update3",
+			"patient_id": "1update2",
+			"priority": "Medium",
+			"status": "ARRIVED",
+			"destination": "pacs3"
+		}
+	],
+	"description": "Success",
+	"solution": ""
+}
+```
+请求示例
+![  ](http://f1-xyj.fangdeco.cn/attachment/2025/10/10/2M0ruPn3TXs/93dd3fd6fb9547379918d93652c9151e)
+
+## 13.5	发送图像
+
+> POST  /api/v1/auth/scp/store
+### 接口说明
+> 发送图像
+### 请求头
+| 参数名称 | 默认值 | 描述 |
+| ------ | ------ | ------ |
+|Authorization|Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NTEyNzc5NzAsImlkIjoxLCJuYW1lIjoiYWRtaW4ifQ.ooTGwBXaNhtunbKbpqteWbjDwJLjnRmSIl80r5dp1pY||
+|Language||en_US 或 zh_CN|
+|Product|DROS|DROS 或 VETDROS|
+|Source|Electron|Electron 或 Browser 或 Android|
+### 请求体(Request Body)
+| 参数名称 | 数据类型 | 默认值 | 不为空 | 描述 |
+| ------ | ------ | ------ | ------ | ------ |
+| sop_instance_uid|string||true|图像id|
+| pacs_name|string||true|pacs节点名称|
+### 响应体
+● 200: OK 响应数据格式:JSON
+```json
+{
+  "code": "0x000000",
+  "description": "Success",
+  "solution": "",
+  "data": {
+    "@type": "type.googleapis.com/dr.task.StoreReply",
+    "ok": true,
+    "output": "...D: ======================= END DIMSE MESSAGE =======================\nI: Releasing Association\n"
+  }
+}
+```
+请求示例
+![  ](http://f1-xyj.fangdeco.cn/attachment/2025/10/10/2M0jbE69VxY/be2c33a1b0e344f1954927b726b18fa4)
+
+## 13.6	删除发送任务
+
+> DELETE  /api/v1/auth/scp/task
+### 接口说明
+> 删除发送任务
+### 请求头
+| 参数名称 | 默认值 | 描述 |
+| ------ | ------ | ------ |
+|Authorization|Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NTEyNzc5NzAsImlkIjoxLCJuYW1lIjoiYWRtaW4ifQ.ooTGwBXaNhtunbKbpqteWbjDwJLjnRmSIl80r5dp1pY||
+|Language||en_US 或 zh_CN|
+|Product|DROS|DROS 或 VETDROS|
+|Source|Electron|Electron 或 Browser 或 Android|
+### 响应体
+● 200: OK 响应数据格式:JSON
+```json
+{
+	"code": "0x000000",
+	"description": "Success",
+	"solution": "",
+	"data": {}
+}
+```
+请求示例
+![  ](http://f1-xyj.fangdeco.cn/attachment/2025/10/10/2M0sbMgtryy/b22276514372464c84e062c76a47cbe3)
+
+
+## 13.7	修改PACS节点
 
 > PUT  /api/v1/auth/manage/pacs/{id}
 ### 接口说明
@@ -820,7 +920,7 @@ zh_CN
 ![  ](http://f1-xyj.fangdeco.cn/attachment/2025/10/8/2LxW3RCiZqS/99516b6f16134ab0bee9bc6a47b7a749)
 
 
-## 13.6	删除PACS节点
+## 13.8	删除PACS节点
 
 > DELETE  /api/v1/auth/manage/pacs/{id}
 ### 接口说明
@@ -2001,7 +2101,80 @@ zh_CN
 ```
 ![  ](http://f1-xyj.fangdeco.cn/attachment/2025/10/8/2LxGRVB7LUG/bc6ab340f36a45ed8c311215835b394d)
 
-## 15	登记检查信息
+## 15	传输队列
+
+## 15.1	节点连通性测试
+
+> POST  /api/v1/auth/scp/echo
+### 接口说明
+> 节点连通性测试
+### 请求头
+| 参数名称 | 默认值 | 描述 |
+| ------ | ------ | ------ |
+|Authorization|Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NTEyNzc5NzAsImlkIjoxLCJuYW1lIjoiYWRtaW4ifQ.ooTGwBXaNhtunbKbpqteWbjDwJLjnRmSIl80r5dp1pY||
+|Language||en_US 或 zh_CN|
+|Product|DROS|DROS 或 VETDROS|
+|Source|Electron|Electron 或 Browser 或 Android|
+### 请求体(Request Body)
+| 参数名称 | 数据类型 | 默认值 | 不为空 | 描述 |
+| ------ | ------ | ------ | ------ | ------ |
+| verbose|boolean|false|true|返回详细信息|
+| debug|boolean|false|true|返回调试信息|
+| address|string||true|IPv4地址,且不能为0.0.0.0|
+| port|number||true|端口,1~65536|
+| aet|string||true|被叫节点名,长度1~16|
+| aec|string||true|主叫节点名,长度1~16|
+### 响应体
+● 200: OK 响应数据格式:JSON
+```json
+{
+  "code": "0x000000",
+  "description": "Success",
+  "solution": "",
+  "data": {
+    "@type": "type.googleapis.com/dr.task.EchoReply",
+    "ok": true,
+    "output": "I: Requesting Association\nI: Association Accepted (Max Send PDV: 16372)\nI: Sending Echo Request (MsgID 1)\nI: Received Echo Response (Success)\nI: Releasing Association\n"
+  }
+}
+```
+请求示例
+![  ](http://f1-xyj.fangdeco.cn/attachment/2025/10/9/2LzEU2sUaFU/57083fd3c51b416e8a2c4a7095e8edc9)
+
+## 15.2	重试发送任务
+
+> POST  /api/v1/auth/scp/store_reply
+### 接口说明
+> 重试发送任务
+### 请求头
+| 参数名称 | 默认值 | 描述 |
+| ------ | ------ | ------ |
+|Authorization|Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NTEyNzc5NzAsImlkIjoxLCJuYW1lIjoiYWRtaW4ifQ.ooTGwBXaNhtunbKbpqteWbjDwJLjnRmSIl80r5dp1pY||
+|Language||en_US 或 zh_CN|
+|Product|DROS|DROS 或 VETDROS|
+|Source|Electron|Electron 或 Browser 或 Android|
+### 请求体(Request Body)
+| 参数名称 | 数据类型 | 默认值 | 不为空 | 描述 |
+| ------ | ------ | ------ | ------ | ------ |
+| instance_uid|string||true|图像id|
+### 响应体
+● 200: OK 响应数据格式:JSON
+```json
+{
+  "code": "0x000000",
+  "description": "Success",
+  "solution": "",
+  "data": {
+    "@type": "type.googleapis.com/dr.task.StoreReply",
+    "ok": true,
+    "output": "...D: ======================= END DIMSE MESSAGE =======================\nI: Releasing Association\n"
+  }
+}
+```
+请求示例
+![  ](http://f1-xyj.fangdeco.cn/attachment/2025/10/10/2M0suruwmDA/2ed499a43c564e338ed8cf302fd1e0e6)
+
+## 16	登记检查信息
 
 > POST  /dr/api/v1/auth/study
 ### 接口说明
@@ -2200,7 +2373,7 @@ zh_CN
 ```
 
 
-## 16	变更登记信息
+## 17	变更登记信息
 
 > PUT  /dr/api/v1/auth/study/{id}
 ### 接口说明
@@ -2395,7 +2568,7 @@ zh_CN
 ```
 
 
-## 17	锁定检查信息(不可删除)
+## 18	锁定检查信息(不可删除)
 
 > PUT  /dr/api/v1/auth/study/{id}/lock
 ### 接口说明
@@ -2429,7 +2602,7 @@ lock可选项
 Locked
 Unlocked
 
-## 18	获取检查信息列表
+## 19	获取检查信息列表
 
 > GET  /dr/api/v1/auth/study/
 ### 接口说明
@@ -2573,7 +2746,7 @@ Completed|
 ```
 
 
-## 19	获取检查信息
+## 20	获取检查信息
 
 > GET  /dr/api/v1/auth/study/{id}
 ### 接口说明
@@ -2785,7 +2958,7 @@ Completed|
 ```
 
 
-## 20	获取检查信息状态
+## 21	获取检查信息状态
 
 > GET  /dr/api/v1/auth/study/{id}/stat
 ### 接口说明
@@ -2817,7 +2990,7 @@ Completed|
 ```
 
 
-## 21	删除检查信息(批量)
+## 22	删除检查信息(批量)
 
 > DELETE  /dr/api/v1/auth/study
 ### 接口说明
@@ -2852,7 +3025,7 @@ Completed|
 ```
 
 
-## 22	[Study]存储拍摄的急诊患者影像
+## 23	[Study]存储拍摄的急诊患者影像
 
 > POST  /api/v1/auth/study/portrait
 ### 接口说明
@@ -2888,7 +3061,7 @@ Completed|
 ```
 
 
-## 23	[Study]批量添加体位和协议
+## 24	[Study]批量添加体位和协议
 
 > POST  /dr/api/v1/auth/image
 ### 接口说明
@@ -3003,7 +3176,7 @@ Completed|
 ```
 
 
-## 24	[Study]复制体位
+## 25	[Study]复制体位
 
 > POST  /dr/api/v1/auth/image/copy
 ### 接口说明
@@ -3067,7 +3240,7 @@ Completed|
 ```
 
 
-## 25	[Study]体位重新排序
+## 26	[Study]体位重新排序
 
 > POST  /dr/api/v1/auth/image/sort
 ### 接口说明
@@ -3117,7 +3290,7 @@ Completed|
 ```
 
 
-## 26	[Study]删除体位
+## 27	[Study]删除体位
 
 > DELETE  /dr/api/v1/auth/image/:id
 ### 接口说明
@@ -3145,7 +3318,7 @@ Completed|
 示例请求
 DELETE {{drurl}}/api/v1/auth/image/1.2.276.0.1000000.5.1.4.701601461.19649.1749539018.668478
 
-## 27	[Study]存储后处理dcm
+## 28	[Study]存储后处理dcm
 
 > POST  /api/v1/auth/image/post_proc
 ### 接口说明
@@ -3179,7 +3352,7 @@ DELETE {{drurl}}/api/v1/auth/image/1.2.276.0.1000000.5.1.4.701601461.19649.17495
 ```
 
 
-## 28	报告预览
+## 29	报告预览
 
 > POST  /dr/api/v1/auth/report/preview
 ### 接口说明
@@ -3237,7 +3410,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)
 
-## 29	保存报告
+## 30	保存报告
 
 > POST  /dr/api/v1/auth/study/{id}/report
 ### 接口说明
@@ -3303,7 +3476,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)
 
-## 30	获取报告
+## 31	获取报告
 
 > GET  /dr/api/v1/auth/study/{id}/report
 ### 接口说明
@@ -3324,7 +3497,7 @@ DELETE {{drurl}}/api/v1/auth/image/1.2.276.0.1000000.5.1.4.701601461.19649.17495
 请求示例
 /api/v1/auth/study/20250912063732016/report
 
-## 31	[Device]打开设备
+## 32	[Device]打开设备
 
 > POST  /api/v1/auth/device/open
 ### 接口说明
@@ -3355,7 +3528,7 @@ DELETE {{drurl}}/api/v1/auth/image/1.2.276.0.1000000.5.1.4.701601461.19649.17495
 ```
 
 
-## 32	[Device]执行Get
+## 33	[Device]执行Get
 
 > POST  /api/v1/auth/device/get
 ### 接口说明
@@ -3387,7 +3560,7 @@ DELETE {{drurl}}/api/v1/auth/image/1.2.276.0.1000000.5.1.4.701601461.19649.17495
 ```
 
 
-## 33	[Device]执行Action
+## 34	[Device]执行Action
 
 > POST  /api/v1/auth/device/action
 ### 接口说明
@@ -3422,7 +3595,7 @@ DELETE {{drurl}}/api/v1/auth/image/1.2.276.0.1000000.5.1.4.701601461.19649.17495
 ```
 
 
-## 34	[Task]开始检查
+## 35	[Task]开始检查
 
 > POST  /api/v1/auth/task/inspection/start
 ### 接口说明
@@ -3457,7 +3630,7 @@ DELETE {{drurl}}/api/v1/auth/image/1.2.276.0.1000000.5.1.4.701601461.19649.17495
 ```
 
 
-## 35	[Task]获取全局状态
+## 36	[Task]获取全局状态
 
 > GET  /api/v1/auth/task/inspection/status
 ### 接口说明
@@ -3504,7 +3677,7 @@ Topic: MODULE/TASK/STATUS/GLOBAL
 ```
 
 
-## 36	[Task]软曝光(包含状态推送说明)
+## 37	[Task]软曝光(包含状态推送说明)
 
 > POST  /api/v1/auth/task/inspection/trigger
 ### 接口说明
@@ -3564,7 +3737,7 @@ Topic: MODULE/TASK/STATUS/GLOBAL
 ```
 
 
-## 37	[Task]接受拒绝图像
+## 38	[Task]接受拒绝图像
 
 > POST  /api/v1/auth/task/inspection/judge
 ### 接口说明
@@ -3600,7 +3773,7 @@ Topic: MODULE/TASK/STATUS/GLOBAL
 ```
 
 
-## 38	[Task]挂起或完成study
+## 39	[Task]挂起或完成study
 
 > POST  /api/v1/auth/task/inspection/leave
 ### 接口说明
@@ -3632,7 +3805,7 @@ Topic: MODULE/TASK/STATUS/GLOBAL
 ```
 
 
-## 39	获取dcm文件
+## 40	获取dcm文件
 
 > GET  /api/v1/auth/image/dcm/{dcmfilename}
 ### 接口说明
@@ -3655,7 +3828,7 @@ Topic: MODULE/TASK/STATUS/GLOBAL
 ```
 
 
-## 40	获取缩略图文件
+## 41	获取缩略图文件
 
 > GET  /api/v1/auth/image/thumbnail/{filename}
 ### 接口说明