SelectFiles
Retrieves information about a specified file.
To retrieve a single file or folder, specify Name or Id. To retrieve a list of files or folders, specify NameList or IdList. To search all file or folders that match specific condition, specify Search.
Request schema
<xsd:complexType name="SelectFiles">
<xsd:sequence>
<xsd:choice minOccurs="0">
<xsd:element name="WorkingFolderId" type="xsd:string"/>
<xsd:element name="WorkingFolderName"
type="xsd:string"/>
</xsd:choice>
<xsd:element name="Recursive" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="LatestVersionOnly" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="ResultDef" type="typens:ArrayOfString"/>
<xsd:choice>
<xsd:element name="Search" type="typens:FileSearch"/>
<xsd:element name="NameList"
type="typens:ArrayOfString"/>
<xsd:element name="IdList" type="typens:ArrayOfString"/>
<xsd:element name="Name" type="xsd:string"/>
<xsd:element name="Id" type="xsd:string"/>
</xsd:choice>
<xsd:element name="Content" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Embed"/>
<xsd:enumeration value="Attach"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
Request elements
WorkingFolderId
The ID of the working folder in which to search for the file. Specify either WorkingFolderId or WorkingFolderName.
WorkingFolderName
The absolute path and the name of the working folder in which to search for the file. Specify either WorkingFolderName or WorkingFolderId.
Recursive
Specifies whether to search subfolders. If True, the search includes subfolders. The default value is False.
LatestVersionOnly
Specifies whether to search all versions of the file. If True, the search includes only the latest version. The default value is False.
ResultDef
The properties to retrieve.
Search
The search condition. If conditions apply to multiple fields, use ConditionArray.
NameList
The name of the file or folder list to retrieve. Specify either IdList or NameList.
IdList
The ID of the file or folder list to retrieve. Specify either IdList or NameList.
Name
The name of a single file or folder to retrieve. Specify either Name or Id.
Id
The ID of a file or folder to retrieve. Specify either Id or Name.
Content
Specifies whether the file is embedded in or attached to the response. Valid values are:
Embed
The file is embedded.
Attach
The file is attached.
Response schema
<xsd:element name="SelectFilesResponse">
<xsd:sequence>
<xsd:element name="ItemList" type="typens:ArrayOfFile"/>
<xsd:element name="ContentItemList"
type="typens:ArrayOfFileContent"/>
<xsd:element name="FetchHandle" type="xsd:string"
minOccurs="0"/>
<xsd:element name="TotalCount" type="xsd:long"
minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
Response elements
ItemList
The list of attached items that match the search criteria.
ContentItemList
The list of embedded items that match the search criteria.
FetchHandle
Indicates that the number of items in the result set exceeds the FetchSize limit.
TotalCount
The number of entries in the search result set.