Oracle Web Services On Demand Guide > Web Services On Demand API Calls > Service API Calls >

ExportWebServiceRetrieveExportAttachment


Retrieves the files generated by an export request.

Usage

Use the ExportWebServiceRetrieveExportAttachment method to retrieve an attachment for an export request by specifying the AttachmentId value of the attachment. You can retrieve the AttachmentId value by using the ExportWebServiceMonitorExportRequest method.

The maximum size of an attachment file generated through a Web services call is 20MB. It is possible to generate larger attachment files through the Oracle CRM On Demand UI, but you cannot retrieve such files using the ExportWebServiceRetrieveExportAttachment method; such files must be downloaded from the Export Request Queue page in Oracle CRM On Demand.

NOTE:  Only one attachment can be retrieved at a time.

Arguments

Table 48 describes the arguments taken by the ExportWebServiceRetrieveExportAttachment method.

Table 48. Arguments Taken by the ExportWebServiceRetrieveExportAttachment Method
Name
Description
Required
Default
I/O

RequestId

The export request ID.

Yes

Not applicable

Input

AttachmentId

The attachment ID.

Not applicable

Not applicable

Input

Attachment

The attachment retrieved in Base64 encoded format.

Not applicable

Not applicable

Output

Return Value of the Call

The base64-encoded file with the specified Id value is returned.

Sample SOAP Request - ExportWebServiceRetrieveExportAttachment

The following SOAP sample invokes ExportWebServiceRetrieveExportAttachment to retrieve the export files based on the export request ID and the attachment file ID:

<?xml version="1.0" encoding="utf-8" standalone="no"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

   <soap:Header>

      <wsse:Security>

         <wsse:UsernameToken>

            <wsse:Username>%%%USERNAME%%%</wsse:Username>

            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%%PASSWORD%%%</wsse:Password>

         </wsse:UsernameToken>

      </wsse:Security>

   </soap:Header>

   <soap:Body>

      <ExportWebService_ExportWebServiceRetrieveExportAttachment_Input xmlns="urn:crmondemand/ws/exportwebservice/">

         <RequestId>1QA2-16438E</RequestId>

         <AttachmentId>1QA2-166416</AttachmentId>

      </ExportWebService_ExportWebServiceRetrieveExportAttachment_Input>

   </soap:Body>

</soap:Envelope>

Sample SOAP Response

The following SOAP response contains the requested attachment:

<?xml version="1.0" encoding="utf-8"?>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

   <SOAP-ENV:Body>

      <ns:ExportWebService_ExportWebServiceRetrieveExportAttachment_Output xmlns:ns="urn:crmondemand/ws/exportwebservice/">

         <ns:Attachment>UEsDBBQAAAAIAAhOhz/CCm0jUAEAAHkCAAAmAHEARXhwb3J0U3VtbWFyeV8yMDExMTIwN18xUUEyLTE2NDM4RS50eHRTRFwApAAAAAAIAA6Py89jZGBpEGFgYFBhgAAHIGZkAjNZFYCEApDNyArhiwKJr2aunmplcvrK8cnZIHVMDCkMLGBpCYb/

...

CCm0jUAEAAHkCAAAmABEAAAAAAAEAIAC2gQAAAABFeHBvcnRTdW1tYXJ5XzIwMTExMjA3XzFRQTItMTY0MzhFLnR4dFNEBACkAAAAVVQFAAfPmN9OUEsBAhcLFAAAAAgACE6HP1i0K0QbCwAAkVMAAB0AEQAAAAAAAQAgALaBBQIAAENvbnRhY3RzXzFRQTItMTY0MzhFXzAwMDEuY3N2U0QEAKQAAABVVAUAB8+Y305QSwUGAAAAAAIAAgDBAAAAzA0AAAAA</ns:Attachment>

      </ns:ExportWebService_ExportWebServiceRetrieveExportAttachment_Output>

   </SOAP-ENV:Body>

</SOAP-ENV:Envelope>

Oracle Web Services On Demand Guide, Version 25.0 (Oracle CRM On Demand Release 37) Copyright © 2018, Oracle and/or its affiliates. All rights reserved. Legal Notices.