Skip to content

Commit 5f151f8

Browse files
committed
Merge pull request #105 from royka/add-metadata-search-examples
Adding metadata search examples (fixes #104)
2 parents 2d2a585 + 15643b6 commit 5f151f8

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,22 @@ Search
173173
174174
client.search('some_query', limit=100, offset=0)
175175
176+
Metadata Search
177+
~~~~~~~~~~~~~~~
178+
179+
.. code-block:: python
180+
181+
from boxsdk.object.search import MetadataSearchFilter, MetadataSearchFilters
182+
183+
metadata_search_filter = MetadataSearchFilter(template_key='marketingCollateral', scope='enterprise')
184+
metadata_search_filter.add_value_based_filter(field_key='documentType', value='datasheet')
185+
metadata_search_filter.add_value_based_filter(field_key='clientNumber', value='a123')
186+
187+
metadata_search_filters = MetadataSearchFilters()
188+
metadata_search_filters.add_filter(metadata_search_filter)
189+
190+
client.search('some_query', limit=100, offset=0, metadata_filters=metadata_search_filters)
191+
176192
Events
177193
~~~~~~
178194

0 commit comments

Comments
 (0)