Shadow Editor Pro 业务数据接口
本文档介绍了一套用于数据可视化场景的业务数据接口，主要提供对设备、测量、属性、字典、站点等核心业务实体的管理功能。文档详细说明了每个模块的数据结构及其对应的增删改查API接口，包括设备管理、设备测量管理、测量管理、模型与设备/测量/属性的关联管理、属性管理、字典管理以及站点管理。所有接口均遵循统一的响应格式，支持逻辑删除，旨在为上层应用提供完整、标准化的数据操作服务，以支撑可视化系统的数据需求。
业务数据接口提供设备、测量、属性、字典、站点等业务数据的管理功能，用于数据可视化场景。
设备管理
设备管理提供设备的增删改查功能。
数据类型
```typescript
interface Device {
// 设备ID
id?: string
// 设备名称
name: string
// 所属场站ID
stationId: string
// 创建时间
createTime?: string
// 更新时间
updateTime?: string
// 是否删除
isDeleted: boolean
}
```
## API 接口
~~~~ 1. 获取设备列表
**接口**: `GET /api/device/list`
**描述**: 获取所有设备列表
**请求参数**:
| 参数 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | -------------------- |
| name | string | 否 | 设备名称（模糊查询） |
| stationId | string | 否 | 场站ID |
**响应示例**:
```json
{
"success": true,
"data": [
{
"id": "1",
"name": "温度传感器",
"stationId": "1",
"createTime": "2024-10-19 10:00:00",
"updateTime": "2024-10-19 10:00:00",
"isDeleted": false
}
]
}
```
---
~~~~ 2. 获取单个设备
**接口**: `GET /api/device/get`
**描述**: 获取指定设备详情
**请求参数**:
| 参数 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------ |
| id | string | 是 | 设备ID |
**响应示例**:
```json
{
"success": true,
"data": {
"id": "1",
"name": "温度传感器",
"stationId": "1",
"createTime": "2024-10-19 10:00:00",
"updateTime": "2024-10-19 10:00:00",
"isDeleted": false
}
}
```
---
~~~~ 3. 添加设备
**接口**: `POST /api/device/add`
**描述**: 创建新设备
**请求参数**:
| 参数 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | -------- |
| name | string | 是 | 设备名称 |
| stationId | string | 是 | 场站ID |
**响应示例**:
```json
{
"success": true,
"data": "1",
"message": "设备创建成功"
}
```
---
~~~~ 4. 更新设备
**接口**: `POST /api/device/update`
**描述**: 更新设备信息
**请求参数**:
| 参数 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | -------- |
| id | string | 是 | 设备ID |
| name | string | 否 | 设备名称 |
| stationId | string | 否 | 场站ID |
**响应示例**:
```json
{
"success": true,
"data": true,
"message": "设备更新成功"
}
```
---
~~~~ 5. 删除设备
**接口**: `POST /api/device/remove`
**描述**: 删除设备（逻辑删除）
**请求参数**:
| 参数 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------ |
| id | string | 是 | 设备ID |
**响应示例**:
```json
{
"success": true,
"data": true,
"message": "设备删除成功"
}
```
---
# 设备测量管理
设备测量管理提供设备测量数据的增删改查功能。
## 数据类型
~~~~ DeviceMeasure
```typescript
interface DeviceMeasure {
// 测量ID
id?: string
// 设备ID
deviceId: string
// 测量名称
name: string
// 测量值
value: string
// 单位
unit?: string
// 测量时间
measureTime?: string
// 创建时间
createTime?: string
// 更新时间
updateTime?: string
// 是否删除
isDeleted: boolean
}
```
## API 接口
~~~~ 1. 获取设备测量列表
**接口**: `GET /api/device_measure/list`
**描述**: 获取设备测量数据列表
**请求参数**:
| 参数 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | -------- |
| deviceId | string | 否 | 设备ID |
| name | string | 否 | 测量名称 |
| startTime | string | 否 | 开始时间 |
| endTime | string | 否 | 结束时间 |
**响应示例**:
```json
{
"success": true,
"data": [
{
"id": "1",
"deviceId": "1",
"name": "温度",
"value": "25.5",
"unit": "℃",
"measureTime": "2024-10-19 10:00:00",
"createTime": "2024-10-19 10:00:00",
"updateTime": "2024-10-19 10:00:00",
"isDeleted": false
}
]
}
```
---
~~~~ 2. 添加设备测量
**接口**: `POST /api/device_measure/add`
**描述**: 添加设备测量数据
**请求参数**:
| 参数 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | -------- |
| deviceId | string | 是 | 设备ID |
| name | string | 是 | 测量名称 |
| value | string | 是 | 测量值 |
| unit | string | 否 | 单位 |
| measureTime | string | 否 | 测量时间 |
**响应示例**:
```json
{
"success": true,
"message": "测量数据添加成功"
}
```
---
~~~~ 3. 更新设备测量
**接口**: `POST /api/device_measure/update`
**描述**: 更新设备测量数据
**请求参数**:
| 参数 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | -------- |
| id | string | 是 | 测量ID |
| deviceId | string | 否 | 设备ID |
| name | string | 否 | 测量名称 |
| value | string | 否 | 测量值 |
| unit | string | 否 | 单位 |
| measureTime | string | 否 | 测量时间 |
**响应示例**:
```json
{
"success": true,
"message": "测量数据更新成功"
}
```
---
~~~~ 4. 删除设备测量
**接口**: `POST /api/device_measure/remove`
**描述**: 删除设备测量数据
**请求参数**:
| 参数 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------ |
| id | string | 是 | 测量ID |
**响应示例**:
```json
{
"success": true,
"message": "测量数据删除成功"
}
```
---
# 测量管理
测量管理提供测量数据的增删改查功能。
## 数据类型
~~~~ Measure
```typescript
interface Measure {
// 测量ID
id?: string
// 测量名称
name: string
// 测量描述
description?: string
// 创建时间
createTime?: string
// 更新时间
updateTime?: string
// 是否删除
isDeleted: boolean
}
```
## API 接口
~~~~ 1. 获取测量列表
**接口**: `GET /api/measure/list`
**描述**: 获取测量数据列表
**请求参数**:
| 参数 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | -------------------- |
| name | string | 否 | 测量名称（模糊查询） |
**响应示例**:
```json
{
"success": true,
"data": [
{
"id": "1",
"name": "距离测量",
"description": "测量两点之间的距离",
"createTime": "2024-10-19 10:00:00",
"updateTime": "2024-10-19 10:00:00",
"isDeleted": false
}
]
}
```
---
~~~~ 2. 添加测量
**接口**: `POST /api/measure/add`
**描述**: 创建测量
**请求参数**:
| 参数 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | -------- |
| name | string | 是 | 测量名称 |
| description | string | 否 | 测量描述 |
**响应示例**:
```json
{
"success": true,
"message": "测量创建成功"
}
```
---
~~~~ 3. 更新测量
**接口**: `POST /api/measure/update`
**描述**: 更新测量信息
**请求参数**:
| 参数 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | -------- |
| id | string | 是 | 测量ID |
| name | string | 否 | 测量名称 |
| description | string | 否 | 测量描述 |
**响应示例**:
```json
{
"success": true,
"message": "测量更新成功"
}
```
---
~~~~ 4. 删除测量
**接口**: `POST /api/measure/remove`
**描述**: 删除测量
**请求参数**:
| 参数 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------ |
| id | string | 是 | 测量ID |
**响应示例**:
```json
{
"success": true,
"message": "测量删除成功"
}
```
---
# 模型设备关联管理
模型设备关联管理提供模型与设备的关联功能。
## 数据类型
~~~~ ModelDevice
```typescript
interface ModelDevice {
// 关联ID
id?: string
// 模型UUID
modelUuid: string
// 设备ID
deviceId: string
// 创建时间
createTime?: string
// 更新时间
updateTime?: string
// 是否删除
isDeleted: boolean
}
```
## API 接口
~~~~ 1. 获取模型设备关联列表
**接口**: `GET /api/model_device/list`
**描述**: 获取模型设备关联列表
**请求参数**:
| 参数 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | -------- |
| modelUuid | string | 否 | 模型UUID |
| deviceId | string | 否 | 设备ID |
**响应示例**:
```json
{
"success": true,
"data": [
{
"id": "1",
"modelUuid": "model-uuid-1",
"deviceId": "1",
"createTime": "2024-10-19 10:00:00",
"updateTime": "2024-10-19 10:00:00",
"isDeleted": false
}
]
}
```
---
~~~~ 2. 添加模型设备关联
**接口**: `POST /api/model_device/add`
**描述**: 创建模型设备关联
**请求参数**:
| 参数 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | -------- |
| modelUuid | string | 是 | 模型UUID |
| deviceId | string | 是 | 设备ID |
**响应示例**:
```json
{
"success": true,
"message": "关联创建成功"
}
```
---
~~~~ 3. 删除模型设备关联
**接口**: `POST /api/model_device/remove`
**描述**: 删除模型设备关联
**请求参数**:
| 参数 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------ |
| id | string | 是 | 关联ID |
**响应示例**:
```json
{
"success": true,
"message": "关联删除成功"
}
```
---
# 模型测量关联管理
模型测量关联管理提供模型与测量的关联功能。
## 数据类型
~~~~ ModelMeasure
```typescript
interface ModelMeasure {
// 关联ID
id?: string
// 模型UUID
modelUuid: string
// 测量ID
measureId: string
// 创建时间
createTime?: string
// 更新时间
updateTime?: string
// 是否删除
isDeleted: boolean
}
```
## API 接口
~~~~ 1. 获取模型测量关联列表
**接口**: `GET /api/model_measure/list`
**描述**: 获取模型测量关联列表
**请求参数**:
| 参数 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | -------- |
| modelUuid | string | 否 | 模型UUID |
| measureId | string | 否 | 测量ID |
**响应示例**:
```json
{
"success": true,
"data": [
{
"id": "1",
"modelUuid": "model-uuid-1",
"measureId": "1",
"createTime": "2024-10-19 10:00:00",
"updateTime": "2024-10-19 10:00:00",
"isDeleted": false
}
]
}
```
---
~~~~ 2. 添加模型测量关联
**接口**: `POST /api/model_measure/add`
**描述**: 创建模型测量关联
**请求参数**:
| 参数 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | -------- |
| modelUuid | string | 是 | 模型UUID |
| measureId | string | 是 | 测量ID |
**响应示例**:
```json
{
"success": true,
"message": "关联创建成功"
}
```
---
~~~~ 3. 删除模型测量关联
**接口**: `POST /api/model_measure/remove`
**描述**: 删除模型测量关联
**请求参数**:
| 参数 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------ |
| id | string | 是 | 关联ID |
**响应示例**:
```json
{
"success": true,
"message": "关联删除成功"
}
```
---
# 模型属性关联管理
模型属性关联管理提供模型与属性的关联功能。
## 数据类型
~~~~ ModelAttribute
```typescript
interface ModelAttribute {
// 关联ID
id?: string
// 模型UUID
modelUuid: string
// 属性ID
attributeId: string
// 创建时间
createTime?: string
// 更新时间
updateTime?: string
// 是否删除
isDeleted: boolean
}
```
## API 接口
~~~~ 1. 获取模型属性关联列表
**接口**: `GET /api/model_attribute/list`
**描述**: 获取模型属性关联列表
**请求参数**:
| 参数 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | -------- |
| modelUuid | string | 否 | 模型UUID |
| attributeId | string | 否 | 属性ID |
**响应示例**:
```json
{
"success": true,
"data": [
{
"id": "1",
"modelUuid": "model-uuid-1",
"attributeId": "1",
"createTime": "2024-10-19 10:00:00",
"updateTime": "2024-10-19 10:00:00",
"isDeleted": false
}
]
}
```
---
~~~~ 2. 添加模型属性关联
**接口**: `POST /api/model_attribute/add`
**描述**: 创建模型属性关联
**请求参数**:
| 参数 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | -------- |
| modelUuid | string | 是 | 模型UUID |
| attributeId | string | 是 | 属性ID |
**响应示例**:
```json
{
"success": true,
"message": "关联创建成功"
}
```
---
~~~~ 3. 删除模型属性关联
**接口**: `POST /api/model_attribute/remove`
**描述**: 删除模型属性关联
**请求参数**:
| 参数 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------ |
| id | string | 是 | 关联ID |
**响应示例**:
```json
{
"success": true,
"message": "关联删除成功"
}
```
---
# 属性管理
属性管理提供属性的增删改查功能。
## 数据类型
~~~~ Attribute
```typescript
interface Attribute {
// 属性ID
id?: string
// 属性名称
name: string
// 属性类型
type: string
// 默认值
defaultValue?: string
// 创建时间
createTime?: string
// 更新时间
updateTime?: string
// 是否删除
isDeleted: boolean
}
```
## API 接口
~~~~ 1. 获取属性列表
**接口**: `GET /api/attribute/list`
**描述**: 获取属性列表
**请求参数**:
| 参数 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | -------------------- |
| name | string | 否 | 属性名称（模糊查询） |
| type | string | 否 | 属性类型 |
**响应示例**:
```json
{
"success": true,
"data": [
{
"id": "1",
"name": "颜色",
"type": "color",
"defaultValue": "#ffffff",
"createTime": "2024-10-19 10:00:00",
"updateTime": "2024-10-19 10:00:00",
"isDeleted": false
}
]
}
```
---
~~~~ 2. 添加属性
**接口**: `POST /api/attribute/add`
**描述**: 创建属性
**请求参数**:
| 参数 | 类型 | 必填 | 说明 |
| ------------ | ------ | ---- | -------- |
| name | string | 是 | 属性名称 |
| type | string | 是 | 属性类型 |
| defaultValue | string | 否 | 默认值 |
**响应示例**:
```json
{
"success": true,
"message": "属性创建成功"
}
```
---
~~~~ 3. 更新属性
**接口**: `POST /api/attribute/update`
**描述**: 更新属性信息
**请求参数**:
| 参数 | 类型 | 必填 | 说明 |
| ------------ | ------ | ---- | -------- |
| id | string | 是 | 属性ID |
| name | string | 否 | 属性名称 |
| type | string | 否 | 属性类型 |
| defaultValue | string | 否 | 默认值 |
**响应示例**:
```json
{
"success": true,
"message": "属性更新成功"
}
```
---
~~~~ 4. 删除属性
**接口**: `POST /api/attribute/remove`
**描述**: 删除属性
**请求参数**:
| 参数 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------ |
| id | string | 是 | 属性ID |
**响应示例**:
```json
{
"success": true,
"message": "属性删除成功"
}
```
---
# 字典管理
字典管理提供数据字典和字典项的管理功能。
## 数据类型
~~~~ Dictionary
```typescript
interface Dictionary {
// 字典ID
id?: string
// 字典编码
code?: string
// 字典名称
name?: string
// 排序
sort: number
// 创建时间
createTime?: string
// 更新时间
updateTime?: string
// 是否删除
isDeleted: boolean
}
```
~~~~ DictionaryItem
```typescript
interface DictionaryItem {
// 字典项ID
id?: string
// 父字典ID
parentId?: string
// 字典项编码
code?: string
// 字典项名称
name?: string
// 排序
sort: number
// 创建时间
createTime?: string
// 更新时间
updateTime?: string
// 是否删除
isDeleted: boolean
}
```
## API 接口
~~~~ 1. 获取字典列表
**接口**: `GET /api/dictionary/list`
**描述**: 获取所有字典列表
**请求参数**:
| 参数 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | -------------------- |
| name | string | 否 | 字典名称（模糊查询） |
| code | string | 否 | 字典编码 |
**响应示例**:
```json
{
"success": true,
"data": [
{
"id": "1",
"code": "device_type",
"name": "设备类型",
"sort": 1,
"createTime": "2024-10-19 10:00:00",
"updateTime": "2024-10-19 10:00:00",
"isDeleted": false
}
]
}
```
---
~~~~ 2. 获取单个字典
**接口**: `GET /api/dictionary/get/{id}`
**描述**: 获取指定字典详情
**路径参数**:
| 参数 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------ |
| id | string | 是 | 字典ID |
**响应示例**:
```json
{
"success": true,
"data": {
"id": "1",
"code": "device_type",
"name": "设备类型",
"sort": 1,
"createTime": "2024-10-19 10:00:00",
"updateTime": "2024-10-19 10:00:00",
"isDeleted": false
}
}
```
---
~~~~ 3. 添加字典
**接口**: `POST /api/dictionary/add`
**描述**: 创建字典
**请求参数**:
| 参数 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | -------- |
| code | string | 是 | 字典编码 |
| name | string | 是 | 字典名称 |
| sort | number | 是 | 排序 |
**响应示例**:
```json
{
"success": true,
"message": "字典创建成功"
}
```
---
~~~~ 4. 更新字典
**接口**: `POST /api/dictionary/update`
**描述**: 更新字典信息
**请求参数**:
| 参数 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | -------- |
| id | string | 是 | 字典ID |
| code | string | 否 | 字典编码 |
| name | string | 否 | 字典名称 |
| sort | number | 否 | 排序 |
**响应示例**:
```json
{
"success": true,
"message": "字典更新成功"
}
```
---
~~~~ 5. 删除字典
**接口**: `POST /api/dictionary/remove/{id}`
**描述**: 删除字典
**路径参数**:
| 参数 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------ |
| id | string | 是 | 字典ID |
**响应示例**:
```json
{
"success": true,
"message": "字典删除成功"
}
```
---
~~~~ 6. 获取字典项列表
**接口**: `GET /api/dictionary/items/{code}`
**描述**: 获取指定字典的字典项列表
**路径参数**:
| 参数 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | -------- |
| code | string | 是 | 字典编码 |
**响应示例**:
```json
{
"success": true,
"data": [
{
"id": "1",
"parentId": "1",
"code": "sensor",
"name": "传感器",
"sort": 1,
"createTime": "2024-10-19 10:00:00",
"updateTime": "2024-10-19 10:00:00",
"isDeleted": false
}
]
}
```
---
~~~~ 7. 添加字典项
**接口**: `POST /api/dictionary/addItem`
**描述**: 创建字典项
**请求参数**:
| 参数 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ---------- |
| parentId | string | 是 | 父字典ID |
| code | string | 是 | 字典项编码 |
| name | string | 是 | 字典项名称 |
| sort | number | 是 | 排序 |
**响应示例**:
```json
{
"success": true,
"message": "字典项创建成功"
}
```
---
~~~~ 8. 更新字典项
**接口**: `POST /api/dictionary/updateItem`
**描述**: 更新字典项信息
**请求参数**:
| 参数 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ---------- |
| id | string | 是 | 字典项ID |
| parentId | string | 否 | 父字典ID |
| code | string | 否 | 字典项编码 |
| name | string | 否 | 字典项名称 |
| sort | number | 否 | 排序 |
**响应示例**:
```json
{
"success": true,
"message": "字典项更新成功"
}
```
---
~~~~ 9. 删除字典项
**接口**: `POST /api/dictionary/removeItem/{id}`
**描述**: 删除字典项
**路径参数**:
| 参数 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | -------- |
| id | string | 是 | 字典项ID |
**响应示例**:
```json
{
"success": true,
"message": "字典项删除成功"
}
```
---
# 站点管理
站点管理提供站点的增删改查功能。
## 数据类型
~~~~ Station
```typescript
interface Station {
// 站点ID
id?: string
// 站点名称
name: string
// 站点描述
description?: string
// 创建时间
createTime?: string
// 更新时间
updateTime?: string
// 是否删除
isDeleted: boolean
}
```
## API 接口
~~~~ 1. 获取站点列表
**接口**: `GET /api/station/list`
**描述**: 获取所有站点列表
**请求参数**:
| 参数 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | -------------------- |
| name | string | 否 | 站点名称（模糊查询） |
**响应示例**:
```json
{
"success": true,
"data": [
{
"id": "1",
"name": "第一场站",
"description": "主要生产场站",
"createTime": "2024-10-19 10:00:00",
"updateTime": "2024-10-19 10:00:00",
"isDeleted": false
}
]
}
```
---
~~~~ 2. 添加站点
**接口**: `POST /api/station/add`
**描述**: 创建站点
**请求参数**:
| 参数 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | -------- |
| name | string | 是 | 站点名称 |
| description | string | 否 | 站点描述 |
**响应示例**:
```json
{
"success": true,
"message": "站点创建成功"
}
```
---
~~~~ 3. 更新站点
**接口**: `POST /api/station/update`
**描述**: 更新站点信息
**请求参数**:
| 参数 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | -------- |
| id | string | 是 | 站点ID |
| name | string | 否 | 站点名称 |
| description | string | 否 | 站点描述 |
**响应示例**:
```json
{
"success": true,
"message": "站点更新成功"
}
```
---
~~~~ 4. 删除站点
**接口**: `POST /api/station/remove`
**描述**: 删除站点
**请求参数**:
| 参数 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------ |
| id | string | 是 | 站点ID |
**响应示例**:
```json
{
"success": true,
"message": "站点删除成功"
}
```
本文由人工编写，AI优化，转载请注明原文地址： Shadow Editor Pro 业务数据接口
推荐阅读
评论 (0)
发表评论
昵称：加载中...
暂无评论，快来发表第一条评论吧！