Paginating with limits and offsets
From DreamFactory
| Line 14: | Line 14: | ||
[[File:Swagger-offset.png|1000px]] | [[File:Swagger-offset.png|1000px]] | ||
| − | ### Example - | + | ### Example - GET the first set of ten contact records (records 1 through 10, inclusive) |
* Table name: contact | * Table name: contact | ||
| Line 21: | Line 21: | ||
* Request URL: <pre>https://foo.com/api/v2/db/_table/contact?limit=10&offset=0</pre> | * Request URL: <pre>https://foo.com/api/v2/db/_table/contact?limit=10&offset=0</pre> | ||
| − | ### Example - | + | ### Example - GET the second set of ten contact records (records 11 through 20, inclusive) |
* Table name: contact | * Table name: contact | ||
Revision as of 17:21, 15 October 2015
- Tutorial
Use limit and offset parameters to paginate records. Try these examples in the 'API Docs' tab of the DreamFactory Admin Console or from the command line with cURL.
Note that offset i returns record i+1 as the first record in the set (for example, offset = 0 returns record 1 as the first record in the set, offset =10 returns record 11 as the first record in the set, and so forth).
- API Endpoint
GET https://{url}/api/v2/{api_name}/_table/{table_name}?limit={record_limit}&offset={offset_number}
- API Docs Screenshot
- Example - GET the first set of ten contact records (records 1 through 10, inclusive)
- Table name: contact
- Limit parameter in API call:
10
- Offset parameter in API call:
0
- Request URL:
https://foo.com/api/v2/db/_table/contact?limit=10&offset=0
- Example - GET the second set of ten contact records (records 11 through 20, inclusive)
- Table name: contact
- Limit parameter in API call:
10
- Offset parameter in API call:
10
- Request URL:
https://foo.com/api/v2/db/_table/contact?limit=10&offset=10
