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

searchString

The terms to be used in the search

Y

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

filterTypes

A listing of different content types to narrow the search

Y

ContentTypeObject [ ]

searchMatchType

Enumeration of the type osf search term matching

Y

SearchMatchType

startCreatedDate

Starting date for range searching on create dates

-

integer

Api2: int64 - epoch time in milliseconds, Api3: String according to iso8601

endCreatedDate

Ending date for range searching on create dates

-

integer

Api2: int64 - epoch time in milliseconds, Api3: String according to iso8601

startModifiedDate

Starting date for range searching on modified dates

-

integer

Api2: int64 - epoch time in milliseconds, Api3: String according to iso8601

endModifiedDate

Ending date for range searching on modified dates

-

integer

Api2: int64 - epoch time in milliseconds, Api3: String according to iso8601

server

Server name when searching by data source

-

string

model

Model name when searching by data source

-

string

dataBase

Database name when searching by data source

-

string

searchRootFolderType

Enumeration of which content domain to search in (private, public etc)

Y

SearchRootFolderType

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

allowFallback

Allows fall back in search

-

boolean

*Required elements are only used for API parameters

Usages
  • /API2/content/findContentItem
  • /API3/content/findContentItem