表单通用逻辑接口说明

表单用来使数据展示与页面上，对数据进行增删改查的操作。

本文档说明表单通用逻辑接口。

分页查询数据模型

通用分页查询数据接口。

• 请求URL

  /api/lowcode/models/actions/query-with-page

• 请求方式

  POST

• Content-Type

  application/json;charset=UTF-8

• 入参

  参数名	数据类型	参数类型	是否必选	说明
  datasourceName	String	QUERY参数	是	数据源
  entityName	String	QUERY参数	是	模型实体名称
  condition	QueryConditionModel对象	BODY参数	是	查询条件
  cascadeDeep	int	QUERY参数	否	级联深度，-1，无限级联；0，不做级联；1，只级联一级...；默认是0
  cascadeDeepConditionMaps	Map<String, QueryConditionModel>	BODY参数	否	级联子查询的条件：<属性名称，查询条件集合>
  pageIndex	int	QUERY参数	否	分页参数，默认是0
  pageSize	int	QUERY参数	否	分页参数，默认是10

  • QueryConditionModel对象示例：

      {
        "and": {
          "items": [
            {
              "maxValue": {},
              "minValue": {},
              "not": true,
              "op": "string",
              "propertyName": "string",
              "propertyValue": {}
            }
          ]
        },
        "andOr": [
          {
            "items": [
              {
                "maxValue": {},
                "minValue": {},
                "not": true,
                "op": "string",
                "propertyName": "string",
                "propertyValue": {}
              }
            ]
          }
        ],
        "expandConfigs": [
          {
            "childPropertyNames": "string",
            "dictTypeCode": "string",
            "propertyNames": "string",
            "refEntityName": "string",
            "refEntityPropertyExcludes": "string",
            "refEntityPropertyIncludes": "string",
            "refPropertyName": "string"
          }
        ],
        "or": {
          "items": [
            {
              "maxValue": {},
              "minValue": {},
              "not": true,
              "op": "string",
              "propertyName": "string",
              "propertyValue": {}
            }
          ]
        },
        "orAnd": [
          {
            "items": [
              {
                "maxValue": {},
                "minValue": {},
                "not": true,
                "op": "string",
                "propertyName": "string",
                "propertyValue": {}
              }
            ]
          }
        ],
        "orderPropertyNames": "string"
      }
  

• 出参

  参数名	数据类型	说明
  PageResultList<DataObject>	分页对象	分页对象，包括总条数

  • 分页对象数据结构示例

     {
      "data":[{服务实体对象1},{服务实体对象2}],
      "total":"总条数"
     }
  

• 错误编码

  错误编码	描述	语义
  400	Bad Request	客户端请求语法错误
  403	Forbidden	拒绝访问
  401	Unauthorized	无效身份信息，未登录
  404	Not Found	无效地址
  500	Internal Server Error	服务器内部错误
  200	Ok	请求成功

获取数据模型

通用根据ID获取数据信息接口。

• 请求URL

  /api/lowcode/models/{id}

• 请求方式

  GET

• Content-Type

  application/json;charset=UTF-8

• 入参

  参数名	数据类型	参数类型	是否必选	说明
  datasourceName	String	QUERY参数	是	数据源
  entityName	String	QUERY参数	是	模型实体名称
  id	String	QUERY参数	是	服务实体数据模型ID
  cascadeDeep	int	QUERY参数	否	级联深度，-1，无限级联；0，不做级联；1，只级联一级...；默认是0

• 出参

  参数名	数据类型	说明
  DataObject	DataObject	服务实体对应的DataObject

• 错误编码

  错误编码请参见分页查询数据模型。

获取数据模型详情

通用根据ID获取数据详情接口。

• 请求URL

  /api/lowcode/models/{id}/details

• 请求方式

  POST

• Content-Type

  application/json;charset=UTF-8

• 入参

  参数名	数据类型	参数类型	是否必选	说明
  datasourceName	String	QUERY参数	是	数据源
  entityName	String	QUERY参数	是	模型实体名称
  id	String	URL参数	是	服务实体数据模型ID
  expandConfigs	ExpandConfigItem数组	BODY参数	否	属性扩充配置
  cascadeDeep	int	QUERY参数	否	级联深度，-1，无限级联；0，不做级联；1，只级联一级...；默认是0
  cascadeDeepConditionMaps	Map<String, QueryConditionModel>	BODY参数	否	级联子查询的条件：<属性名称，查询条件>集合

  • 属性扩充配置结构示例：

      [
        {
          "childPropertyNames": "string",
          "dictTypeCode": "string",
          "propertyNames": "string",
          "refEntityName": "string",
          "refEntityPropertyExcludes": "string",
          "refEntityPropertyIncludes": "string",
          "refPropertyName": "string"
        }
      ]
  

• 出参

  参数名	数据类型	说明
  DataObject	DataObject	服务实体对应的DataObject

• 错误编码

  错误编码请参见分页查询数据模型。

创建数据模型

通用创建数据接口。

• 请求URL

  /api/lowcode/models

• 请求方式

  POST

• Content-Type

  application/json;charset=UTF-8

• 入参

  参数名	数据类型	参数类型	是否必选	说明
  datasourceName	String	QUERY参数	是	数据源
  entityName	String	QUERY参数	是	模型实体名称
  formCode	String	QUERY参数	是	表单资源code
  models	List<Map>	BODY参数	是	数据模型信息数组
  cascadeDeep	int	QUERY参数	否	级联深度，-1，无限级联；0，不做级联；1，只级联一级...；默认是0
  returnIncludeInfo	boolean	QUERY参数	否	返回值是否包含模型信息，默认true

  • 数据模型结构示例：

      [
        {
          "property1": {},
          "property2": {},
          "property3": {}
        }
      ]
  

• 出参

  参数名	数据类型	说明
  DataObject	DataObject数组	新建服务实体数组

• 错误编码

  错误编码请参见分页查询数据模型。

克隆数据模型

通用创建数据接口。

• 请求URL

  /api/lowcode/models/{id}/clone

• 请求方式

  POST

• Content-Type

  application/json;charset=UTF-8

• 入参

  参数名	数据类型	参数类型	是否必选	说明
  datasourceName	String	QUERY参数	是	数据源
  entityName	String	QUERY参数	是	模型实体名称
  id	String	URL参数	是	低开数据模型ID
  models	List<Map>	BODY参数	是	数据模型信息数组
  cascadeDeep	int	QUERY参数	否	级联深度，-1，无限级联；0，不做级联；1，只级联一级...；默认是0

  • 数据模型结构示例：

      [
        {
          "property1": {},
          "property2": {},
          "property3": {}
        }
      ]
  

• 出参

  参数名	数据类型	说明
  DataObject	DataObject	克隆的服务实体对应的DataObject

• 错误编码

  错误编码请参见分页查询数据模型。

更新数据模型

通用更新数据接口。

• 请求URL

  /api/lowcode/models

• 请求方式

  PUT

• Content-Type

  application/json;charset=UTF-8

• 入参

  参数名	数据类型	参数类型	是否必选	说明
  datasourceName	String	QUERY参数	是	数据源
  entityName	String	QUERY参数	是	模型实体名称
  formCode	String	QUERY参数	是	表单资源code
  models	List<Map>	BODY参数	是	数据模型信息数组
  cascadeDeep	int	QUERY参数	否	级联深度，-1，无限级联；0，不做级联；1，只级联一级...；默认是0
  partUpdate	boolean	QUERY参数	否	是否部分更新（属性不为null才更新），默认false
  returnIncludeInfo	boolean	QUERY参数	否	返回值是否包含模型信息，默认true

  • 数据模型结构示例：

      [
        {
          "property1": {},
          "property2": {},
          "property3": {}
        }
      ]
  

• 出参

  参数名	数据类型	说明
  DataObject	DataObject数组	修改服务实体数组

• 错误编码

  错误编码请参见分页查询数据模型。

保存数据模型

通用保存低开数据模型，可根据是否还有ID，做新增修改操作。如果数据信息没有ID，新增数据，含有ID，更新数据。

• 请求URL

  /api/lowcode/models/actions/save

• 请求方式

  PUT

• Content-Type

  application/json;charset=UTF-8

• 入参

  参数名	数据类型	参数类型	是否必选	说明
  datasourceName	String	QUERY参数	是	数据源
  entityName	String	QUERY参数	是	模型实体名称
  formCode	String	QUERY参数	是	表单资源code
  models	List<Map>	BODY参数	是	数据模型信息数组
  cascadeDeep	int	QUERY参数	否	级联深度，-1，无限级联；0，不做级联；1，只级联一级...；默认是0
  partUpdate	boolean	QUERY参数	否	是否部分更新（属性不为null才更新），默认false
  returnIncludeInfo	boolean	QUERY参数	否	返回值是否包含模型信息，默认true

  • 数据模型结构示例：

        [
          {
            "property1": {},
            "property2": {},
            "property3": {}
          }
        ]
    

• 出参

  参数名	数据类型	说明
  DataObject	DataObject数组	服务实体数组

• 错误编码

  错误编码请参见分页查询数据模型。

删除数据模型

删除服务实体数据模型数据接口。

• 请求URL

  /api/lowcode/models

• 请求方式

  DELETE

• Content-Type

  application/json;charset=UTF-8

• 入参

  参数名	数据类型	参数类型	是否必选	说明
  datasourceName	String	QUERY参数	是	数据源
  entityName	String	QUERY参数	是	模型实体名称
  formCode	String	QUERY参数	是	表单资源code
  ids	Object	BODY参数	是	低开数据模型ID，或者逗号分隔，或者数组
  cascadeDeep	int	QUERY参数	否	级联深度，-1，无限级联；0，不做级联；1，只级联一级...；默认是0
  returnIncludeInfo	boolean	QUERY参数	否	返回值是否包含模型信息，默认true

• 出参

  参数名	数据类型	说明
  DataObject	DataObject数组	删除的服务实体数组

• 错误编码

  错误编码请参见分页查询数据模型。

根据条件校验是否存在

通用校验数据是否存在

• 请求URL

  /api/lowcode/models/exist

• 请求方式

  POST

• Content-Type

  application/json;charset=UTF-8

• 入参

  参数名	数据类型	参数类型	是否必选	说明
  datasourceName	String	QUERY参数	是	数据源
  entityName	String	QUERY参数	是	模型实体名称
  pkMap	Map<String, Object>	BODY参数	是	主键key-value
  condition	QueryConditionModel	BODY参数	是	低开数据模型ID，或者逗号分隔，或者数组
  cascadeDeep	int	QUERY参数	否	查询条件

  • 查询条件结构示例：

    查询条件结构示例请参见条件查询的示例。

• 出参

  参数名	数据类型	说明
  boolean	boolean	是否存在，true存在，false不存在

• 错误编码

  错误编码请参见分页查询数据模型。

获取附件

通用获取附件信息

• 请求URL

  /api/lowcode/models/attachments/{attachmentId}

• 请求方式

  GET

• Content-Type

  application/json;charset=UTF-8

• 入参

  参数名	数据类型	参数类型	是否必选	说明
  attachmentId	String	URL参数	是	附件ID

• 出参

  参数名	数据类型	说明
  FileStore	FileStore	附件信息

  • FileStore结构示例：

      {
        "appName": "string",
        "createTime": "2022-12-01T08:00:35.324Z",
        "createUser": "string",
        "delFlag": "string",
        "extend": "string",
        "fileGroup": "string",
        "fileId": "string",
        "fileName": "string",
        "fileSize": 0,
        "fileType": "string",
        "fileUrl": "string",
        "md5": "string",
        "refId": "string",
        "refType": "string",
        "status": "string",
        "storeType": "string",
        "updateTime": "2022-12-01T08:00:35.324Z",
        "updateUser": "string"
      }
  

• 错误编码

  错误编码请参见分页查询数据模型。

上传附件

通用上传附件接口

• 请求URL

  /api/lowcode/models/attachments/actions/upload

• 请求方式

  POST

• Content-Type

  multipart/form-data

• 入参

  参数名	数据类型	参数类型	是否必选	说明
  entityName	String	QUERY参数	否	模型实体名称
  entityName	String	QUERY参数	否	实体ID
  attachments	List<MultipartFile>	QUERY参数	是	附件，支持多个附件

• 出参

  参数名	数据类型	说明
  FileStore	List<FileStore>	附件信息

  • FileStore结构示例：

    请参见获取附件FileStore结构示例。

• 错误编码

  错误编码请参见分页查询数据模型。

下载附件

通用下载附件接口

• 请求URL

  /api/lowcode/models/attachments/{attachmentId}/actions/download

• 请求方式

  GET

• Content-Type

  application/json

• 入参

  参数名	数据类型	参数类型	是否必选	说明
  attachmentId	String	URL参数	是	附件ID

• 出参

  无

• 错误编码

  错误编码请参见分页查询数据模型。

预览附件

通用预览附件接口

• 请求URL

  /api/lowcode/models/attachments/{attachmentId}/actions/preview

• 请求方式

  GET

• Content-Type

  application/json

• 入参

  参数名	数据类型	参数类型	是否必选	说明
  attachmentId	String	URL参数	是	附件ID

• 出参

  无

• 错误编码

  错误编码请参见分页查询数据模型。

获取附件文本内容

通用获取附件文本内容接口。

• 请求URL

  /api/lowcode/models/attachments/{attachmentId}/actions/content

• 请求方式

  GET

• Content-Type

  application/json

• 入参

  参数名	数据类型	参数类型	是否必选	说明
  attachmentId	String	URL参数	是	附件ID
  encoding	String	QUERY参数	是	编码，默认UTF-8

• 出参

  参数名	数据类型	说明
  String	String	附件文本内容

• 错误编码

  错误编码请参见分页查询数据模型。

删除附件

通用获取附件文本内容接口。

• 请求URL

  /api/lowcode/models/attachments/{attachmentId}

• 请求方式

  DELETE

• Content-Type

  application/json

• 入参

  参数名	数据类型	参数类型	是否必选	说明
  attachmentId	String	URL参数	是	附件ID

• 出参

  参数名	数据类型	说明
  FileStore	FileStore	附件信息

  • FileStore附件信息结构参考：

    请参见获取附件FileStore结构示例

• 错误编码

  错误编码请参见分页查询数据模型。