Querying records with an ID list

From DreamFactory
Jump to: navigation, search
DreamFactoryTutorialsQuerying records with an ID list
Line 11: Line 11:
 
[[File:Swagger-ids.png|1000px]]
 
[[File:Swagger-ids.png|1000px]]
  
### Example - Fetch contact records with IDs of 1, 2, and 3
+
### Example - GET contact records with IDs 1, 2, and 3
  
 
* Table name: contact
 
* Table name: contact
 
* IDs parameter in API call: <pre>1, 2, 3</pre>
 
* IDs parameter in API call: <pre>1, 2, 3</pre>
 
* Request URL: <pre>https://foo.com/api/v2/db/_table/contact?ids=1%2C%202%2C%203</pre>
 
* Request URL: <pre>https://foo.com/api/v2/db/_table/contact?ids=1%2C%202%2C%203</pre>

Revision as of 17:16, 15 October 2015

      1. Tutorial

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

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

Swagger-ids.png

      1. Example - GET contact records with IDs 1, 2, and 3
  • Table name: contact
  • IDs parameter in API call:
    1, 2, 3
  • Request URL:
    https://foo.com/api/v2/db/_table/contact?ids=1%2C%202%2C%203