Standard URL Query String¶
A number of endpoints support URL query string to enable the following functionalities:
- paging
- external JSON format
/api/repositories/test/entities?pageStart=1&pageSize=100&external=1
| Parameter | Type | Purpose |
|---|---|---|
| pageStart | int | The row number to start the page from. |
| pageSize | int | The maximum number of rows to return starting from the row specified in the pageStart. |
| external | int | Return rows as key/value pairs to support external clients. |
Paging¶
The paging options allow the data to be returned in smaller chunks. This is essential when processing tables that contain non-trivial datasets. Paging the data increases responsiveness and performance, and allows the data to be processed without restrictions on memory size.
A standard HTTP GET request does not support a Standard Request packet in the body of the URL, hence a number of endpoints support paging options using URL query string as shown below.
For example - get the first 65 rows of data:
GET /api/repositories/test/entities?pageStart=1&pageSize=65
| Parameter | Type | Purpose |
|---|---|---|
| pageStart | int | The row number to start the page from. |
| pageSize | int | The maximum number of rows to return starting from the row specified in the pageStart. |
External JSON Format¶
A number of endpoints now support returning the underlying data rows in a JSON key/value pairs format. This allows access by different tools that requires the JSON data in a key/value pair instead of standard array of row data with columns names defined separately.
A standard HTTP GET request does not support a Standard Request packet in the body of the URL, hence a number of endpoints support external JSON format using URL query string as shown below.
For example - get list of entities in external JSON format:
GET /api/repositories/test/entities?external=1
| Parameter | Type | Purpose |
|---|---|---|
| external | int | Return rows as key/value pairs if set to 1 to support external clients; returns normal view data if not set. |
When external JSON format is selected, the row data will be returned as JSON key/value pair.