GetDocumentsByQuery

≥4.5

Interface Function

Create query in Form Design, and then query document by specified query.

Interface queries the data and returns the results according to the conditions configured in query, information of return columns, and so on.

Request Parameter

[warning] Note

• The key in SearchValues needs to be exactly the same as the one in Query Filter, which is the key in SearchValues should be a string beginning with @@.
• If the condition defined in Query Filter cannot be found in SearchValues, ignore the condition.
• If the query is slow, adjust the order of Query Filter or reduce the Size.

Return Data Type(Data)

List<string>

Input Sample

{
  "QueryAlias": "ewbtlegh2bn",
  "Index": 0,
  "Size": 10,
  "SearchValues": {
    //Note the key here is begninning with @@.
    "@@creator":"DemoUser"
  },
  "StaffCode":"##190111031015539"
}

Return Sample

{
  "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}"
  ]
}

Code example

{
    "QueryAlias": "l9wbd61s3ot",
    "Index": 0,
    "Size": 10,
    "SearchValue": {
        "@@textbx_address": "Beijing Chaoyang"
    },
    "StaffCode": "##200217042712778"
    }