FileSearch
A complex data type that represents a file search.
Schema
<xsd:complexType name="FileSearch">
<xsd:sequence>
<xsd:choice minOccurs=”0”>
<xsd:element name="Condition"
type="typens:FileCondition">
<xsd:element name="ConditionArray"
type="typens:ArrayOfFileCondition"/>
</xsd:choice>
<xsd:element name="Owner" type="xsd:string" minOccurs="0"/>
<xsd:choice minOccurs="0">
<xsd:element name="DependentFileName" type="xsd:string"/>
<xsd:element name="DependentFileId" type="xsd:string"/>
<xsd:element name="RequiredFileName" type="xsd:string"/>
<xsd:element name="RequiredFileId" type="xsd:string"/>
<xsd:element name="PrivilegeFilter"
type="typens:PrivilegeFilter"/>
</xsd:choice>
<xsd:element name="AccessType" type="typens:FileAccess"
minOccurs="0"/>
<xsd:element name="FetchSize" type="xsd:int" minOccurs="0"/>
<xsd:element name="FetchDirection" type="xsd:boolean" minOccurs="0"/>
<xsd:element name="CountLimit" type="xsd:int" minOccurs="0"/>
<xsd:element name="FetchHandle" type="xsd:string"
minOccurs="0"/>
<xsd:element name="IncludeHiddenObject" type="xsd:boolean"
minOccurs="0" />
</xsd:sequence>
</xsd:complexType>
Elements
Condition
The search condition.
ConditionArray
An array of search conditions. Use if search conditions apply to multiple fields.
Owner
The file owner.
DependentFileName
The name of the dependent file.
DependentFileId
The ID of the dependent file.
RequiredFileName
The name of the required file.
RequiredFileId
The ID of the required file.
PrivilegeFilter
The privileges for which to search. Use PrivilegeFilter to determine whether the specified user or role has the specified privileges on the file.
AccessType
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 roles specified in the access control list (ACL) for the file can access the file.
FetchSize
The maximum number of records to retrieve and return in a result set. The default value is 500.
FetchDirection
If True, records are retrieved forward. If False, records are retrieved backward. The default value is True.
CountLimit
The maximum number of records to count. By default, CountLimit is equal to FetchSize. To count all records, set CountLimit to ‑1.
FetchHandle
Retrieves more items from the result set. In the second and subsequent calls for data, specify the same search criteria as in the original call.
IncludeHiddenObject
Flag indicating if search should include hidden objects.