帮助中心

# 表单OpenAPI

# 1.1 根据id获取表单实例数据

功能描述 获取指定表单的某一条表单实例数据。

请求说明

请求方式：GET

请求URL ：https://qiqiao.do1.com.cn/plus/cgi-bin/open/applications/{applicationId}/forms/{formModelId}/{id}

请求参数

参数 必须 数据类型 说明
applicationId 是 string 应用id
formModelId 是 string 表单模型Id
id 是 string 表单实例Id

返回结果

{
    "msg": "执行成功",
    "traceId": null,
    "code": 0,
    "data": {
        "applicationId": "a0c18dae676548668615b0d2451729f2",
        "author": "779c3d9ced0f28cad0ca97ad1987204d",
        "authorName": "张三",
        "createDate": 1661394859000,
        "formDefinitionId": "ab30077273bd4207acc627a76d884d54",
        "id": "6793650729174859777",
        "lastModifierName": "张三",
        "lastModifyDate": 1661394859000,
        "variables": {
            "fieldName": "fieldValue",
            "age": "22",
            "多项选择1": [
                "1",
                "2"
            ]
        },
        //返回友好值字段
        "realValue": {
            "多项选择1": "选项一,选项二"
        },
        "version": 1
    }
}

返回参数

参考表单数据对象结构说明

# 1.2 获取子表实例数据

功能描述 获取指定主表数据实例下所有子表的表单实例数据。

请求说明

请求方式：GET

请求URL ：https://qiqiao.do1.com.cn/plus/cgi-bin/open/applications/{applicationId}/forms/{parentId}/{parentFieldName}/{subFormModelId}

请求参数

参数 必须 数据类型 说明
applicationId 是 string 应用id
parentId 是 string 主表单实例Id
parentFieldName 是 string 关联主表的外键字段名
subFormModelId 是 string 子表单模型Id
startTime 否 Long 上次更新时间（查询开始时间）
endTime 否 Long 上次更新时间（查询结束时间）
orderField 否 String 排序字段（默认为createDate）
isAsc 否 bool 是否升序（默认是false-降序）

返回结果

[{
    "variables":{
        "fieldName": "fieldValue",
        "age": "22"
    },
    "id": "0141c3223a6e4d9dbd7c4f605fd0fb48",
    "version": 1,
    "formTitle": "xxx表单",
    "processInstanceId": "355cfccf9bc63ce4282c0c437b71fdfb",
    "processDefinitionId": "355cfccf9bc63ce4282c0c437b71fdfb",
    "formDefinitionId": "105cfccf9bc63ce6a82c0c437b41fd3c",
    "taskId": "64c761a7fb7f4847992466ee76efc195",
    "author": "a08bcb7e67a84cb08348884688aacd02",
    "authorName": "张三",
    "createDate": 12324123123,
    "lastModifyDate": 12312312312,
    "lastModifier": "a08bcb7e67a84cb08348884688aacd02",
    "lastModifierName": "张三",
    "applicationId": "f58bcb7e67a84c458348884688aacd7f"
}]

返回参数

参考表单数据对象结构说明

# 1.3 根据过滤条件获取子表实例数据

功能描述 可根据过滤条件获取指定主表数据实例下子表的部分或全部表单实例数据。 注：返回结果中包含友好值字段。

请求说明

请求方式：POST

请求URL ：https://qiqiao.do1.com.cn/plus/cgi-bin/open/applications/{applicationId}/forms/parent_documents/{parentDocumentId}/sub_form_foreign_field_names/{subFormForeignFieldName}/sub_form_models/{subFormModelId}

请求参数

参数 必须 数据类型 说明
applicationId 是 string 应用id
parentId 是 string 主表单实例Id
parentFieldName 是 string 关联主表的外键字段名
subFormModelId 是 string 子表单模型Id
startTime 否 Long 上次更新时间（查询开始时间）
endTime 否 Long 上次更新时间（查询结束时间）
orderField 否 String 排序字段（默认为createDate）
isAsc 否 bool 是否升序（默认是false-降序）

请求包体

[
    //过滤条件用json数组表示
    {"fieldName":"fieldName", "logic": "logic", "value":"value"},
 		{"fieldName":"数字1", "logic": "eq", "value":"1"}
]

请求包体说明

参数 必须 数据类型 说明
fieldName 否 string 表单字段名称
logic 否 string 逻辑符
value 否 string 值

逻辑符规则

参考逻辑符规则

返回结果

[{
    "variables":{
        "fieldName": "fieldValue",
        "age": "22",
        "多项选择1": [
                "1",
                "2"
        ]
    },
     //返回友好值字段
    "realValue": {
        "多项选择1": "选项一,选项二"
    },
    "id": "0141c3223a6e4d9dbd7c4f605fd0fb48",
    "version": 1,
    "formTitle": "xxx表单",
    "processInstanceId": "355cfccf9bc63ce4282c0c437b71fdfb",
    "processDefinitionId": "355cfccf9bc63ce4282c0c437b71fdfb",
    "formDefinitionId": "105cfccf9bc63ce6a82c0c437b41fd3c",
    "taskId": "64c761a7fb7f4847992466ee76efc195",
    "author": "a08bcb7e67a84cb08348884688aacd02",
    "authorName": "张三",
    "createDate": 12324123123,
    "lastModifyDate": 12312312312,
    "lastModifier": "a08bcb7e67a84cb08348884688aacd02",
    "lastModifierName": "张三",
    "applicationId": "f58bcb7e67a84c458348884688aacd7f"
}]

返回参数

参考表单数据对象结构说明

# 1.4 获取指定表单的分页数据

功能描述 获取指定表单的分页数据（不含子表单数据）。

请求说明

请求方式：GET

请求URL ：https://qiqiao.do1.com.cn/plus/cgi-bin/open/applications/{applicationId}/forms/{formModelId}

请求参数

参数 必须 数据类型 说明
applicationId 是 string 应用id
formModelId 是 string 表单模型Id
startTime 否 Long 上次更新时间（查询开始时间）
endTime 否 Long 上次更新时间（查询结束时间）
orderField 否 String 排序字段（默认为createDate）
isAsc 否 bool 是否升序（默认是false-降序）
page 否 int 当前页（默认为1）
pageSize 否 int 每页条数（默认为10）

返回结果

{
   "list"[{
    "variables":{
        "fieldName": "fieldValue",
        "age": "22"
    },
    "id": "0141c3223a6e4d9dbd7c4f605fd0fb48",
    "version": 1,
    "formTitle": "xxx表单",
    "processInstanceId": "355cfccf9bc63ce4282c0c437b71fdfb",
    "processDefinitionId": "355cfccf9bc63ce4282c0c437b71fdfb",
    "formDefinitionId": "105cfccf9bc63ce6a82c0c437b41fd3c",
    "taskId": "64c761a7fb7f4847992466ee76efc195",
    "author": "a08bcb7e67a84cb08348884688aacd02",
    "authorName": "张三",
    "createDate": 12324123123,
    "lastModifyDate": 12312312312,
    "lastModifier": "a08bcb7e67a84cb08348884688aacd02",
    "lastModifierName": "张三",
    "applicationId": "f58bcb7e67a84c458348884688aacd7f"
    }],
   "page": 1,
   "pageSize": 10,
   "total": 20
}

返回参数

参考表单数据对象结构说明

# 1.5 根据过滤条件获取指定表单的分页数据

功能描述 可根据过滤条件获取指定表单的部分或全部分页数据。 注：返回结果中包含友好值字段。

请求说明

请求方式：POST

请求URL ：https://qiqiao.do1.com.cn/plus/cgi-bin/open/applications/{applicationId}/forms/{formModelId}/query

请求参数

参数 必须 数据类型 说明
applicationId 是 string 应用id
formModelId 是 string 表单模型Id
startTime 否 Long 上次更新时间（查询开始时间）
endTime 否 Long 上次更新时间（查询结束时间）
orderField 否 String 排序字段（默认为createDate）
isAsc 否 bool 是否升序（默认是false-降序）
page 否 int 当前页（默认为1）
pageSize 否 int 每页条数（默认为10）

请求包体

[
    //过滤条件用json数组表示
    {"fieldName":"fieldName", "logic": "logic", "value":"value"},
 		{"fieldName":"数字1", "logic": "eq", "value":"1"}
]

请求包体说明

参数 必须 数据类型 说明
fieldName 否 string 表单字段名称
logic 否 string 逻辑符
value 否 string 值

逻辑符规则

参考逻辑符规则

返回结果

{
   "list"[{
    "variables":{
        "fieldName": "fieldValue",
        "age": "22"
    },
    //友好值字段
    "realValue": {
        "多项选择1": "选项一,选项二"
    },
    "id": "0141c3223a6e4d9dbd7c4f605fd0fb48",
    "version": 1,
    "formTitle": "xxx表单",
    "processInstanceId": "355cfccf9bc63ce4282c0c437b71fdfb",
    "processDefinitionId": "355cfccf9bc63ce4282c0c437b71fdfb",
    "formDefinitionId": "105cfccf9bc63ce6a82c0c437b41fd3c",
    "taskId": "64c761a7fb7f4847992466ee76efc195",
    "author": "a08bcb7e67a84cb08348884688aacd02",
    "authorName": "张三",
    "createDate": 12324123123,
    "lastModifyDate": 12312312312,
    "lastModifier": "a08bcb7e67a84cb08348884688aacd02",
    "lastModifierName": "张三",
    "applicationId": "f58bcb7e67a84c458348884688aacd7f"
    }],
   "page": 1,
   "pageSize": 10,
   "total": 20
}

返回参数 参考表单数据对象结构说明

# 1.6 新增表单

功能描述 保存新增的表单实例数据。

请求说明

请求方式：POST

请求URL ：https://qiqiao.do1.com.cn/plus/cgi-bin/open/applications/{applicationId}/forms/{formModelId}

请求参数

参数 必须 数据类型 说明
applicationId 是 string 应用id

请求包体

{
    "variables":{
      //"字段名" : "值"
      "fieldName": "fieldValue",
      "age": "22",
      "单行文本" : "文本内容",
      "数字" : 123,
      "单项选择" : "1",
      "多项选择" : ["1", "2", "3"],
      //人员、部门选择控件需要传入对应的id
      "人员单选" : "a08bcb7e67a84cb08348884688aacd02",
      "人员多选" : ["123","345","456"],
      "日期" : 1666368000000,
      "日期时间" : 1666368000000,
      "时间" : "10:10",
      "富文本" : "文本内容",
      //图片上传、文件上传、音频、视频可以通过调用文件上传接口，将返回的结果“data”值进行传参
      "图片上传" : "data",
      //手写签名可以通过调用文件上传接口，将返回的结果“fileUrl”值进行传参
      "手写签名" : "fileUrl"
    },
    "id": "string",
    "loginUserId":"a08bcb7e67a84cb08348884688aacd02"
}

请求包体参数说明

字段 字段类型 是否必填 字段说明
variables object 必填 表单字段值集合（{字段名:字段值,...}）
id string 选填（id的长度为32） 表单数据实例id
loginUserId string 必填 操作用户id

参考表单入参组件说明

返回结果

{
    "msg": "执行成功",
    "traceId": null,
    "code": 0,
    "data": {
        "processInstanceId": null,
        "processDefinitionId": null,
        "processCurrentApprovers": null,
        "variables": {
            "fieldName": "fieldValue",
            "时间1": "10:20:00",
            "__isDeleted": false,
            "数字1": 123,
            "日期时间1": 1666368000000,
            "日期1": 1666368000000,
            "单行文本1": "文本内容"
        },
        "processStatus": null,
        "processState": null,
        "author": "779c3d9ced0f28cad0ca97ad1987204d",
        "lastModifier": "779c3d9ced0f28cad0ca97ad1987204d",
        "lastModifierName": "测试人员",
        "version": 1,
        "authorName": "测试人员",
        "dataStaticUrl": null,
        "formDefinitionId": null,
        "id": "6793650729174859777",
        "applicationId": null,
        "lastModifyDate": 1661394859379,
        "taskId": null,
        "createDate": 1661394859379
    }
}

返回参数 参考表单数据对象结构说明

# 1.6.1 批量新增表单

功能描述 批量保存新增的表单实例数据。

请求说明

请求方式：POST

请求URL ：https://qiqiao.do1.com.cn/plus/cgi-bin/open/applications/{applicationId}/forms/{formModelId}/batch_save

请求参数

参数 必须 数据类型 说明
applicationId 是 string 应用id
formModelId 是 string 表单id

请求包体

[
    {
    "variables":{
      //"字段名" : "值"
      "fieldName": "fieldValue",
      "age": "22",
      "单行文本" : "文本内容",
      "数字" : 123,
      "单项选择" : "1",
      "多项选择" : ["1", "2", "3"],
      //人员、部门选择控件需要传入对应的id
      "人员单选" : "a08bcb7e67a84cb08348884688aacd02",
      "人员多选" : ["123","345","456"],
      "日期" : 1661394000000,
      "日期时间" : 1661394859379,
      "时间" : "10:10",
      "富文本" : "文本内容",
      //图片上传、文件上传、音频、视频可以通过调用文件上传接口，将返回的结果“data”值进行传参
      "图片上传" : "data",
      //手写签名可以通过调用文件上传接口，将返回的结果“fileUrl”值进行传参
      "手写签名" : "fileUrl"
    },
    "id": "string",
    "loginUserId":"a08bcb7e67a84cb08348884688aacd02"
},
    {
    "variables":{
      //"字段名" : "值"
      "fieldName": "fieldValue",
      "age": "22",
      "单行文本" : "文本内容",
      "数字" : 123,
      "单项选择" : "1",
      "多项选择" : ["1", "2", "3"],
      //人员、部门选择控件需要传入对应的id
      "人员单选" : "a08bcb7e67a84cb08348884688aacd02",
      "人员多选" : ["123","345","456"],
      "日期" : 1661394000000,
      "日期时间" : 1661394859379,
      "时间" : "10:10:00",
      "富文本" : "文本内容",
      //图片上传、文件上传、音频、视频可以通过调用文件上传接口，将返回的结果“data”值进行传参
      "图片上传" : "data",
      //手写签名可以通过调用文件上传接口，将返回的结果“fileUrl”值进行传参
      "手写签名" : "fileUrl"
    },
    "id": "string2",
    "loginUserId":"a08bcb7e67a84cb08348884688aacd02"
}
]

请求包体参数说明

字段 字段类型 是否必填 字段说明
variables object 必填 表单字段值集合（{字段名:字段值,...}）
id string 选填（id的长度为32） 表单数据实例id
loginUserId string 必填 操作用户id

参考表单入参组件说明

返回结果

[
    {
    "variables":{
      //"字段名" : "值"
      "fieldName": "fieldValue",
      "age": "22",
      "单行文本" : "文本内容",
      "数字" : 123,
      "单项选择" : "1",
      "多项选择" : ["1", "2", "3"],
      //人员、部门选择控件需要传入对应的id
      "人员单选" : "a08bcb7e67a84cb08348884688aacd02",
      "人员多选" : ["123","345","456"],
      "日期" : 1661394000000,
      "日期时间" : 1661394859379,
      "时间" : "10:10",
      "富文本" : "文本内容",
      //图片上传、文件上传、音频、视频可以通过调用文件上传接口，将返回的结果“data”值进行传参
      "图片上传" : "data",
      //手写签名可以通过调用文件上传接口，将返回的结果“fileUrl”值进行传参
      "手写签名" : "fileUrl"
    },
    "loginUserId":"a08bcb7e67a84cb08348884688aacd02"
},
    {
    "variables":{
      //"字段名" : "值"
      "fieldName": "fieldValue",
      "age": "22",
      "单行文本" : "文本内容",
      "数字" : 123,
      "单项选择" : "1",
      "多项选择" : ["1", "2", "3"],
      //人员、部门选择控件需要传入对应的id
      "人员单选" : "a08bcb7e67a84cb08348884688aacd02",
      "人员多选" : ["123","345","456"],
      "日期" : 1661394000000,
      "日期时间" : 1661394859379,
      "时间" : "10:10:00",
      "富文本" : "文本内容",
      //图片上传、文件上传、音频、视频可以通过调用文件上传接口，将返回的结果“data”值进行传参
      "图片上传" : "data",
      //手写签名可以通过调用文件上传接口，将返回的结果“fileUrl”值进行传参
      "手写签名" : "fileUrl"
    },
    "loginUserId":"a08bcb7e67a84cb08348884688aacd02"
}
]

返回参数 参考表单数据对象结构说明

# 1.7 修改表单

功能描述 保存修改的表单实例数据。

请求说明

请求方式：PUT

请求URL ：https://qiqiao.do1.com.cn/plus/cgi-bin/open/applications/{applicationId}/forms/{formModelId}

请求参数

参数 必须 数据类型 说明
applicationId 是 string 应用id

请求包体

{
    "variables":{
      "单行文本1" : "文本内容",
      "数字1" : 123,
      "日期1":1666368000000,
      "日期时间1":1666368000000,
      "时间1":"10:20"
    },
    "id": "6793704467805667328",
    "version": 2,
    "loginUserId":"779c3d9ced0f28cad0ca97ad1987204d"
}

请求包体参数说明

字段 字段类型 是否必填 字段说明
variables object 必填 表单字段值集合（{字段名:字段值,...}）
id string 必填 表单数据实例id
version int 必填 表单数据版本号（数据修改后递增）
loginUserId string 必填 操作用户id

参考表单入参组件说明

返回结果

{
    "msg": "执行成功",
    "traceId": null,
    "code": 0,
    "data": {
        "processInstanceId": null,
        "processDefinitionId": null,
        "processCurrentApprovers": null,
        "variables": {
            "时间1": "10:20:00",
            "__isDeleted": false,
            "日期时间1": 1666368000000,
            "数字1": 123,
            "日期1": 1666368000000,
            "单行文本1": "文本内容"
        },
        "processStatus": null,
        "processState": null,
        "author": "779c3d9ced0f28cad0ca97ad1987204d",
        "lastModifier": "779c3d9ced0f28cad0ca97ad1987204d",
        "lastModifierName": "张三",
        "version": 2,
        "authorName": "张三",
        "dataStaticUrl": null,
        "formDefinitionId": null,
        "id": "6793704467805667328",
        "applicationId": null,
        "lastModifyDate": 1661396595385,
        "taskId": null,
        "createDate": 1661396423000
    }
}

返回参数 参考表单数据对象结构说明

# 1.7.1 批量修改表单

功能描述 批量保存修改的表单实例数据。

请求说明

请求方式：POST

请求URL ：https://qiqiao.do1.com.cn/plus/cgi-bin/open/applications/{applicationId}/forms/{formModelId}/batch_update

请求参数

参数 必须 数据类型 说明
applicationId 是 string 应用id
formModelId 是 string 表单模型Id

请求包体

[{
    "variables":{
      "单行文本1" : "文本内容",
      "数字1" : 123,
      "日期1":1666368000000,
      "日期时间1":1666368000000,
      "时间1":"10:20"
    },
    "id": "6793704467805667328",
    "version": 3,
    "loginUserId":"779c3d9ced0f28cad0ca97ad1987204d"
 },
 {
    "variables":{
      "单行文本1" : "文本内容",
      "数字1" : 123,
      "日期1":1666368000000,
      "日期时间1":1666368000000,
      "时间1":"10:20"
    },
    "id": "6793712645423398913",
    "version": 1,
    "loginUserId":"779c3d9ced0f28cad0ca97ad1987204d"
}
]

请求包体参数说明

字段 字段类型 是否必填 字段说明
variables object 必填 表单字段值集合（{字段名:字段值,...}）
id string 必填 表单数据实例id
version int 必填 表单数据版本号（数据修改后递增）
loginUserId string 必填 操作用户id

参考表单入参组件说明

返回结果

{
    "msg": "执行成功",
    "traceId": null,
    "code": 0,
    "data": [
        {
            "variables": {
                "时间1": "10:20",
                "日期时间1": 1666368000000,
                "数字1": 123,
                "日期1": 1666368000000,
                "单行文本1": "文本内容"
            },
            "loginUserId": "779c3d9ced0f28cad0ca97ad1987204d",
            "id": "6793704467805667328",
            "version": 3
        },
        {
            "variables": {
                "时间1": "10:20",
                "日期时间1": 1666368000000,
                "数字1": 123,
                "日期1": 1666368000000,
                "单行文本1": "文本内容"
            },
            "loginUserId": "779c3d9ced0f28cad0ca97ad1987204d",
            "id": "6793712645423398913",
            "version": 1
        }
    ]
}

返回参数 参考表单数据对象结构说明

# 1.8 删除表单实例数据

功能描述 删除指定表单的某条表单实例数据

请求说明

请求方式：DELETE

请求URL ：https://qiqiao.do1.com.cn/plus/cgi-bin/open/applications/{applicationId}/forms/{formModelId}/{id}

请求参数

参数 必须 数据类型 说明
applicationId 是 string 应用Id
formModelId 是 string 表单模型Id
id 是 string 表单实例Id

返回结果

无

# 1.8.1 批量删除表单实例数据

功能描述 批量删除指定表单的某条表单实例数据

请求说明

请求方式：POST

请求URL ：https://qiqiao.do1.com.cn/plus/cgi-bin/open/applications/{applicationId}/forms/{formModelId}/batch_delete

请求参数

参数 必须 数据类型 说明
applicationId 是 string 应用Id
formModelId 是 string 表单模型Id

请求包体

[
   "documentId1",
   "documentId2"
]

返回结果

无

#

# 1.9 删除子表实例数据

功能描述 可根据筛选条件删除指定主表下的子表数据。

请求说明

请求方式：DELETE

请求URL ：https://qiqiao.do1.com.cn/plus/cgi-bin/open/applications/{applicationId}/forms/{parentId}/{parentFieldName}/{subFormModelId}

请求参数

参数 必须 数据类型 说明
applicationId 是 string 应用id
parentId 是 string 主表单实例Id
parentFieldName 是 string 关联主表的外键字段名
subFormModelId 是 string 子表单模型Id

请求包体

[
   //过滤条件用json数组表示
    {"fieldName":"fieldName", "logic": "logic", "value":"value"},
  	{"fieldName":"数字1", "logic": "eq", "value":"1"}
]

请求包体说明

参数 必须 数据类型 说明
fieldName 否 string 表单字段名称
logic 否 string 逻辑符
value 否 string 值

逻辑符规则

参考逻辑符规则

返回结果

{
    "msg": "执行成功",
    "traceId": null,
    "code": 0,
    //影响行数
    "data": 1
}

# 2.1 文件下载

文件下载需要通过以下两个接口实现

  1. 获取文件Id
  2. 通过文件Id的下载文件

# 2.1.1文件下载--获取文件Id

功能描述

  1. 获取对应表单实例数据下的文件包Id。
  2. 可以传入needDownloadFieldName参数下载指定组件内的文件内容。
  3. 单次调用接口下载总量不能超过100M。

请求说明

请求方式：GET

请求URL ：https://qiqiao.do1.com.cn/plus/cgi-bin/open/file_download/applications/{applicationId}/form_models/{formModelId}/documents/{documentId}

请求参数

参数 必须 数据类型 说明
applicationId 是 string 应用Id
formModelId 是 string 表单模型Id
documentId 是 string 表单实例Id
needDownloadFieldName 否 string 需要下载的文件组件字段名, 多个控件可通过','分隔

返回结果

{
    "msg": "执行成功",
    "traceId": null,
    "code": 0,
    "data": {
        "createTime": 1640335934161,
        //获取文件Id:fileId, 通过fileId调用下载接口下载文件
        "fileId": "607007157579********",
        //当前DocumentId
        "fileName": "60490508376********",
        "fileSize": 652,
        
        //手写签名组件内容将会另外展示, 可以直接获取url
        "fileValidateDTOList": [
			 {
        "fieldName": "手写签名1",
        "fieldType": "handwrittenSignature",
        "url": "https://qiqiao-test/2efc32ee89074e9*******/20211*******/2021*******.png"
			 }
        ]
    }
}

返回参数说明

参数 字段类型 字段说明
createTime string 创建时间
fileId string 文件id, 需要通过此id下载具体的文件
fileName string 文件名称, 一般为documentId
fileSize string 文件大小, 单位KB
fileValidateDTOList List 手写签名组件内容

fileValidateDTOList参数说明

参数 字段类型 字段说明
fieldName string 文件名称
fieldType string 文件类型
url string 手写签名路径, 可以直接将此值插入手写签名组件中

# 2.1.2文件下载--通过文件Id下载文件

功能描述

  1. 通过文件Id下载文件。

请求说明

请求方式：GET

请求URL ：https://qiqiao.do1.com.cn/plus/cgi-bin/open/file_download/applications/{applicationId}/files/{fileId}

请求参数

参数 必须 数据类型 说明
applicationId 是 string 应用Id
fileId 是 string 文件Id

返回结果

通过响应体获取输入流

java示例请求代码

String url = https://qiqiao.do1.com.cn/plus/cgi-bin/open/file_download/applications/{applicationId}/files/{fileId}?X-Auth0-Token=Token";
ResponseEntity<byte[]> responseEntity = null;
FileOutputStream fileOutputStream = null;
try {
    responseEntity = restTemplate.getForEntity(url, byte[].class);
    //获取返回体
    byte[] bytes = stringResponseEntity.getBody();
    File newFile = new File("文件地址\\图片.png");
    fileOutputStream = new FileOutputStream(newFile);
    fileOutputStream.write(bytes);
} catch (RestClientException e) {
    e.printStackTrace();
}finally {
    assert fileOutputStream != null;
    fileOutputStream.close();
}

# 2.2 文件上传（通过文件流上传）

功能描述 上传文件并获取文件存储内容，需要再次调用新增表单接口持久化数据到表单中。

请求说明

请求方式：POST

请求URL ：https://qiqiao.do1.com.cn/plus/cgi-bin/open/file_upload/applications/{applicationId}/form_models/{formModelId}

请求参数

参数 必须 数据类型 说明
applicationId 是 string 应用Id
formModelId 是 string 表单模型Id
fieldType 是 string 类型(文件上传:FILEUPLOAD、图片上传:FILEUPLOAD、视频:VIDEO、音频:AUDIO、手写签名:HANDWRITTENSIGNATURE)
files 是 MultipartFile[] 文件流

设置 Content-Type 以multipart/form-data形式上传文件

# 2.3 文件上传（通过文件地址上传）

功能描述 通过文件地址上传文件并获取文件存储内容，需要再次调用新增表单接口持久化数据到表单中。

请求说明

请求方式：POST

请求URL ：https://qiqiao.do1.com.cn/plus/cgi-bin/open/file_upload/applications/{applicationId}/form_models/{formModelId}/address

请求参数

参数 必须 数据类型 说明
applicationId 是 string 应用Id
formModelId 是 string 表单模型Id
fieldType 是 string 类型(文件上传:FILEUPLOAD、图片上传:FILEUPLOAD、视频:VIDEO、音频:AUDIO、手写签名:HANDWRITTENSIGNATURE)

请求包体

[
	"文件地址1","文件地址2"
]

返回结果

{
    "msg": "执行成功",
    "traceId": null,
    "code": 0,
    "data": [
        {
            "authUrl": "url",
            "createDate": 1640160729480,
            "fileId": "9a1*********************",
            "fileSize": 470428,
            "fileType": "image/png",
            "fileUrl": "",
            "frameFileUrl": "",
            "hasUploadSuccess": true,
            "hasUploaded": true,
            "name": "20210925379814563.png",
            "removeConfirm": true,
            "uId": 60640********,
            "uploadUser": "5db48d5b0***************"
        }
    ]
}

返回参数说明

参数 字段类型 字段说明
createDate string 创建时间
fileId string 文件id
fileSize string 文件大小, 单位KB
fileType string 文件类型
name string 上传前的原来文件名
uId string 唯一随机Id
hasUploadSuccess boolean 是否成功上传
uploadUser string 上传人员id
fileUrl string 访问地址

# 文件上传/音频/视频/图片上传添加进表单示例：

文件上传后, 通过新增/更新表单接口将文件信息插入到表单数据中, 将文件上传的data参数作为组件值 如下包体实例

获取文件格式后可以通过以下方式添加进表单中
//以下展示调用表单新增接口时, 传参body的写法


{
    "variables":{
        "fieldName": "fieldValue",
        "age": "22",
        //需要新增的文件上传组件, 将文件上传的data参数作为组件值
        "文件上传1":[
        {
            "authUrl": "url",
            "createDate": 1640160729480,
            "fileId": "9a1*********************",
            "fileSize": 470428,
            "fileType": "image/png",
            "fileUrl": "",
            "frameFileUrl": "",
            "hasUploadSuccess": true,
            "hasUploaded": true,
            "name": "20210925379814563.png",
            "removeConfirm": true,
            "uId": 60640********,
            "uploadUser": "5db48d5b0***************"
        }
   	 ]
    },
    "id": "string",
    "version": 1,
    "loginUserId":"a08bcb7e67a84cb08348884688aacd02"
}

# 手写签名添加进表单示例：

如果上传类型是手写签名并需要将数据插入表单中, 将文件上传的fileUrl参数作为组件值, 如下包体示例:

{
    "variables":{
        "fieldName": "fieldValue",
        "age": "22",
        //需要新增的手写签名组件, 将文件上传的fileUrl参数作为组件值
        "手写签名1":"https://qiqiao/20220111/202201111359311501.png",
    },
    "id": "string",
    "version": 1,
    "loginUserId":"a08bcb7e67a84cb08348884688aacd02"
}

# 3.1 表单模型相关

# 3.1.1 获取应用下表单列表信息

功能描述 获取应用下表单列表信息

请求说明

请求方式：GET

请求URL ：https://qiqiao.do1.com.cn/plus/cgi-bin/open/applications/{applicationId}/form_models (opens new window)

请求参数

参数 必须 数据类型 说明
applicationId 是 String 需要查询的应用Id
page 是 int 当前页
pageSize 是 int 每页条数

返回结果

{
    "msg": "执行成功",
    "traceId": null,
    "code": 0,
    "data": {
        "currPage": 0,
        "list": [
            {
                "applicationId": "60af52d65a9**********",
                "createTime": 1639452061000,
                "createUserId": "8620e9**********",
                "creator": "测试",
                "formTableId": "f_测试_3f**********",
                "formType": "PRIVATE",
                "id": "61b80d9d**********",
                "name": "测试",
                "updateTime": 1640000713577
            },
            {
                "applicationId": "60af52d65a9f94**********",
                "createTime": 1622102750000,
                "createUserId": "5db48d5b0e2b203b8edb1**********",
                "creator": "测试",
                "formTableId": "f_232_3f407**********",
                "formType": "PRIVATE",
                "id": "60af52de5a9**********",
                "name": "测试",
                "updateTime": 1640682922038
            }
        ],
        "pageSize": 2,
        "totalCount": 2,
        "totalPage": 1
    }
}

返回参数说明

字段 字段类型 字段说明
id string 表单模型Id
name string 表单名称
applicationId string 应用ApplicationId
formTableId string 表单标识 id
formType string 表单类型 私有表 共有表
createUserId string 创建人id
creator string 创建人
createTime long 创建时间
updateTime long 更新时间

# 3.1.2 获取表单模型下组件信息

功能描述 获取表单模型下组件信息

请求说明

请求方式：GET

请求URL ：https://qiqiao.do1.com.cn/plus/cgi-bin/open/applications/{applicationId}/form_models/{formModelId} (opens new window)

请求参数

参数 必须 数据类型 说明
applicationId 是 String 需要查询的应用Id
formModelId 是 String 需要查询的表单模型Id

返回结果

{
    "msg": "执行成功",
    "traceId": null,
    "code": 0,
    "data": [
        //生成编码组件
        {
            "extras": {
                "codingRules": [
                    {
                        "type": "fixedString",
                        "value": "LY"
                    },
                    {
                        "type": "serialNo",
                        "value": "5"
                    },
                    {
                        "type": "tableField",
                        "value": "key_1635482857779_300924"
                    },
                    {
                        "type": "date",
                        "value": "yyyymmdd"
                    }
                ]
            },
            "fieldName": "生成编码1",
            "id": "key_1640606974014_117181",
            "required": false,
            "textValue": "",
            "title": "生成编码1",
            "type": "generateCode"
        },
        //单项选择组件
        {
            "extras": {
                "options": [
                    {
                        "isDefault": false,
                        "label": "选项一",
                        "value": "1"
                    },
                    {
                        "isDefault": false,
                        "label": "选项二",
                        "value": "2"
                    },
                    {
                        "isDefault": false,
                        "label": "选项三",
                        "value": "3"
                    }
                ]
            },
            "fieldName": "单项选择1",
            "id": "key_1625017668815_167459",
            "required": false,
            "textValue": "",
            "title": "单项选择1",
            "type": "singleSelect"
        }
   	 ]
}

返回参数说明

字段 字段类型 字段说明
id string 组件key Id
type string 组件类型(单行文本、单项选择)
title string 组件名称
fieldName string 组件字段名（唯一，不可修改）
required string 是否必填
extras 集合 高级属性

# 不同组件高级属性参数说明 见下 extras：

# 1. 多行文本，单行文本：
字段 字段类型 字段说明
defaultValue Sitrng 默认值
minLength Sitrng 最小长度
maxLength Sitrng 最大长度
{
	"extras": {
		"defaultValue": "",
		"maxLength": 0,
		"minLength": 0
	},
	"fieldName": "多行文本1",
	"id": "key_162****24_93386",
	"required": false,
	"textValue": "",
	"title": "多行文本1",
	"type": "textarea"
}
# 2. 数字
字段 字段类型 字段说明
defaultValue Sitrng 默认值
maxNumericalValue Integer 最小数
minNumericalValue Integer 最大数
{
	"extras": {
		"defaultValue": "",
		"maxNumericalValue": null,
		"minNumericalValue": null
	},
	"fieldName": "数字1",
	"id": "key_16250****227_21351",
	"required": false,
	"textValue": "请输入整数",
	"title": "数字1",
	"type": "number"
}
# 3.单选框
字段 字段类型 字段说明
options List 选项值
字段 字段类型 字段说明
isDefault Boolean 是否默认
label Sitrng 选项名称，如：选项一
value Sitrng 选项值，如：“1”
{
    "extras": {
        "options": [
            {
                "isDefault": false,
                "label": "选项一",
                "value": "1"
            },
            {
                "isDefault": true,
                "label": "选项二",
                "value": "2"
            },
            {
                "isDefault": false,
                "label": "选项三",
                "value": "3"
            }
        ]
    },
    "fieldName": "单项选择2",
    "id": "key_16417****9_23308",
    "required": false,
    "textValue": "",
    "title": "单项选择2",
    "type": "singleSelect"
}
# 4.多选框
字段 字段类型 字段说明
options List 选项值
isCheckAll Boolean 是否全选
maxSelectLimit Integer 最大选中个数
minSelectLimit Integer 最小选中个数
字段 字段类型 字段说明
isDefault boolean 是否默认
label Sitrng 选项名称，如：选项一
value Sitrng 选项值，如：“1”
{
    "extras": {
        "isCheckAll": false,
        "maxSelectLimit": "3",
        "minSelectLimit": "1",
        "options": [
            {
                "isDefault": true,
                "label": "选项一",
                "value": "1"
            },
            {
                "isDefault": true,
                "label": "选项二",
                "value": "2"
            },
            {
                "isDefault": false,
                "label": "选项三",
                "value": "3"
            }
        ]
    },
    "fieldName": "多项选择2",
    "id": "key_1641799***5_32394",
    "required": false,
    "textValue": "",
    "title": "多项选择2",
    "type": "multiSelect"
}
# 5.日期
字段 字段类型 字段说明
dateType String 日期类型
minSelect List 最小可选时间
maxSelect List 最大可选时间
defaultValue List 默认值
字段 字段类型 字段说明
type String 日期类型
value String 默认值
{
    "extras": {
        "dateType": "day",
        "defaultValue": {
            "type": "null",
            "value": 0
        },
        "maxSelect": {
            "type": "null",
            "value": 0
        },
        "minSelect": {
            "type": "null",
            "value": 0
        }
    },
    "fieldName": "日期1",
    "id": "key_16250176****_16147",
    "required": false,
    "textValue": "",
    "title": "日期1",
    "type": "date"
}
# 6.富文本
字段 字段类型 字段说明
defaultValue String 默认值
 {
     "extras": {
         "defaultValue": ""
     },
     "fieldName": "富文本1",
     "id": "key_1641***_634111",
     "required": false,
     "textValue": "111",
     "title": "富文本1",
     "type": "editor"
 }
# 7.生成编码
字段 字段类型 字段说明
codingRules String 默认值
字段 字段类型 字段说明
type String 类型
value String 编码规则值
{
  "extras": {
      "codingRules": [
          {
              "type": "serialNo",
              "value": "5"
          }
      ]
  },
  "fieldName": "生成编码1",
  "id": "key_1641802***7_269540",
  "required": false,
  "textValue": "",
  "title": "生成编码1",
}
# 8.人员多选以及部门多选
字段 字段类型 字段说明
maxSelectNumber Integer 最多选几个
{
    "extras": {
        "maxSelectNumber": 0
    },
    "fieldName": "人员多选1",
    "id": "key_163607****_263581",
    "required": false,
    "textValue": "",
    "title": "人员多选1",
    "type": "multiUserSelect"
}
# 9.评分
字段 字段类型 字段说明
fullScore Integer 满分最大值
{
    "extras": {
        "fullScore": 3
    },
    "fieldName": "评分1",
    "id": "key_1641802****_195264",
    "required": false,
    "textValue": "",
    "title": "评分1",
    "type": "rated"
}

# 表单入参组件说明

组件名称 传参类型 示例
单行文本 String "单行文本"
多行文本 String "多行文本"
数字 Integer 123
单项选择 String "1"
多项选择 String[] ["1","2"]
日期 Long 1640682922038
时间 String "10:10"
日期时间 Long 1640682922038
富文本 String "

富文本框, 支持h5标签

"
图片上传 String //可以通过文件上传接口, 获取返回数据
{
"authUrl": "url",
"createDate": 1640160729480,
"fileId": "9a1*********************",
"fileSize": 470428,
"fileType": "image/png",
"fileUrl": "",
"frameFileUrl": "",
"hasUploadSuccess": true,
"hasUploaded": true,
"name": "20210925379814563.png",
"removeConfirm": true,
"uId": 60640********,
"uploadUser": "5db48d5b0***************"
}
文件上传 String 同图片上传
音频 String 同图片上传
视频 String 同图片上传
人员单选 String "a08bcb7e67a84cb08348884688aacd02"
人员多选 String[] ["a08bcb7e67a84cb08348884688aacd02","a08bcb7e67a84cb08348884688aacd02"]
部门单选 String "a08bcb7e67a84cb08348884688aacd02"
部门多选 String[] ["a08bcb7e67a84cb08348884688aacd02","a08bcb7e67a84cb08348884688aacd02"]
评分 Integer 5
手写签名 String "https://qiqiao/20220111/202201111359311501.png"
外键选择 String "对应的表单数据实例id"

# 表单数据对象结构说明

表单数据对象：

{
    "variables":{
        "fieldName": "fieldValue",
        "age": "22"
    },
    "id": "0141c3223a6e4d9dbd7c4f605fd0fb48",
    "version": 1,
    "formTitle": "xxx表单",
    "processInstanceId": "355cfccf9bc63ce4282c0c437b71fdfb",
    "processDefinitionId": "355cfccf9bc63ce4282c0c437b71fdfb",
    "formDefinitionId": "105cfccf9bc63ce6a82c0c437b41fd3c",
    "taskId": "64c761a7fb7f4847992466ee76efc195",
    "author": "a08bcb7e67a84cb08348884688aacd02",
    "authorName": "张三",
    "createDate": 12324123123,
    "lastModifyDate": 12312312312,
    "lastModifier": "a08bcb7e67a84cb08348884688aacd02",
    "lastModifierName": "张三",
    "applicationId": "f58bcb7e67a84c458348884688aacd7f"
}

参数说明：

字段 字段类型 字段说明
variables object 表单字段值集合
id string 表单id
version int 表单数据版本号
formTitle string 表单标题
formDefinitionId string 表单定义id
processInstanceId string 流程实例id
processDefinitionId string 流程定义id
taskId string 任务id
author string 创建人id
authorName string 创建人名称
createDate long 创建日期
lastModifyDate long 最后修改日期
lastModifier string 最后修改人id
lastModifierName string 最后修改人名称
applicationId string 应用id

# 逻辑符规则

查询逻辑 传参值 备注
大于 gt 不可用于多选类型组件(人员、部门多选，多项选择组件等)
大于且等于 ge 不可用于多选类型组件(人员、部门多选，多项选择组件等)
小于 lt 不可用于多选类型组件(人员、部门多选，多项选择组件等)
小于并且等于 le 不可用于多选类型组件(人员、部门多选，多项选择组件等)
等于 eq 不可用于多选类型组件(人员、部门多选，多项选择组件等)
不等于 ne 不可用于多选类型组件(人员、部门多选，多项选择组件等)
在...之间 between 不可用于多选类型组件(人员、部门多选，多项选择组件等)
模糊匹配 like 不可用于多选类型组件(人员、部门多选，多项选择组件等)
为空 isNull
非空 isNotNull
包含 in
不包含 notIn
1 / 0