系统图标接口文档 - 标签：接口文档

# 系统图标接口

Base URLs:

# 认证

- HTTP Authentication, scheme: bearer

# 系统图标库

##  查询系统图标列表

POST /orbit/app/sysIcon/queryList

## 接口描述

根据sysIconType获取系统图标列表，若`sysIconType`为空，则获取所有系统图标列表
返回的data为`SysIconVo`数组，`SysIconVo`为系统图标返回实体类，包含`sysIconId、sysIconName、sysIconNo、sysIconType、data`等字段
其中data字段为**base64**编码的图片数据，可直接用于前端展示
其中`sysIconType`为系统图标类型

> 系统图标类型
> 1. 菜单组
> 2. 菜单项
> 3. 按钮
> 4. 消息卡片

在保存时到具体的业务表中，只需要保存sysIconId即可，不需要保存data字段

> 说明

**系统图标中有部分图标的格式为svg,在此接口中后台会统一转换成png格式，因此返回的data字段依旧为base64编码的图片数据，但是图片格式为png**

> Body 请求参数

```json
{
  "sysIconType": 3
}
```

### 请求参数

| 名称           | 位置 | 类型    | 必选 | 中文名       | 说明 |
| -------------- | ---- | ------- | ---- | ------------ | ---- |
| body           | body | object  | 否   |              | none |
| » sysIconType | body | integer | 否   | 系统图标类型 |  不填则获取所有系统图标列表 |

> 返回示例

> 200 Response

```json
{
  "code": 0,
  "message": "string",
  "data": [
    {
      "sysIconId": "21323123213132",
      "sysIconName": "图标demo",
      "sysIconNo": "ICON10239",
      "sysIconType": 1,
      "data": "base64:image/png;data"
    }
  ]
}
```

### 返回数据结构

状态码 **200**

| 名称             | 类型         | 必选 | 约束 | 中文名 | 说明 |
| ---------------- | ------------ | ---- | ---- | ------ | ---- |
| » code          | integer      | true | none |        | none |
| » message       | string       | true | none |        | none |
| » data          | [object]     | true | none |        | none |
| »» sysIconId   | string       | true | none |        |  系统图标ID |
| »» sysIconName | string       | true | none |        | 系统图标名称 |
| »» sysIconNo   | string       | true | none |        | 系统图标编号 |
| »» sysIconType | integer      | true | none |        | 系统图标类型 |
| »» data        | string¦null | true | none |        | base64编码的图片数据 |

## 通过sysIconId获取系统图标

POST /orbit/app/sysIcon/queryById

> Body 请求参数

```json
{
  "sysIconId": "410254135665885184"
}
```

### 请求参数

| 名称         | 位置 | 类型   | 必选 | 中文名     | 说明 |
| ------------ | ---- | ------ | ---- | ---------- | ---- |
| body         | body | object | 否   |            | none |
| » sysIconId | body | string | 是   | 系统图标ID | 此处为系统图标ID |

> 返回示例

> 200 Response

```json
{
  "code": 0,
  "message": "string",
  "data": {
      "sysIconId": "21323123213132",
      "sysIconName": "图标demo",
      "sysIconNo": "ICON10239",
      "sysIconType": 1,
      "data": "base64:image/png;data"
    }
}
```

### 返回数据结构

状态码 **200**

| 名称             | 类型         | 必选 | 约束 | 中文名 | 说明 |
| ---------------- | ------------ | ---- | ---- | ------ | ---- |
| » code          | integer      | true | none |        | none |
| » message       | string       | true | none |        | none |
| » data          | [object]     | true | none |        | none |
| »» sysIconId   | string       | true | none |        | 系统图标ID |
| »» sysIconName | string       | true | none |        | 系统图标名称 |
| »» sysIconNo   | string       | true | none |        | 系统图标编号 |
| »» sysIconType | integer      | true | none |        | 系统图标类型 |
| »» data        | string¦null | true | none |        | base64编码的图片数据 |