Overview

Skill Level: Any

Prerequisites

This interface supports programmatically exporting Relational Table data from Watson Campaign Automation into a CSV file, which Watson Campaign Automation uploads to the FTP account or to the Stored Files directory associated with the session.

Step-by-step

  1. Syntax of the request and response SOAP for ExportTable

    Operation  <ExportTable>     
    Elements  TABLE_NAME

    Optional parameter specifying the folder path and name of the Relational Table you are exporting. Either TABLE_NAME or TABLE_ID is required.

    Note: If you specify TABLE_VISIBILITY, Watson Campaign Automation ignores Private / Shared in TABLE_NAME. 

     
      TABLE_ID 

    Optional parameter to specify the ID of the Relational Table you are exporting. Either TABLE_NAME or TABLE_ID is required.

    Note: Watson Campaign Automation does not specify Private or Shared as part of the path. 

     
      TABLE_VISIBILITY 

    Optional field defining the visibility of the table you are referencing. Required if not
    specified in TABLE_NAME.

    0 ‚Äď Private

    1 ‚Äď Shared

     

     
      EMAIL  Optional  If specified, Watson Campaign Automation sends a notification email to the provided email
    address when the job is complete. 
      EXPORT_FORMAT 

    Specifies the file format for the exported data. Valid values are:

    CSV ‚Äď create a comma‚Äźseparated values file

    TAB ‚Äď create a tab‚Äźseparated values file

    PIPE ‚Äď create a pipe‚Äźseparated values file

     

     
      ADD_TO_STORED_FILES  Optional  Use the ADD_TO_STORED_FILES parameter to write output to the Stored Files folder in Watson Campaign Automation. If you omit this parameter, Watson Campaign Automation moves exported files to the download directory of your FTP account. 
      DATE_START  Optional  Specifies the beginning boundary of information to export (relative to
    the last modified date of the contact). If time is included, it must be in
    24‚Äźhour format.¬†
      DATE_END  Optional  Specifies the ending boundary of information to export (relative to
    the last modified date of the contact). If time is included, it must be in
    24‚Äźhour format.¬†
    Example¬† <soapenv:Envelope xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”
    xmlns:ses=”SilverpopApi:EngageService.SessionHeader”
    xmlns:user=”SilverpopApi:EngageService.ListMgmt.UserActions”>
    <soapenv:Header>
    <ses:sessionHeader>
    <ses:sessionid>16FE7B75445E6C704707025B1B7BBEE5</ses:sessionid>
    </ses:sessionHeader>
    </soapenv:Header>
    <soapenv:Body>
    <user:ExportTable>
    <user:TABLE_NAME>Private/Friends</user:TABLE_NAME>
    <user:EXPORT_FORMAT>CSV</user:EXPORT_FORMAT>
    <user:ADD_TO_STORED_FILES/>
    <user:DATE_START>06/07/2009 24:00:00</user:DATE_START>
    <user:DATE_END>06/09/2009 24:00:00</user:DATE_END>
    </user:ExportTable>
    </soapenv:Body>
    </soapenv:Envelope> 
       
    Response  <RESULT>     
    Elements  SUCCESS  TRUE if successful   
      JOB_ID  Identifies the Watson Campaign Automation Background Job created and scheduled for this export.   
      FILE_PATH  Returns the file name of the export file.   
    Example¬† <envelope:Envelope xmlns=”SilverpopApi:EngageService.ListMgmt.UserActions”
    xmlns:envelope=”http://schemas.xmlsoap.org/soap/envelope/”>
    <envelope:Header/>
    <envelope:Body>
    <RESULT>
    <SUCCESS>TRUE</SUCCESS>
    <JOB_ID>503532</JOB_ID>
    <FILE_PATH>/download/Friends ‚Äź All ‚Äź Jul 17 2009 09‚Äź05‚Äź51 AM.CSV</FILE_PATH>
    </RESULT>
    </envelope:Body>
    </envelope:Envelope> 
       

Join The Discussion

Your email address will not be published. Required fields are marked *