Searches for items within a folder using a query Returns ()
Both of the methods displayed search in a specified folder and, if selected, the children folders.
The top method returns all objects that match.
| Name | Description |
|---|---|
| folder | The folder to search in |
| query | The search query string |
| page | The page number for paginated results |
| pageSize | The Page Size (default is 1000). Maximum allowed value is 20000. |
| includeChildFolders | Whether to include items from child folders in the search |
| spanScope | Whether to span across scope boundaries |
| forTags | Filter results by specific tags |
| limit | Maximum number of results to return |
| includeParents | Whether to include parent folder information |
Example in C#
// Returns: IEnumerable<BaseInfo>
var baseInfo = await client.SearchAsync(FolderInfo folder, String query, Int32 page, Int32 pageSize, Boolean includeChildFolders, Boolean spanScope, String forTags, Int32 limit, Boolean includeParents);
Example in CURL
#General Search
curl -X GET \
'https://api.us.acresecurity.cloud/api/f/Instance.key?q=YOUR_QUERY&page=0&pageSize=1000&includeChildFolders=False&spanScope=False' \
-H 'Authorization: Bearer TOKEN_GOES_HERE'