Box Search
Use this activity to search files in your Box account. It performs a text search for file names and directory names, but the content within files is not searched.
Configuration
This tab has the following fields.
| Field | Description |
|---|---|
| Connection | The name of the Box connection. If you have multiple Box connections, select the one that you want to access using this activity. |
Input
| Field | Description |
|---|---|
| startPath | The full path to the folder from which to start searching. (path must start with "/"). |
| searchText | The text in the file name or directory name. You have the option to search using a partial string. For example, if the file name is "myfile", searching by "my" or "file" will result in search output showing "myfile". |
| pageSize | pageSize controls how many search results items you would like to see on each page. For example, if you specify 25, you will get a maximum of 25 search result items on each page.
It defaults to 20 if the field is left blank. You can use this field combined with the pageNum filed to control the volume of search results in the output. |
| pageNum | pageNum is the page number of paginated result that you want to display. For example, if you set pageSize to 20 and pageNum to 4, and 100 files match the search criteria, there will be 5 pages with 20 items on each page (1-20 file names on page 1, 21- 40 on page 2, 41-60 on page 3, 61-80 on page 4, and 81-100 on page 5) . Since you set pageNum to 4, the search will display only what appears on page 4 (61-80), hence it skips the first 60 file names on the first three pages of the result and also the last 20 file names on the fifth page.
It defaults to 1 if the field is left blank. You can use this field combined with the pageNum filed to control the volume of search results in the output. |
Output
| Field | Description |
|---|---|
| files | An array of metadata objects for all the files or directories that match the search criteria. |
| error | Any errors encountered when searching for the information is output using the errorCode and message output fields. |