ExportWebServiceMonitorExportRequest
Retrieves the status and other details about an export request.
Usage
Use the ExportWebServiceMonitorExportRequest method to retrieve the status and other details for an export request. For successfully completed export requests, the <ListOfAttachmentInfo> argument contains the set of ID values for the files generated for the request. Export requests that are in progress do not return any values for <ListOfAttachmentInfo>.
The <AttachmentInfo> child element of <ListOfAttachmentInfo> contains the following for each attachment:
FileId. The file ID.
FileName. The filename of the attachment.
FileExt. The file extension.
FileSize. The file size in KB. The maximum file size for an attachment is 20 MB.
Arguments
The following table describes the arguments taken by the ExportWebServiceMonitorExportRequest method.
Name | Description | Required | Default | I/O |
---|---|---|---|---|
RequestId |
The export request ID. |
Yes |
Not applicable |
Input |
CompletionDateTime |
The date and time of completion of the request. |
No |
Not applicable |
Output |
NumberProcessed |
The number of records processed by the request. |
No |
Not applicable |
Output |
Status |
The status of this Web service call. |
Not applicable |
Not applicable |
Output |
ErrorMessage |
Any error message from this Web service call, or a message indicating success. |
Not applicable |
Not applicable |
Output |
ListOfAttachmentInfo |
The attachment information. |
Not applicable |
Not applicable |
Output |
Return Value of the Call
The output arguments.
Sample SOAP Request - ExportWebServiceMonitorExportRequest
The following SOAP sample invokes ExportWebServiceMonitorExportRequest to retrieve the status and other details of an export request identified by the request 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_ExportWebServiceMonitorExportRequest_Input xmlns="urn:crmondemand/ws/exportwebservice/">
<RequestId>1QA2-16438E</RequestId>
</ExportWebService_ExportWebServiceMonitorExportRequest_Input>
</soap:Body>
</soap:Envelope>
Sample SOAP Response
The following SOAP response contains the status and other details of the export request:
<?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_ExportWebServiceMonitorExportRequest_Output xmlns:ns="urn:crmondemand/ws/exportwebservice/">
<ns:Status>Completed</ns:Status>
<ns:CompletionDateTime>12/07/2011 08:48:15</ns:CompletionDateTime>
<ns:NumberProcessed>1</ns:NumberProcessed>
<ns:ErrorMessage>OK</ns:ErrorMessage>
<ListOfAttachmentInfo xmlns="http://www.siebel.com/xml/ExportWSAttachmentInfo">
<AttachmentInfo>
<FileId>1QA2-166416</FileId>
<FileName>OnDemandExport_20111207_1QA2-16438E_0001</FileName>
<FileExt>zip</FileExt>
<FileSize>3385</FileSize>
</AttachmentInfo>
</ListOfAttachmentInfo>
</ns:ExportWebService_ExportWebServiceMonitorExportRequest_Output>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>