Skip to content

Commit 82f5240

Browse files
committed
make the v3 where clause explanation in page
1 parent a0044ab commit 82f5240

File tree

2 files changed

+23
-41
lines changed

2 files changed

+23
-41
lines changed

content/docs/developer-resources/rest-apis/index.mdx

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,3 +91,26 @@ For `isWithin` in `Date` and `DateTime` columns, the different set of sub-operat
9191
| ~or | (checkNumber,eq,JM555205)~or((amount,gt,200)~and(amount,lt,2000)) |
9292
| ~and | (checkNumber,eq,JM555205)~and((amount,gt,200)~and(amount,lt,2000)) |
9393
| ~not | ~not(checkNumber,eq,JM555205) |
94+
95+
## v3 Where Query Parameter
96+
97+
When calling v3 data api, the where clause has a slight difference with the previous versions. It allows values to be wrapped with quotes (double quotes, single quotes, or backticks) to safely use special characters that might otherwise break older version `where` clauses. This is particularly useful for strings containing commas, parentheses, or other delimiters.
98+
99+
**Example:** Searching for a phrase with special characters:
100+
`("My Field", "like", "Let's come home, and go straight to bed")`
101+
102+
**Another Example:** Searching for a value that includes a comma:
103+
`("Product Name", "=", "Laptop, 15-inch")`
104+
105+
**Example:** Using single quotes for a value:
106+
`(City, =, 'New York')`
107+
108+
### Usage on v2 API
109+
110+
The v3 `where` clause can also be utilized when using the v2 API by prepending the `where` clause with an `@` sign. This allows you to leverage the advanced capabilities of the v3 `where` clause even in v2 API calls.
111+
112+
**Example:** Using a v3 `where` clause to check for non-blank titles in a v2 API call:
113+
`@("Title", not, blank)`
114+
115+
**Another Example:** Combining multiple conditions with special characters in a v2 API call:
116+
`@("Description", "like", "High-performance, water-resistant")`

content/docs/developer-resources/rest-apis/v3-where-clause.mdx

Lines changed: 0 additions & 41 deletions
This file was deleted.

0 commit comments

Comments
 (0)