Skip to content

Commit 238fa70

Browse files
muTeREdOFrank Clementsjeremystretch
authored
add example showing how to order results. (#15627)
* add example showing how to order results. This addresses issue 15622 by building off filtering example to show how to order results on a named field. * Apply suggestions from code review --------- Co-authored-by: Frank Clements <[email protected]> Co-authored-by: Jeremy Stretch <[email protected]>
1 parent 3b3511c commit 238fa70

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

docs/integrations/rest-api.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,13 +85,19 @@ Each model generally has two views associated with it: a list view and a detail
8585
* `/api/dcim/devices/` - List existing devices or create a new device
8686
* `/api/dcim/devices/123/` - Retrieve, update, or delete the device with ID 123
8787

88-
Lists of objects can be filtered using a set of query parameters. For example, to find all interfaces belonging to the device with ID 123:
88+
Lists of objects can be filtered and ordered using a set of query parameters. For example, to find all interfaces belonging to the device with ID 123:
8989

9090
```
9191
GET /api/dcim/interfaces/?device_id=123
9292
```
9393

94-
See the [filtering documentation](../reference/filtering.md) for more details.
94+
An optional `ordering` parameter can be used to define how to sort the results. Building off the previous example, to sort all the interfaces in reverse order of creation (newest to oldest) for a device with ID 123:
95+
96+
```
97+
GET /api/dcim/interfaces/?device_id=123&ordering=-created
98+
```
99+
100+
See the [filtering documentation](../reference/filtering.md) for more details on topics related to filtering, ordering and lookup expressions.
95101

96102
## Serialization
97103

0 commit comments

Comments
 (0)