ContentSearchParamsObject
The content search object for specifying search criteria to be used in content searches.
API Section: Objects
Type: Object
Properties
Name |
Description |
Required |
Type |
Format |
---|---|---|---|---|
server |
Server name when searching by data source |
- |
string |
|
dataBase |
Database name when searching by data source |
- |
string |
|
folderPathToSearch |
This is a folder path to use in searching. Use in the format Tenant-Name\Root-Folder-name\folderA\folderB\..... using the folder captions, not their IDs |
- |
string |
|
isAdvancedSearch |
Boolean to indicate if this is an advanced search. Advanced searches will use other provided criteria. Otherwise, the simple search will just use the search string only |
- |
boolean |
|
searchRootFolderType |
Enumeration of which content domain to search in (private, public etc) |
Y |
||
startModifiedDate |
Starting date for range searching on modified dates |
- |
integer |
Api2: int64 - epoch time in milliseconds, Api3: String according to iso8601 |
searchString |
The terms to be used in the search |
Y |
string |
|
searchMatchType |
Enumeration of the type osf search term matching |
Y |
||
endModifiedDate |
Ending date for range searching on modified dates |
- |
integer |
Api2: int64 - epoch time in milliseconds, Api3: String according to iso8601 |
startCreatedDate |
Starting date for range searching on create dates |
- |
integer |
Api2: int64 - epoch time in milliseconds, Api3: String according to iso8601 |
model |
Model name when searching by data source |
- |
string |
|
endCreatedDate |
Ending date for range searching on create dates |
- |
integer |
Api2: int64 - epoch time in milliseconds, Api3: String according to iso8601 |
filterTypes |
A listing of different content types to narrow the search |
Y |
||
allowFallback |
Allows fall back in search |
- |
boolean |
*Required elements are only used for API parameters