Embedded Files
API Documentation V2
ImportToDataTableTasks collection allows scheduling (asynchronous) imports to Data Tables. Data is imported from external source, e.g. file stored on FTP server.
Currently, only one-time, immediately executed imports are supported.
Executing a GET request on ImportToDataTableTasks collection allows polling for scheduled import status (e.g. if it;s still in progress or already finished).
Request data format
Request data format
Data part of request for scheduling a new import to Data Tables.
Data element children:
Source element children:
*Note: If you are importing a single CSV file, please make sure its name is the same as Data Table name you want to import data to.
Target element children:
ImportSetup element children:
Supported import modes:
Response
Response
Method returns ID of scheduled import. ID can be used to get import status using GET method.
Response Data element:
Examples
Examples
Scheduling a new Data Tables import with default options
Request:
POST https://api.esv2.com/v2/Api/ImportToDataTableTasks HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/xml
User-Agent: Jakarta Commons-HttpClient/3.1
Host: api.esv2.com
Content-Length: 353
<ApiRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<ApiKey>test_api_key1</ApiKey>
<Data>
<Source>
<Url>ftp://ftp.expertsender.com/Lists/table_name.csv</Url>
</Source>
<Target>
<Name>API test import</Name>
</Target>
</Data>
</ApiRequest>
Response:
HTTP/1.1 201 Created
Cache-Control: private
Content-Type: text/xml; charset=utf-8
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 3.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Tue, 25 Nov 2014 10:41:33 GMT
Content-Length: 147
<ApiResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Data>25</Data>
</ApiResponse>
Scheduling a new Data Tables import with full options
Request:
POST https://api.esv2.com/v2/Api/ImportToDataTableTasks HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/xml;charset=UTF-8
User-Agent: Jakarta Commons-HttpClient/3.1
Host: api.esv2.com
Content-Length: 810
<ApiRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<ApiKey>test_api_key1</ApiKey>
<Data>
<Source>
<Url>ftp://ftp.expertsender.com/Lists/table_name.csv</Url>
<Username>username</Username>
<Password>password</Password>
</Source>
<Target>
<Name>API test import </Name>
</Target>
<ImportSetup>
<Mode>Add</Mode>
<Delimiter>,</Delimiter>
<Quote>"</Quote>
<Escape>"</Escape>
<Comment>|</Comment>
<Encoding>UTF-8</Encoding>
<StartingLine>1</StartingLine>
</ImportSetup>
</Data>
</ApiRequest>
Report abuse