Metadata Search

this method will perform a box search against one or more enterprise metadata fields note only content that the authenticated user has access to (items they can preview and/or view) will be returned in the search results input parameters parent folder id (optional) a folder(s) to constrain the search against otherwise it will search against all content the configured connection has access to item type allows for return of files, folders or both limit maximum number of files returned in the query metadata template key the box api metadata template key to search against query expression this is the box api query that will be run for this example the value is claimnumber = \ claimnumberval claimnumber is the metadata field that is part of the metadata template key defined previously = is the operator (equals) see the online box api documentation for additional operators supported for each data type \ claimnumberval the colon is required and the claimnumberval is a user created parameter that will be passed in at run time to supply any user created run time parameters, click on the pencil in the top right of the input parameters section and create a new 'query parameter' in this example the claimnumberval was created to match the value used in the query expression box optionally a sort by field and sort direction can be included note the values are not changed on this screen but back in the main method screen sort by field use the metadata template value to sort by sort direction choose ascending or descending in the dropdown output entity this section allows for configuration any metadata fields that should be returned into the pipeline for processing click on the pencil icon in the output entity section once in the entity attributes screen, drag an enterprise metadata value from the left into the center secion name what you would like it to display as in the attribute list binding the exact value of the box metadata template value (i e claimnumber) click ' convert data type ' and choose the converted data type value of the box metadata template the following screenshot shows an example of a configured metadata search method this will search box for all documents where the metadata template 'claim' field 'claimstatus' has a string value of complete it will then sort on claimstatus and the resulting set of documents will also include the metadata values for 'claimnumber'