DocumentsByQueryInput
Interface Function
Parameter entity for calling GetDocumentsByQuery
Attribute
| Attribute | Required | Type | Remarks |
|---|---|---|---|
| QueryAlias | true | string | Specify the Query used |
| Index | true | int | The position where the query result starts |
| Size | true | int | Number of query results |
| SearchValues | true | Dictionary<string,string> |
The value of the Customisation type Filter defined in Query |
| StaffCode | false | string | If user-related information is used in the Filter, the staffCode of the corresponding user needs to be passed |
| Locale | false | string | Sorting rules (optional parameters: en_US, zh) |
[warning] note
- The key in SearchValues needs to be exactly the same as the key in Query Filter. That is, the key in SearchValues should be a string starting with
@@. - If the condition defined in the Query Filter is not found in SearchValues, the condition is ignored.
- If there is a problem of slow query, you can try to adjust the order of Query Filter or reduce the size.