DownloadFile
Downloads a file from an Encyclopedia volume. An attachment is included in the response packet, which refers to file content. The file content is streamed back using SOAP attachment.
Request schema
<xsd:complexType name="DownloadFile">
<xsd:sequence>
<xsd:choice>
<xsd:element name="FileName" type="xsd:string"/>
<xsd:element name="FileId" type="xsd:string"/>
</xsd:choice>
<xsd:element name="DecomposeCompoundDocument"
type="xsd:boolean" minOccurs="0"/>
<xsd:element name="DownloadEmbedded" type="xsd:boolean"
default="false" minOccurs="0"/>
<xsd:element name="FileProperties"
type="typens:ArrayOfString"
minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
Request elements
FileName
The name of the file to download. Specify either FileName or FileId.
FileId
The ID of the file to download. Specify either FileId or FileName.
DecomposeCompoundDocument
Specifies whether to download a compound document as one file or multiple attachments. If False, you can download the file as a single file. If True, and the file is a compound document, BIRT iHub splits the file into several attachments. The default value is False.
DownloadEmbedded
Specifies whether to send the attachment embedded in the body of the SOAP message or in a separate MIME boundary. If True, the response contains the attachment as embedded data. If False, the attachment is in a separate MIME boundary. The default value is False.
FileProperties
The file properties to return.
Response schema
<xsd:complexType name="DownloadFileResponse"> <xsd:sequence>
<xsd:element name="File" type="typens:File"/>
<xsd:choice>
<xsd:element name="Content" type="typens:Attachment"/>
<xsd:element name="ContainedFiles"
type="typens:ArrayOfAttachment"/>
</xsd:choice>
</xsd:sequence>
</xsd:complexType>
Response elements
File
The file properties.
Content
The downloaded file in an embedded or chunked file operation.
ContainedFiles
The downloaded set of files in a decomposed compound document operation.