NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-07-14 01:41:22 -06:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity

15552 graphql docs (#15578)

Browse Source 
* 15552 update query

* 15552 update query

* 15552 update query

* Update docs/integrations/graphql-api.md

Co-authored-by: Jeremy Stretch <jstretch@netboxlabs.com>

---------

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

8
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: 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(region:\"north-carolina\", 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: In addition, filtering can be done on list of related objects as shown in the following query:
@ -63,7 +67,7 @@ In addition, filtering can be done on list of related objects as shown in the fo
device_list { device_list {
id id
name name
interfaces(enabled: true) { interfaces(filters: {enabled: true}) {
name name
} }
} }