# 表单事件接口说明

表单可以绑定触发事件服务,用来拓展表单逻辑。

触发事件包括三种,分别是:新增数据、修改数据、删除数据。表单进行三种操作时,会触发绑定的触发事件。

本文档是三种触发事件的接口说明。

# 新增事件

新建触发事件接口。

  • 请求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数组 新建服务实体数组

  • 错误编码

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

# 修改事件

保存低开数据模型,可根据是否还有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数组 删除的服务实体数组
  • 错误编码

    错误编码请参见新建事件错误编码。

上次更新: 2023/7/20下午12:25:28