From cfe747f3dbb2bd882fdd94da39d7b539baf982d4 Mon Sep 17 00:00:00 2001 From: Sam Clift Date: Tue, 5 Jan 2016 16:42:20 +0000 Subject: [PATCH] Adding metadata search examples (fixes #104) --- README.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.rst b/README.rst index f6b68c569..2459c923d 100644 --- a/README.rst +++ b/README.rst @@ -173,6 +173,22 @@ Search client.search('some_query', limit=100, offset=0) +Metadata Search +~~~~~~~~~~~~~~~ + +.. code-block:: python + + from boxsdk.object.search import MetadataSearchFilter, MetadataSearchFilters + + metadata_search_filter = MetadataSearchFilter(template_key='marketingCollateral', scope='enterprise') + metadata_search_filter.add_value_based_filter(field_key='documentType', value='datasheet') + metadata_search_filter.add_value_based_filter(field_key='clientNumber', value='a123') + + metadata_search_filters = MetadataSearchFilters() + metadata_search_filters.add_filter(metadata_search_filter) + + client.search('some_query', limit=100, offset=0, metadata_filters=metadata_search_filters) + Events ~~~~~~