FileSearch
A complex data type that represents a file search.
Elements
Condition
FileCondition. Optional. The search condition. Specify either this parameter or ConditionArray.
ConditionArray
ArrayOfFileCondition. Optional. An array of search conditions. Use if search conditions apply to multiple fields.
Owner
String. Optional. The file owner.
DependentFileName
String. Optional. The name of the dependent file. Specify one of this parameter, DependentFileId, RequiredFileName, or RequiredFileId.
DependentFileId
String. Optional. The ID of the dependent file. Specify one of this parameter, DependentFileName, RequiredFileName, or RequiredFileId.
RequiredFileName
String. Optional. The name of the required file. Specify one of this parameter, DependentFileName, DependentFileId, or RequiredFileId.
RequiredFileId
String. Optional. The ID of the required file. Specify one of this parameter, DependentFileName, DependentFileId, or RequiredFileName.
PrivilegeFilter
PrivilegeFilter. Optional. The privileges for which to search. Use PrivilegeFilter to determine whether the specified user or user group has the specified privileges on the file.
AccessType
FileAccess. Optional. The file’s access type. Valid values are:
*Private
Only the owner of the file and an administrator can access the file.
*Shared
All users and user groups specified in the access control list (ACL) for the file can access the file.
FetchSize
Int. Optional. The maximum number of records to retrieve and return in a result set. The default value is 500.
FetchDirection
Boolean. Optional. If True, records are retrieved forward. If False, records are retrieved backward. The default value is True.
CountLimit
Int. Optional. The maximum number of records to count. By default, CountLimit is equal to FetchSize. To count all records, set CountLimit to ‑1.
FetchHandle
String. Optional. Retrieves more items from the result set. In the second and subsequent calls for data, specifies the same search criteria as in the original call.
IncludeHiddenObject
Boolean. Optional. Flag indicating if search should include hidden objects.