This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, visit https://wso2.com/documentation/.

Working with Syncs in Eloqua

Owned by Former user (Deleted)
Last updated: Mar 30, 2015
5 min read

Overview

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

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

OperationDescription
createSyncTriggers a sync on the import or export specified in the request body.
getSyncsRetrieves all syncs that match the criteria specified in the parameters.
getSyncByIdRetrieves the specified sync.
getSyncsDataByIdRetrieves the data for the specified sync.
getSyncsLogsByIdRetrieves the logs for the specified sync.
getSyncsRejectsByIdRetrieves raw data about validation failures during the specified import sync.

Operation Details

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

Create Sync

The createSync operation triggers a sync on the import or export specified in the request body.

createSync
<eloqua.createSync>
	<callbackUrl>{$ctx:callbackUrl}</callbackUrl>
    <createdAt>{$ctx:createdAt}</createdAt>
    <createdBy>{$ctx:createdBy}</createdBy>
    <status>{$ctx:status}</status>
    <syncedInstanceUri>{$ctx:syncedInstanceUri}</syncedInstanceUri>
    <syncEndedAt>{$ctx:syncEndedAt}</syncEndedAt>
    <syncStartedAt>{$ctx:syncStartedAt}</syncStartedAt>
    <uri>{$ctx:uri}</uri>
</eloqua.createSync>
properties

  • callbackUrl: Call back url of the sync.

  • createdAt : Timestamp when the definition was created.

  • createdBy : User who created the definition.

  • status : The status for sync.

  • syncedInstanceUri: Must specify an existing definition uri.
  • syncEndedAt: Timestamp when the sync ends.
  • syncStartedAt: Timestamp when the sync started.
  • uri: System- generated URI that defines the definition for future referencing.
Sample request

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

Sample request for createSync
{
    "refreshToken":"MTYXXXXU5MDoxc2FtZGNnazJWay03SYWhYflNJTlkxY2VtQ2M1RDFrVmpifjlXaEJFV35Ddk9qelplQXXXXXXVNoT25D",
    "redirectUri":"https://esbconnectors.blogspot.com",
    "clientId":"1dxxx80-3848-4a3f-a225-6s92fexxxa8",
    "clientSecret":"1K-yOHxxxgHr-Dm5saaskn0wsOj3eouQnbzXXXVT~NXXhdkldszB-dRad9TxHzcxxxFiiSSLtuL8zBZeXZ",
    "apiVersion":"2.0",
    "scope":"full",
    "syncedInstanceUri":"/contacts/imports/10"
}
Related Eloqua documentation

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCBB/Content/D_Reference/endpoints/syncs/post.htm

Get Syncs

The getSyncs operation retrieves all syncs that match the specified criteria.

getSyncs
<eloqua.getSyncs>
    <limit>{$ctx:limit}</limit>
    <offset>{$ctx:offset}</offset>
    <orderBy>{$ctx:orderBy}</orderBy>
    <q>{$ctx:q}</q>
	<totalResults>{$ctx:totalResults}</totalResults>
</eloqua.getSyncs>
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 getSyncs operation.

Sample request for getSyncs
{
    "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"   
}
Related Eloqua documentation

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCBB/Content/D_Reference/endpoints/syncs/get.htm

Get Sync By Id

The getSyncById operation retrieves the specified sync.

getSyncById
<eloqua.getSyncById>
	<syncId>{$ctx:syncId}</syncId>
</eloqua.getSyncById>
properties

  • syncId: The id of the sync.

Sample Request

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

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

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCBB/Content/D_Reference/endpoints/syncs/get-id.htm

Get Syncs Data By Id

The getSyncsDataById operation retrieves the data for the specified sync.

getSyncsDataById
<eloqua.getSyncsDataById>
    <syncId>{$ctx:syncId}</syncId>
    <limit>{$ctx:limit}</limit>
    <offset>{$ctx:offset}</offset>
	<totalResults>{$ctx:totalResults}</totalResults>
</eloqua.getSyncsDataById>
properties

  • syncId: The id of the sync.

  • limit: Specifies maximum number of records to return.

  • offset : Specifies an offset that allows to retrieve the next batch of records.

  • totalResults: The total number of records that satisfy the request.
Sample Request

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

Sample request for getSyncsDataById
{
    "refreshToken":"MTYXXXXU5MDoxc2FtZGNnazJWay03SYWhYflNJTlkxY2VtQ2M1RDFrVmpifjlXaEJFV35Ddk9qelplQXXXXXXVNoT25D",
    "redirectUri":"https://esbconnectors.blogspot.com",
    "clientId":"1dxxx80-3848-4a3f-a225-6s92fexxxa8",
    "clientSecret":"1K-yOHxxxgHr-Dm5saaskn0wsOj3eouQnbzXXXVT~NXXhdkldszB-dRad9TxHzcxxxFiiSSLtuL8zBZeXZ",
    "apiVersion":"2.0",
    "scope":"full",
	"syncId":"1",
	"totalResults":"true",
	"offset":"2,
	"limit":"1o"
 }
Related Eloqua documentation

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCBB/Content/D_Reference/endpoints/syncs/get-id-data.htm

Get Syncs Logs By Id

The getSyncsLogsById operation retrieves the logs for the specified sync.

getSyncsLogsById
<eloqua.getSyncsLogsById>
	<syncId>{$ctx:syncId}</syncId>
	<limit>{$ctx:limit}</limit>
    <offset>{$ctx:offset}</offset>
    <orderBy>{$ctx:orderBy}</orderBy>
    <q>{$ctx:q}</q>
	<totalResults>{$ctx:totalResults}</totalResults>
</eloqua.getSyncsLogsById>
properties

  • syncId: The id of the sync.

  • 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 getSyncsLogsById operation.

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

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCBB/Content/D_Reference/endpoints/syncs/get-id-logs.htm

Get Syncs Rejects By Id

The getSyncsRejectsById operation retrieves raw data about validation failures during the specified import sync.

getSyncsRejectsById
<eloqua.getSyncsRejectsById>
	<syncId>{$ctx:syncId}</syncId>
	<limit>{$ctx:limit}</limit>
    <offset>{$ctx:offset}</offset>
    <orderBy>{$ctx:orderBy}</orderBy>
    <q>{$ctx:q}</q>
	<totalResults>{$ctx:totalResults}</totalResults>
</eloqua.getSyncsRejectsById>
properties

  • syncId: The id of the sync.

  • 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 getSyncsRejectsById operation.

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

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCBB/Content/D_Reference/endpoints/syncs/get-id-rejects.htm

Sample Configuration

Following is a sample proxy service that illustrates how to connect to Eloqua with the getAccessTokenFromRefreshToken operation and use the getSyncsRejectsById operation. The sample request for this proxy can be found in  getSyncsRejectsById 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="getSyncsRejectsById"
       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="syncId" expression="json-eval($.syncId)"/>
         <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.getSyncsRejectsById>
            <syncId>{$ctx:syncId}</syncId>
            <limit>{$ctx:limit}</limit>
            <orderBy>{$ctx:orderBy}</orderBy>
            <q>{$ctx:q}</q>
            <offset>{$ctx:offset}</offset>
            <totalResults>{$ctx:totalResults}</totalResults>
         </eloqua.getSyncsRejectsById>
         <respond/>
      </inSequence>
      <outSequence/>
      <faultSequence/>
   </target>
</proxy>