Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for querying custom fields in API missing #2138

Closed
friek opened this issue Jun 3, 2018 · 1 comment
Closed

Documentation for querying custom fields in API missing #2138

friek opened this issue Jun 3, 2018 · 1 comment
Labels
status: accepted This issue has been accepted for implementation type: documentation A change or addition to the documentation

Comments

@friek
Copy link

friek commented Jun 3, 2018

Issue type

[ ] Feature request
[ ] Bug report
[X] Documentation

Environment

  • Python version: 3.6.2
  • NetBox version: 2.3.4-dev

Description

After hours of searching through documentation and source code how to query custom fields through the API, I eventually found out that this is actually possible by adding a cf_customfieldname=search_value as a query parameter.

This isn't very obvious unfortunately and I can't find anything in the documentation describing this functionality. Therefore, I think it'd be handy to add proper documentation on the API documentation site.

Thanks.

@jeremystretch jeremystretch added type: documentation A change or addition to the documentation status: accepted This issue has been accepted for implementation labels Jun 6, 2018
@a31amit
Copy link

a31amit commented Jun 11, 2018

@friek Thanks for even reporting here, I was struggling with the same thing. It is very useful.

@lock lock bot locked as resolved and limited conversation to collaborators Jan 17, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
status: accepted This issue has been accepted for implementation type: documentation A change or addition to the documentation
Projects
None yet
Development

No branches or pull requests

3 participants