Skip to content

docs: fix metadata attribute value filter example for 2.42+ [2.42] #1779

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.

Sign up for GitHub

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

Open
netroms wants to merge 1 commit into
base: 2.42
Choose a base branch
from
Open

docs: fix metadata attribute value filter example for 2.42+ [2.42] #1779

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions src/developer/web-api/metadata.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,11 +325,15 @@ query using the id property of the associated data element groups:

/api/dataElements.json?filter=dataElementGroups.id:eq:qfxEYY9xAl6

To get data elements with a particular attribute value for a metadata
attribute, a filter for the attribute ID and the attribute value can be
specified using the same collection query syntax:
To get data elements with a particular value for a metadata attribute,
use the attribute's ID as the property name in the filter:

/api/dataElements.json?filter=attributeValues.attribute.id:eq:n2xYlNbsfko&filter=attributeValues.value:eq:AFP
/api/dataElements.json?filter=n2xYlNbsfko:eq:AFP

To get data elements which have any value for a metadata attribute, use
the `!null` operator with the attribute's ID as the property name:

/api/dataElements.json?filter=n2xYlNbsfko:!null

Get data elements which have any option set:

Expand Down