Querying records with logical filters

From DreamFactory
Jump to: navigation, search
DreamFactoryTutorialsQuerying records with logical filters
Line 7: Line 7:
 
### API Endpoint
 
### API Endpoint
  
<pre>GET https://{your-url}/api/v2/{your-api-name}/_table/{table_name}?filter={your-filter-string}</pre>
+
<pre>GET https://{url}/api/v2/{api_name}/_table/{table_name}?filter={filter_string}</pre>
  
 
### API Docs Screenshot
 
### API Docs Screenshot
Line 17: Line 17:
 
* Table name: contact
 
* Table name: contact
 
* Filter parameter in API call: <pre>last_name like Y%</pre>
 
* Filter parameter in API call: <pre>last_name like Y%</pre>
* Request URL: <pre>https://your-url/api/v2/db/_table/contact?filter=last_name%20like%20Y%25</pre>
+
* Request URL: <pre>https://foo.com/api/v2/db/_table/contact?filter=last_name%20like%20Y%25</pre>
  
 
### Example - Query contact records whose last name is 'Yang'
 
### Example - Query contact records whose last name is 'Yang'
Line 23: Line 23:
 
* Table name: contact
 
* Table name: contact
 
* Filter parameter in API call: <pre>last_name = Yang</pre>
 
* Filter parameter in API call: <pre>last_name = Yang</pre>
* Request URL: <pre>https://your-url/api/v2/db/_table/contact?filter=last_name%20%3D%20Yang</pre>
+
* Request URL: <pre>https://foo.com/api/v2/db/_table/contact?filter=last_name%20%3D%20Yang</pre>
  
 
### Example - Query contact records whose first name is 'Jon' and last name is 'Yang'
 
### Example - Query contact records whose first name is 'Jon' and last name is 'Yang'
Line 29: Line 29:
 
* Table name: contact
 
* Table name: contact
 
* Filter parameter in API call: <pre>first_name = Jon and last_name = Yang</pre>
 
* Filter parameter in API call: <pre>first_name = Jon and last_name = Yang</pre>
* Request URL: <pre>https://your-url/api/v2/db/_table/contact?filter=first_name%20%3D%20Jon%20and%20last_name%20%3D%20Yang</pre>
+
* Request URL: <pre>https://foo.com/api/v2/db/_table/contact?filter=first_name%20%3D%20Jon%20and%20last_name%20%3D%20Yang</pre>
  
 
### Example - Query contact records whose first name starts with 'J' and last name starts with 'Y'
 
### Example - Query contact records whose first name starts with 'J' and last name starts with 'Y'
Line 35: Line 35:
 
* Table name: contact
 
* Table name: contact
 
* Filter parameter in API call: <pre>first_name like J% and last_name like Y%</pre>
 
* Filter parameter in API call: <pre>first_name like J% and last_name like Y%</pre>
* Request URL: <pre>https://your-url/api/v2/db/_table/contact?filter=first_name%20like%20J%25%20and%20last_name%20like%20Y%25</pre>
+
* Request URL: <pre>https://foo.com/api/v2/db/_table/contact?filter=first_name%20like%20J%25%20and%20last_name%20like%20Y%25</pre>
  
 
### Example - Query contact records whose Twitter handle contains 'jon' or whose Skype handle contains 'jon'
 
### Example - Query contact records whose Twitter handle contains 'jon' or whose Skype handle contains 'jon'
Line 41: Line 41:
 
* Table name: contact
 
* Table name: contact
 
* Filter parameter in API call: <pre>twitter like %jon% or skype like %jon%</pre>
 
* Filter parameter in API call: <pre>twitter like %jon% or skype like %jon%</pre>
* Request URL: <pre>https://your-url/api/v2/db/_table/contact?filter=twitter%20like%20%25jon%25%20or%20skype%20like%20%25jon%25</pre>
+
* Request URL: <pre>https://foo.com/api/v2/db/_table/contact?filter=twitter%20like%20%25jon%25%20or%20skype%20like%20%25jon%25</pre>

Revision as of 01:22, 22 September 2015

      1. Tutorial

Query a SQL or NoSQL database with a filter string. Try these examples in the 'API Docs' tab of the DreamFactory Admin Console or from the command line with cURL.

Note that filter strings are simply SQL queries with ordinary SQL operators, including <, <=, >, >=, =, or, and, like.

      1. API Endpoint
GET https://{url}/api/v2/{api_name}/_table/{table_name}?filter={filter_string}
      1. API Docs Screenshot

Swagger-filter.png

      1. Example - Fetch contact records whose last name starts with 'Y'
  • Table name: contact
  • Filter parameter in API call:
    last_name like Y%
  • Request URL:
    https://foo.com/api/v2/db/_table/contact?filter=last_name%20like%20Y%25
      1. Example - Query contact records whose last name is 'Yang'
  • Table name: contact
  • Filter parameter in API call:
    last_name = Yang
  • Request URL:
    https://foo.com/api/v2/db/_table/contact?filter=last_name%20%3D%20Yang
      1. Example - Query contact records whose first name is 'Jon' and last name is 'Yang'
  • Table name: contact
  • Filter parameter in API call:
    first_name = Jon and last_name = Yang
  • Request URL:
    https://foo.com/api/v2/db/_table/contact?filter=first_name%20%3D%20Jon%20and%20last_name%20%3D%20Yang
      1. Example - Query contact records whose first name starts with 'J' and last name starts with 'Y'
  • Table name: contact
  • Filter parameter in API call:
    first_name like J% and last_name like Y%
  • Request URL:
    https://foo.com/api/v2/db/_table/contact?filter=first_name%20like%20J%25%20and%20last_name%20like%20Y%25
      1. Example - Query contact records whose Twitter handle contains 'jon' or whose Skype handle contains 'jon'
  • Table name: contact
  • Filter parameter in API call:
    twitter like %jon% or skype like %jon%
  • Request URL:
    https://foo.com/api/v2/db/_table/contact?filter=twitter%20like%20%25jon%25%20or%20skype%20like%20%25jon%25