Working with Imports in Eloqua

Overview

The following operations allow you to work with imports. 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
getImports	Retrieves all imports that match the criteria specified in the parameters.
getImportsData	Returns the size of the staging area available for imports, and the amount currently used.

Operation Details

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

Get Imports

The getImports operation retrieves all imports that match the specified criteria.

getImports

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

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 getImports operation.

Sample request for getImports

{
    "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 Imports Data

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

getImportsData

<eloqua.getImportsData/>

Sample Request

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

Sample request for getImportsData

{
    "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 getImportsData 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="getImportsData"
       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.getImportsData/>
         <respond/>
      </inSequence>
      <outSequence/>
      <faultSequence/>
   </target>
</proxy>

WSO2 ESB Connectors Documentation