Skip to content

Commit

Permalink
add example showing how to order results. (#15627)
Browse files Browse the repository at this point in the history
* 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]>
  • Loading branch information
3 people authored Apr 4, 2024
1 parent 3b3511c commit 238fa70
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions docs/integrations/rest-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,13 +85,19 @@ Each model generally has two views associated with it: a list view and a detail
* `/api/dcim/devices/` - List existing devices or create a new device
* `/api/dcim/devices/123/` - Retrieve, update, or delete the device with ID 123

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:
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:

```
GET /api/dcim/interfaces/?device_id=123
```

See the [filtering documentation](../reference/filtering.md) for more details.
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:

```
GET /api/dcim/interfaces/?device_id=123&ordering=-created
```

See the [filtering documentation](../reference/filtering.md) for more details on topics related to filtering, ordering and lookup expressions.

## Serialization

Expand Down

0 comments on commit 238fa70

Please sign in to comment.