系统视图设置
系统中关于项目视图的管理
GET 项目视图列表
GET /admin/tx/project/view/model/list
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| enable | query | string | 是 | 可用该参数查询启用的视图 1 |
| viewModelId | query | string | 是 | 可用该参数查询视图详情,理论上list里只有1个 |
| Authorization | header | string | 是 | none |
返回示例
json
{
"code": 0,
"msg": null,
"data": [
{
"viewModelId": "960632ea-80d4-46f7-b565-8330766b48dd",
"createBy": "admin",
"enable": 1,
"name": "视图名称",
"describe": null,
"type": 2,
"fieldsList": [
"f30cc46e58f15913b618a79f28d17adf"
]
}
],
"ok": true
}返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » code | integer | true | none | none | |
| » msg | null | true | none | none | |
| » data | [object] | true | none | none | |
| »» viewModelId | string | false | none | none | |
| »» createBy | string | false | none | none | |
| »» enable | integer | false | none | none | |
| »» name | string | false | none | none | |
| »» describe | null | false | none | none | |
| »» type | integer | false | none | none | |
| »» fieldsList | [string] | false | none | none | |
| » ok | boolean | true | none | none |
POST 项目视图新增
POST /admin/tx/project/view/model/add
Body 请求参数
json
{
"name": "string",
"describe": "string",
"fieldsIds": "string"
}请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| Authorization | header | string | 是 | none |
| body | body | object | 否 | none |
| » name | body | string | 是 | 视图名称 |
| » describe | body | string | 否 | 描述 |
| » fieldsIds | body | string | 是 | 对应字段 |
返回示例
json
{
"code": 0,
"msg": null,
"data": {
"id": "5ae746916599b12a89861530e0760f44",
"name": "城市",
"describe": "描述",
"type": 1,
"createBy": "admin",
"createTime": "2024-09-20 16:19:35",
"updateBy": "admin",
"updateTime": "2024-09-20 16:19:35",
"delFlag": "0",
"tenantId": null,
"classify": null,
"enable": 1,
"fieldValue": "[{'asdas':'asdasd'}]",
"condition": "[{'vvvv':'vvv'}]"
},
"ok": true
}返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » code | integer | true | none | none | |
| » msg | null | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | none | |
| »» name | string | true | none | 字段名 | |
| »» describe | string | true | none | 字段备注 | |
| »» type | integer | true | none | 字段类型1单行文本 2多行文本 3单选下拉 4人名输入框 5日期 6数值 | |
| »» createBy | string | true | none | none | |
| »» createTime | string | true | none | none | |
| »» updateBy | string | true | none | none | |
| »» updateTime | string | true | none | none | |
| »» delFlag | string | true | none | none | |
| »» tenantId | null | true | none | none | |
| »» classify | null | true | none | 字段分类 1系统字段 2 自定义字段 | |
| »» enable | integer | true | none | 是否启用 1启动 0不启用 | |
| »» fieldValue | string | true | none | 初始值(JSON格式) | |
| »» condition | string | true | none | 条件(例如仅为整数等等,格式前端组织,JSON格式) | |
| » ok | boolean | true | none | none |
PUT 项目视图编辑
PUT /admin/tx/project/view/model/update
Body 请求参数
json
{
"name": "string",
"describe": "string",
"fieldsIds": "string",
"viewModelId": "string"
}请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| Authorization | header | string | 是 | none |
| body | body | object | 否 | none |
| » name | body | string | 是 | none |
| » describe | body | string | 否 | none |
| » fieldsIds | body | string | 是 | none |
| » viewModelId | body | string | 是 | none |
返回示例
json
{
"code": 0,
"msg": null,
"data": {
"id": "5ae746916599b12a89861530e0760f44",
"name": "城市",
"describe": "描述",
"type": 1,
"createBy": "admin",
"createTime": "2024-09-20 16:19:35",
"updateBy": "admin",
"updateTime": "2024-09-20 16:19:35",
"delFlag": "0",
"tenantId": null,
"classify": null,
"enable": 1,
"fieldValue": "[{'asdas':'asdasd'}]",
"condition": "[{'vvvv':'vvv'}]"
},
"ok": true
}返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » code | integer | true | none | none | |
| » msg | null | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | none | |
| »» name | string | true | none | 字段名 | |
| »» describe | string | true | none | 字段备注 | |
| »» type | integer | true | none | 字段类型1单行文本 2多行文本 3单选下拉 4人名输入框 5日期 6数值 | |
| »» createBy | string | true | none | none | |
| »» createTime | string | true | none | none | |
| »» updateBy | string | true | none | none | |
| »» updateTime | string | true | none | none | |
| »» delFlag | string | true | none | none | |
| »» tenantId | null | true | none | none | |
| »» classify | null | true | none | 字段分类 1系统字段 2 自定义字段 | |
| »» enable | integer | true | none | 是否启用 1启动 0不启用 | |
| »» fieldValue | string | true | none | 初始值(JSON格式) | |
| »» condition | string | true | none | 条件(例如仅为整数等等,格式前端组织,JSON格式) | |
| » ok | boolean | true | none | none |
PUT 项目视图启用/禁用
PUT /admin/tx/project/view/model/updateEnable
Body 请求参数
json
{
"enable": 0,
"viewModelId": "string"
}请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| Authorization | header | string | 是 | none |
| body | body | object | 否 | none |
| » enable | body | integer | 是 | none |
| » viewModelId | body | string | 是 | none |
返回示例
200 Response
json
{
"code": 0,
"msg": null,
"data": {
"id": "string",
"name": "string",
"describe": "string",
"type": 0,
"createBy": "string",
"createTime": "string",
"updateBy": "string",
"updateTime": "string",
"delFlag": "string",
"tenantId": null,
"classify": null,
"enable": 0,
"fieldValue": "string",
"condition": "string"
},
"ok": true
}返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » code | integer | true | none | none | |
| » msg | null | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | none | |
| »» name | string | true | none | 字段名 | |
| »» describe | string | true | none | 字段备注 | |
| »» type | integer | true | none | 字段类型1单行文本 2多行文本 3单选下拉 4人名输入框 5日期 6数值 | |
| »» createBy | string | true | none | none | |
| »» createTime | string | true | none | none | |
| »» updateBy | string | true | none | none | |
| »» updateTime | string | true | none | none | |
| »» delFlag | string | true | none | none | |
| »» tenantId | null | true | none | none | |
| »» classify | null | true | none | 字段分类 1系统字段 2 自定义字段 | |
| »» enable | integer | true | none | 是否启用 1启动 0不启用 | |
| »» fieldValue | string | true | none | 初始值(JSON格式) | |
| »» condition | string | true | none | 条件(例如仅为整数等等,格式前端组织,JSON格式) | |
| » ok | boolean | true | none | none |
GET 视图模式树结构
GET /admin/tx/project/treeByViewModel
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| viewModelId | query | string | 是 | 视图ID |
| Authorization | header | string | 是 | none |
返回示例
json
{
"code": 0,
"msg": null,
"data": [
{
"fieldsValue": "2024",
"fieldsId": "f30cc46e58f15913b618a79f28d17adf",
"children": [],
"fieldsType": 3,
"isShow": true
}
],
"ok": true
}返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » code | integer | true | none | none | |
| » msg | null | true | none | none | |
| » data | [object] | true | none | none | |
| »» fieldsValue | string | false | none | none | |
| »» fieldsId | string | false | none | none | |
| »» children | [string] | false | none | none | |
| »» fieldsType | integer | false | none | none | |
| »» isShow | boolean | false | none | none | |
| » ok | boolean | true | none | none |