NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-08-15 20:18:17 -06:00
Code Issues Actions 10 Packages Projects Releases Wiki Activity

Update docs/integrations/graphql-api.md

Browse Source 
Co-authored-by: Jeremy Stretch <jstretch@netboxlabs.com>
This commit is contained in:
Arthur Hanson 2024-03-29 10:45:29 -07:00 committed by GitHub
parent f0945edfcb
commit dd22870544
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/integrations/graphql-api.md
View File

@ -54,7 +54,11 @@ For more detail on constructing GraphQL queries, see the [Graphene documentation
The GraphQL API employs the same filtering logic as the UI and REST API. Filters can be specified as key-value pairs within parentheses immediately following the query name. For example, the following will return only sites within the North Carolina region with a status of active:
```
{"query": "query {site_list(filters: {region: "us-nc\", status: "active"}) {name}}"}
query {
site_list(filters: {region: "us-nc", status: "active"}) {
name
}
}
```
In addition, filtering can be done on list of related objects as shown in the following query: