Working with Exports in Eloqua

Overview

The following operations allow you to work with exports. Click an operation name to see details on how to use it.

For a sample proxy service that illustrates how to work with exports, see Sample configuration .

Operation	Description
getExports	Retrieves all exports that match the criteria specified in the parameters.
getExportsData	Returns the size of the staging area available for exports, and the amount currently used.

Operation Details

This section provides further details on the operations related to exports.

Get Exports

The getExports operation retrieves all exports that match the specified criteria.

getExports

<eloqua.getExports>
    <limit>{$ctx:limit}</limit>
    <offset>{$ctx:offset}</offset>
    <orderBy>{$ctx:orderBy}</orderBy>
    <q>{$ctx:q}</q>
	<totalResults>{$ctx:totalResults}</totalResults>
</eloqua.getExports>

properties

limit: Specifies maximum number of records to return.
offset : Specifies an offset that allows to retrieve the next batch of records.
orderBy : Term to order the results by..
q : Specifies query criteria used to filter resultl.
totalResults: The total number of records that satisfy the request.

Sample request

Following is a sample REST/JSON request that can be handled by the getExports operation.

Sample request for getExports

{
    "refreshToken":"MTYXXXXU5MDoxc2FtZGNnazJWay03SYWhYflNJTlkxY2VtQ2M1RDFrVmpifjlXaEJFV35Ddk9qelplQXXXXXXVNoT25D",
    "redirectUri":"https://esbconnectors.blogspot.com",
    "clientId":"1dxxx80-3848-4a3f-a225-6s92fexxxa8",
    "clientSecret":"1K-yOHxxxgHr-Dm5saaskn0wsOj3eouQnbzXXXVT~NXXhdkldszB-dRad9TxHzcxxxFiiSSLtuL8zBZeXZ",
    "apiVersion":"2.0",
    "scope":"full",
    "totalResults":"true",
    "q":"name='E*'",
    "orderBy":"name DESC",
    "offset":"0",
    "limit":"10"   
}

Get Exports Data

The getExportsData operation retrieves the size of the staging area available for exports, and the amount currently used.

getExportsData

<eloqua.getExportsData/>

Sample Request

Following is a sample REST/JSON request that can be handled by getExportsData operation.

Sample request for getExportsData

{
    "refreshToken":"MTYXXXXU5MDoxc2FtZGNnazJWay03SYWhYflNJTlkxY2VtQ2M1RDFrVmpifjlXaEJFV35Ddk9qelplQXXXXXXVNoT25D",
    "redirectUri":"https://esbconnectors.blogspot.com",
    "clientId":"1dxxx80-3848-4a3f-a225-6s92fexxxa8",
    "clientSecret":"1K-yOHxxxgHr-Dm5saaskn0wsOj3eouQnbzXXXVT~NXXhdkldszB-dRad9TxHzcxxxFiiSSLtuL8zBZeXZ",
    "apiVersion":"2.0",
    "scope":"full"
}

Sample Configuration

Following is a sample proxy service that illustrates how to connect to Eloqua with the getAccessTokenFromRefreshToken operation and use the getExportsData operation. The sample request for this proxy can be found in getExportsData sample request. You can use this sample as a template for using other operations in this category.

Sample proxy

<?xml version="1.0" encoding="UTF-8"?>
<proxy xmlns="http://ws.apache.org/ns/synapse"
       name="getExportsData"
       transports="https http"
       startOnLoad="true"
       trace="disable">
   <description/>
   <target>
      <inSequence>
         <property name="refreshToken" expression="json-eval($.refreshToken)"/>
         <property name="scope" expression="json-eval($.scope)"/>
         <property name="redirectUri" expression="json-eval($.redirectUri)"/>
         <property name="clientId" expression="json-eval($.clientId)"/>
         <property name="apiVersion" expression="json-eval($.apiVersion)"/>
         <property name="clientSecret" expression="json-eval($.clientSecret)"/>
         <property name="limit" expression="json-eval($.limit)"/>
         <property name="offset" expression="json-eval($.offset)"/>
         <property name="orderBy" expression="json-eval($.orderBy)"/>
         <property name="q" expression="json-eval($.q)"/>
         <property name="totalResults" expression="json-eval($.totalResults)"/>
         <eloqua.getAccessTokenFromRefreshToken>
            <refreshToken>{$ctx:refreshToken}</refreshToken>
            <scope>{$ctx:scope}</scope>
            <redirectUri>{$ctx:redirectUri}</redirectUri>
            <clientId>{$ctx:clientId}</clientId>
            <clientSecret>{$ctx:clientSecret}</clientSecret>
            <apiVersion>{$ctx:apiVersion}</apiVersion>
         </eloqua.getAccessTokenFromRefreshToken>
         <eloqua.getExportsData/>
         <respond/>
      </inSequence>
      <outSequence/>
      <faultSequence/>
   </target>
</proxy>

WSO2 ESB Connectors Documentation