记录模块

一、根据条件获取列表

接口地址 /api/v1/t/app/{applicationId}/form/{formId}/records/find

请求方式 POST

consumes ["application/json"]

produces ["*/*"]

接口描述 ``

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
applicationId	applicationId	path	true	string
formId	formId	path	true	string
body	body	body	true	记录请求体	记录请求体

schema属性说明

记录请求体

参数名称	参数说明	请求类型	是否必须	数据类型	schema
authGroupId	权限组ID	body	false	string
authGroupType	明细表继承类型	body	false	string
componentId	组件ID	body	false	string
pageNo	分页	body	false	integer(int32)
pageSize	大小	body	false	integer(int32)
fields	显示字段集合	body	false	array
filter	记录过滤	body	false	统一过滤条件构建	统一过滤条件构建
ids	主键ID集合	body	false	array
keyword	关键字	body	false	string
sort	排序	body	false	array	组件实体

统一过滤条件构建

参数名称	参数说明	请求类型	是否必须	数据类型	schema
cond	过滤条件	body	false	array	过滤条件实体
type	过滤类型,可用值:ANY,AND	body	false	string

过滤条件实体

参数名称	参数说明	请求类型	是否必须	数据类型	schema
childFilter	子条件组构建	body	false	统一过滤条件构建	统一过滤条件构建
depend	联动表单字段	body	false	object
fieldId	字段ID	body	false	string
formId	表单ID	body	false	string
format	时间格式	body	false	string
groupFlag	单	组	body	false	boolean
hasCurrentUserFlag	包含当前用户	body	false	boolean
hasEmptyFlag	包含空	body	false	boolean
method	方法类型,可用值:NOT_EMPTY,EMPTY,IN,NOT_IN,ADD,SUBTRACT,MULTIPLY,DIVIDE,EQ,NEQ,GT,LT,GTE,LTE,RANGE,FORMULA,PANEL_RANGE,START,END,CONTAINS,NO_CONTAINS,ALL	body	false	string
mode	数据联动 - 类型,可用值:DEPEND,CUSTOM	body	false	string
name	条件名称	body	false	string
parentFieldId	父组件ID	body	false	string
parentFormId	父表单ID	body	false	string
type	组件类型,可用值:TEXT,MULTILINE_TEXT,NUMBER,DATETIME,SINGLE_SELECT,MULTIPLE_SELECT,SINGLE_DROP_DOWN,MULTIPLE_DROP_DOWN,DIVIDER,ADDRESS,LOCATION,FILE,IMAGE,SUBFORM,LINK_QUERY,LINK_FIELD,SIGNATURE,SERIAL_NUMBER,TELEPHONE,OCR,BUTTON,POSITIONING,SINGLE_MEMBER,MULTIPLE_MEMBER,SINGLE_DEPARTMENT,MULTIPLE_DEPARTMENT,FLOW_STATE,TASK_NODE,ANY,COMBINE	body	false	string
value	条件值	body	false	object
values	条件值	body	false	array

组件实体

参数名称	参数说明	请求类型	是否必须	数据类型
componentId	组件Id	body	false	string
customList	自定义排序集合	body	false	array
type	排序类型,可用值:DESC,ASC,DEFAULT,CUSTOM	body	false	string

响应状态

状态码	说明	schema
200	OK	响应结果对象«记录组件响应体»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code	结果码	integer(int32)	integer(int32)
data	结果数据	记录组件响应体	记录组件响应体
message	结果描述	string
timestamp	时间戳	integer(int64)	integer(int64)

schema属性说明

记录组件响应体

参数名称	参数说明	类型	schema
components	组件集合	array	组件响应体
conditionalFormattingList	条件格式JSON	array	BasicDBObject
records	记录集合	分页对象«记录响应体»	分页对象«记录响应体»
showHiddenRuleList	显隐规则JSON	array	BasicDBObject
viewRecords	视图看板-记录集合	分页对象«视图记录响应体»	分页对象«视图记录响应体»

组件响应体

参数名称	参数说明	类型
applicationId	应用ID	string
description	描述	string
formId	表单ID	string
hint	信息提示	string
id	组件ID	string
key	组件临时Key	string
lineWidth	线宽	integer(int32)
name	组件名称	string
tab	组件标签	string
titleFlag	是否为标题字段	boolean
type	类型,可用值:	string
widget	扩展	object
widgetName	套件字段预设ID	string

type:TEXT,MULTILINE_TEXT,NUMBER,DATETIME,SINGLE_SELECT,MULTIPLE_SELECT,SINGLE_DROP_DOWN,MULTIPLE_DROP_DOWN,DIVIDER,ADDRESS,LOCATION,FILE,IMAGE,SUBFORM,LINK_QUERY,LINK_FIELD,SIGNATURE,SERIAL_NUMBER,TELEPHONE,OCR,BUTTON,POSITIONING,SINGLE_MEMBER,MULTIPLE_MEMBER,SINGLE_DEPARTMENT,MULTIPLE_DEPARTMENT,FLOW_STATE,TASK_NODE,ANY,COMBINE

BasicDBObject

参数名称	参数说明	类型	schema

分页对象«记录响应体»

参数名称	参数说明	类型	schema
body	分页数据	array	记录响应体
pageNum	当前页数	integer(int32)
pageSize	每页条数	integer(int32)
total	总条数	integer(int64)

记录响应体

参数名称	参数说明	类型
createdAt	创建时间	string(date-time)
fields	记录值	object
id	记录ID	string
lastModifiedAt	修改时间	string(date-time)
ownerBy	拥有者	object
分页对象«视图记录响应体»

参数名称	参数说明	类型	schema
body	分页数据	array	视图记录响应体
pageNum	当前页数	integer(int32)
pageSize	每页条数	integer(int32)
total	总条数	integer(int64)

视图记录响应体

参数名称	参数说明	类型	schema
groups	分组字段	object
records	记录集合	array	记录响应体

响应示例


xxxxxxxxxx
{
    "code": 0,
    "data": {
        "components": [
            {
                "applicationId": "",
                "description": "",
                "formId": "",
                "hint": "",
                "id": "",
                "key": "",
                "lineWidth": 0,
                "name": "",
                "tab": "",
                "titleFlag": false,
                "type": "",
                "widget": {},
                "widgetName": ""
            }
        ],
        "conditionalFormattingList": [
            {}
        ],
        "records": {
            "body": [
                {
                    "createdAt": "",
                    "fields": {},
                    "id": "",
                    "lastModifiedAt": "",
                    "ownerBy": {}
                }
            ],
            "pageNum": 0,
            "pageSize": 0,
            "total": 0
        },
        "showHiddenRuleList": [
            {}
        ],
        "viewRecords": {
            "body": [
                {
                    "groups": {},
                    "records": [
                        {
                            "createdAt": "",
                            "fields": {},
                            "id": "",
                            "lastModifiedAt": "",
                            "ownerBy": {}
                        }
                    ]
                }
            ],
            "pageNum": 0,
            "pageSize": 0,
            "total": 0
        }
    },
    "message": "",
    "timestamp": 0
}

二、新增一条记录

接口地址 https://www.yingxiongyun.com/worksheet/api/v1/t/app/{applicationId}/form/{formId}/records

请求方式 POST

consumes ["application/json"]

produces ["*/*"]

接口描述 新增一条记录

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
applicationId	应用ID	path	true	string
formId	表单ID	path	true	string
body	body	body	true	记录创建请求体	记录创建请求体

schema属性说明

记录创建请求体

参数名称	参数说明	请求类型	是否必须	数据类型	schema
authGroupId	权限组ID	body	true	string	默认：-1
fields	记录值	body	false	object
formId	工作表ID	body	false	string

响应状态

状态码	说明	schema
200	OK	响应结果对象«记录响应体»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code	结果码	integer(int32)	integer(int32)
data	结果数据	记录响应体	记录响应体
message	结果描述	string
timestamp	时间戳	integer(int64)	integer(int64)

schema属性说明

记录响应体

参数名称	参数说明	类型
fields	记录值	object
id	记录ID	string
ownerBy	拥有者	object

响应示例


xxxxxxxxxx
{
    "code": 0,
    "data": {
        "fields": {},
        "id": "",
        "ownerBy": {}
    },
    "message": "",
    "timestamp": 0
}

三、查看单条记录详情

接口地址 https://www.yingxiongyun.com/worksheet/api/v1/t/app/{applicationId}/form/{formId}/records/{recordId}

请求方式 GET

consumes ["application/json"]

produces ["*/*"]

接口描述 获取一条记录

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
applicationId	applicationId	path	true	string
formId	formId	path	true	string
recordId	recordId	path	true	string

响应状态

状态码	说明	schema
200	OK	响应结果对象«记录响应体»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code	结果码	integer(int32)	integer(int32)
data	结果数据	记录响应体	记录响应体
message	结果描述	string
timestamp	时间戳	integer(int64)	integer(int64)

schema属性说明

记录响应体

参数名称	参数说明	类型
fields	记录值	object
id	记录ID	string
ownerBy	拥有者	object

响应示例


xxxxxxxxxx
{
    "code": 0,
    "data": {
        "fields": {},
        "id": "",
        "ownerBy": {}
    },
    "message": "",
    "timestamp": 0
}

四、修改一条记录

接口地址 https://www.yingxiongyun.com/worksheet/api/v1/t/app/{applicationId}/form/{formId}/records/{recordId}

请求方式 PUT

consumes ["application/json"]

produces ["*/*"]

接口描述 修改一条记录

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
applicationId	applicationId	path	true	string
formId	formId	path	true	string
recordId	recordId	path	true	string
body	body	body	true	记录修改请求体	记录修改请求体

schema属性说明

记录修改请求体

参数名称	参数说明	请求类型	是否必须	数据类型
authGroupId	权限组ID	body	false	string
fields	记录值	body	false	object
formId	工作表ID	body	false	string
recordId	记录ID	body	false	string

响应状态

状态码	说明	schema
200	OK	响应结果对象«记录响应体»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code	结果码	integer(int32)	integer(int32)
data	结果数据	记录响应体	记录响应体
message	结果描述	string
timestamp	时间戳	integer(int64)	integer(int64)

schema属性说明

记录响应体

参数名称	参数说明	类型	schema
fields	记录值	object	key，value（组件ID，记录值）
id	记录ID	string
ownerBy	拥有者	object

响应示例


xxxxxxxxxx
{
    "code": 0,
    "data": {
        "fields": {},
        "id": "",
        "ownerBy": {}
    },
    "message": "",
    "timestamp": 0
}

五、删除记录

接口地址 https://www.yingxiongyun.com/worksheet/api/v1/t/app/{applicationId}/form/{formId}/records/batchUpdate

请求方式 PUT

consumes ["application/json"]

produces ["*/*"]

接口描述 修改批量记录

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
applicationId	applicationId	path	true	string
formId	formId	path	true	string
body	body	body	true	记录批量修改请求	记录批量修改请求

schema属性说明

记录批量修改请求

参数名称	参数说明	请求类型	是否必须	数据类型	schema
authGroupId	权限组ID	body	false	string	默认：-1
records	记录集合	body	false	array	记录修改请求体

记录修改请求体

参数名称	参数说明	请求类型	是否必须	数据类型	schema
authGroupId	权限组ID	body	false	string	默认：-1
fields	记录值	body	false	object
formId	工作表ID	body	false	string
recordId	记录ID	body	false	string

响应状态

状态码	说明	schema
200	OK	响应结果对象«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code	结果码	integer(int32)	integer(int32)
data	结果数据	boolean
message	结果描述	string
timestamp	时间戳	integer(int64)	integer(int64)

响应示例


xxxxxxxxxx
{
    "code": 0,
    "data": false,
    "message": "",
    "timestamp": 0
}