l4i
...
Box Connection
Search
Search
2min
The Search method performs the same search as the Box UI. It will query against the Box search index.
Box keeps a search index for any files or folders stored in Box. Every time a file or folder is changed, those words are added to the index. When a search is performed, the API looks in the search index for files and folders that match the query. When content is added, updated, or deleted in Box, the search index is updated accordingly.
A FEW NOTES:
- It can take time between uploading or modifying a file for it to be fully indexed and ready to be searched. In most cases, newly added or changed files can be expected to be available via Box search in 10 minutes. The current service load determines the index time and it may take more than 10 minutes in some cases
- Only content that the authenticated user has access to (items they can preview and/or view) will be returned in the search results
- The Box search index stores up to 10,000 bytes (~10,000 characters in English) per document for accounts from Business level and above. This amount can vary from document to document because of language, Box’s indexing method, and document type
- Search only indexes content from the current version of a document, so that you do not have to sift through hundreds of irrelevant search results of outdated documents. You cannot use search to query non-current versions of a document
Input Parameters:
- Item Type: Allows filtering of result set to specific Box Item types
- All (all item types included)
- File (only Files)
- Folder (only Folders)
- Web Link (only Web Links)
- Search In Folder(s): (Optional) One or more Folders to constrain the search against. Otherwise it will search against all content the configured connection has access to
- Limit: Maximum number of search results to return
- Query Text: Free form text field that works the same was as the 'Search files and folders' UI element in the Box client. All of the same rules (query operators/formatting) that can be used in the UI will work.
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