Api4 - Support wildcard * in select clause #16302
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
Allows you to incorporate the
*
wildcard into the SELECT clause of Api4 Get actions, greatly improving convenience especially when using joins & custom fields.Before
Every field must be selected individually. There's no "select all" or "select all fields that start with ___".
After
Fields can be selected en-masse with the
*
wildcard. This is supported across joins and also works with partial fieldname matching. E.g.select: ['*_name']
would match first_name, last_name, display_name, etc. Or you can doselect: ['*', 'emails.*', 'constituent_information.*']
to select all core fields, plus all fields from a join and all fields from a custom group.Comments
Tests and Api Explorer support added.