GetDocumentsByQuery
≥4.5
接口功能
在Form Design中提前创建好Query,通过指定Query查询document。
接口将根据Query中配置的条件、查询返回列等信息查询数据并返回结果。
请求参数
参数 | 是否必填 | 类型 | 说明 |
---|---|---|---|
input | true | DocumentsByQueryInput | 实体包含QueryAlias, Index, Size等属性 |
[warning] 注意
- SearchValues中的 key需要与 Query Filter中的 key完全一致。即SearchValues中的 key应该是
@@
开头的字符串。- 如果在 SearchValues中找不到 Query Filter中定义的条件,则忽略该条件。
- 如果出现查询慢问题,可以尝试调整Query Filter的顺序,或者减小Size大小。
返回数据类型(Data部分)
List<string>
调用示例
{
"QueryAlias": "l9wbd61s3ot",
"Index": 0,
"Size": 10,
"SearchValue": {
"@@textbx_address": "Beijing Chaoyang"
},
"StaffCode": "##200217042712778"
}
返回示例
{
"StatusCode": 200,
"Info": "Request (or process) succeeded",
"Data": [
"{\"UserName\":\"DemoUser\",\"Title\":\"test title\",\"Description\":\"<p>test description</p>\\n\",\"C4-WorkflowStateDisplayName\":\"Submitted\",\"C4-CreateBy\":\"DemoUser\",\"C4-CreateDate\":1551750038751}",
"{\"UserName\":\"DemoUser\",\"Title\":\"111\",\"Description\":\"<p>222</p>\\n\",\"C4-CreateBy\":\"DemoUser\",\"C4-CreateDate\":1551772461235}"
]
}