Bookshelf Home | Contents | Index | PDF     

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

ExportWebServiceCreateExportRequest

Creates a data export request.

Usage

Use the ExportWebServiceCreateExportRequest method to create an export request. The ADMIN_EXPORT privilege is required.

For more information about export requests, see Oracle CRM On Demand Online Help.

Arguments

Table 46 describes the arguments taken by the ExportWebServiceCreateExportRequest method.

Table 46. Arguments Taken by the ExportWebServiceCreateExportRequest Method
Name
Description
Required
Default
I/O

ListOfRecordType

The record types to be exported.

Yes

Not applicable

Input

TimeZone

The time zone.

Yes

Not applicable

Input

ScanExportZipFileForViruses

Whether the zip file for the export request is scanned for viruses (true) or not scanned (false).

No

Not applicable

Input

DateTimeFormat

The date and time format used in the CSV file, for example: USA - MM/DD/YYYY hh:mm:ss PM.

Yes

Not applicable

Input

ExportDataModifiedAfter

Specifies that data modified on or after the given date is exported.

No

Not applicable

Input

ExportDataModifiedBefore

Specifies that data modified before the given date is exported.

No

Not applicable

Input

EnableMailNotificationflag

Whether email notifications are enabled (true) or disabled (false).

No

Not applicable

Input

IncludeWebLinkURL

Whether URLs are included for Weblinks in the export request (true) or excluded (false).

No

Not applicable

Input

Delimiter

The type of CSV delimiter used in the file: Comma (,) or Semi-Colon (;).

Yes

Not applicable

Input

RequestId

The export request ID.

Not applicable

Not applicable

Output

Return Value of the Call

The export request ID.

Sample SOAP Requests and Responses

This topic contains sample SOAP requests that invoke ExportWebServiceCreateExportRequest.

Sample SOAP Request 1 - ExportWebServiceCreateExportRequest: Request for a Comma-delimited Export for Multiple Record Types

The following SOAP sample invokes ExportWebServiceCreateExportRequest to request an export of account and contact records. By not specifying a value for <Delimiter>, comma-delimited export files are generated.

<?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_ExportWebServiceCreateExportRequest_Input xmlns="urn:crmondemand/ws/exportwebservice/">

         <TimeZone>(GMT-08:00) Pacific Time (US &amp; Canada); Tijuana</TimeZone>

         <ScanExportZipFileForViruses>false</ScanExportZipFileForViruses>

         <ListOfRecordType>

            <RecordType>

               <Name>Contact</Name>

            </RecordType>

            <RecordType>

               <Name>Account</Name>

            </RecordType>

         </ListOfRecordType>

         <EnableMailNotificationflag>false</EnableMailNotificationflag>

         <IncludeWebLinkURL>false</IncludeWebLinkURL>

         <DateTimeFormat>USA - MM/DD/YYYY hh:mm:ss PM</DateTimeFormat>

         <Delimiter></Delimiter>

      </ExportWebService_ExportWebServiceCreateExportRequest_Input>

   </soap:Body>

</soap:Envelope>

Sample SOAP Request 2 - ExportWebServiceCreateExportRequest: Request for a Semicolon-delimited Export of Records Modified Between Two Dates

The following SOAP sample invokes ExportWebServiceCreateExportRequest to request a semicolon-delimited export of contact records modified between 12/06/2011 and 12/07/2011 (6th and 7th December 2011).

<?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_ExportWebServiceCreateExportRequest_Input xmlns="urn:crmondemand/ws/exportwebservice/">

         <ExportDataModifiedBefore>12/07/2011</ExportDataModifiedBefore>

         <TimeZone>(GMT-08:00) Pacific Time (US &amp; Canada); Tijuana</TimeZone>

         <ScanExportZipFileForViruses>false</ScanExportZipFileForViruses>

         <ListOfRecordType>

            <RecordType>

               <Name>Contact</Name>

            </RecordType>

         </ListOfRecordType>

         <EnableMailNotificationflag>false</EnableMailNotificationflag>

         <IncludeWebLinkURL>false</IncludeWebLinkURL>

         <DateTimeFormat>USA - MM/DD/YYYY hh:mm:ss PM</DateTimeFormat>

         <ExportDataModifiedAfter>12/06/2011</ExportDataModifiedAfter>

         <Delimiter>Semi-Colon</Delimiter>

      </ExportWebService_ExportWebServiceCreateExportRequest_Input>

   </soap:Body>

</soap:Envelope>

Sample SOAP Responses

The response is the same for both of the sample SOAP requests:

<?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_ExportWebServiceCreateExportRequest_Output xmlns:ns="urn:crmondemand/ws/exportwebservice/">

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

      </ns:ExportWebService_ExportWebServiceCreateExportRequest_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.