查询表单实例数据
POST
/v1.0/yida/forms/instances/search最后修改时间:: 2 年前
责任人: 未设置
说明
调用本接口查询表单实例数据。
服务地址:api.dingtalk.com
权限
要调用此API,需要以下权限之一。
应用类型 | 是否支持 | 权限 | API Explorer调试 |
---|---|---|---|
企业内部应用 | 支持 | 宜搭表单数据读权限 | API Explorer |
第三方企业应用 | 支持 | 宜搭表单数据读权限 | API Explorer |
第三方个人应用 | 暂不支持 | 宜搭表单数据读权限 | 暂不支持 |
错误码
HttpCode | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | invalidParameter.methodInputs.invalidFormat | 数据格式错误:%s | 数据格式错误 |
400 | invalidParameter.number.exceed | 数字超过限制:%s | 数字超过限制 |
400 | invalidParameter.methodInputs.invalid | 入参校验失败:%s | 入参校验失败 |
400 | dataNotExist.form.notExists | 表单不存在:%s | 表单不存在 |
500 | dataModified.form.formAlreadyModified | 实例数据已修改, 请刷新当前页面:%s | 实例数据已经修改 |
500 | unclassifiedError | 异常:%s | 通用异常信息 |
请求参数
Header 参数
x-acs-dingtalk-access-token
string
必需
调用该接口的访问凭证。如何获取不同应用的凭证请参考访问凭证概述。
Body 参数application/json
appType
string
应用编码。
systemToken
string
必需
应用秘钥。在应用数据中获取。
userId
string
用户userid。
language
string
语言。取值:
formUuid
string
表单ID。
searchFieldJson
string
可选
根据表单内组件值查询,示例值如下:
currentPage
integer
分页参数,当前页。
pageSize
integer
可选
分页参数,每页显示条数。
originatorId
string
可选
根据数据提交人工号查询。
createFromTimeGMT
string
可选
查询创建数据列表的开始时间,格式:yyyy-MM-dd。
createFromTimeGMT和createToTimeGMT两个时间构造一个时间段,查询在该时间段创建的数据列表。
createToTimeGMT
string
可选
查询创建数据列表的结束时间,格式:yyyy-MM-dd。
createFromTimeGMT和createToTimeGMT两个时间构造一个时间段,查询在该时间段创建的数据列表。
modifiedFromTimeGMT
string
可选
查询修改数据列表的开始时间,格式:yyyy-MM-dd。
modifiedFromTimeGMT和modifiedTo构成一个时间段,查询在该时间段有修改的数据列表。
modifiedToTimeGMT
string
可选
查询修改数据列表的结束时间,格式:yyyy-MM-dd。
modifiedFromTimeGMT和modifiedTo构成一个时间段,查询在该时间段有修改的数据列表。
dynamicOrder
string
指定排序字段。
示例
{}
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
currentPage
integer
分页参数,当前页。
totalCount
integer
可选
符合条件的实例总数。
data
array [object {16}]
实例详情列表。
dataId
integer
实体主键ID。
formInstanceId
string
表单实例ID。
createdTimeGMT
string
数据创建时间。
modifiedTimeGMT
string
最近修改时间。
formUuid
string
表单uid。
modelUuid
string
模型uid。
originator
object
发起人信息。
modifyUser
object
修改者信息。
formData
object
可选
表单数据,示例值如下:
title
string
标题。
serialNo
string
流水号。
instanceValue
string
可选
表单实例原始格式值。
version
integer
数据版本。
creatorUserId
string
可选
创建人的userid。
modifierUserId
string
可选
修改人的userid。
sequence
string
批次号。
示例
{
"currentPage": 0,
"totalCount": 0,
"data": [
{
"dataId": 0,
"formInstanceId": "string",
"createdTimeGMT": "string",
"modifiedTimeGMT": "string",
"formUuid": "string",
"modelUuid": "string",
"originator": {
"userId": "string",
"userName": {
"nameInChinese": "string",
"nameInEnglish": "string",
"type": "string"
},
"departmentName": "string",
"email": "string"
},
"modifyUser": {
"userId": "string",
"userName": {
"nameInChinese": "string",
"nameInEnglish": "string",
"type": "string"
},
"departmentName": "string",
"email": "string"
},
"formData": {},
"title": "string",
"serialNo": "string",
"instanceValue": "string",
"version": 0,
"creatorUserId": "string",
"modifierUserId": "string",
"sequence": "string"
}
]
}
最后修改时间: 2 年前