{"id":3691,"date":"2023-08-31T06:19:43","date_gmt":"2023-08-31T05:19:43","guid":{"rendered":"https:\/\/help.expertsender.com\/?post_type=es&p=3691"},"modified":"2024-06-25T12:52:40","modified_gmt":"2024-06-25T11:52:40","slug":"import-to-data-tables","status":"publish","type":"es","link":"https:\/\/help.expertsender.com\/pl\/emp\/api\/methods\/imports\/import-to-data-tables\/","title":{"rendered":"Import to Data Tables"},"content":{"rendered":"\n

ImportToDataTableTasks collection allows scheduling (asynchronous) imports to Data Tables. Data is imported from external source, e.g. file stored on FTP server.<\/p>\n\n\n\n

Currently, only one-time, immediately executed imports are supported.<\/p>\n\n\n\n

Executing a GET request on ImportToDataTableTasks collection allows polling for scheduled import status (e.g. if it;s still in progress or already finished).<\/p>\n\n\n\n

<\/a><\/a>Request data format<\/strong><\/h3>\n\n\n\n

Data part of request for scheduling a new import to Data Tables.<\/p>\n\n\n\n

Data element children:<\/p>\n\n\n\n

Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Source<\/td>complex<\/td>Imported file information. Required.<\/td><\/tr>
Target<\/td>complex<\/td>Target task data. Required.<\/td><\/tr>
ImportSetup<\/td>complex<\/td>Import settings, file settings, column mapping etc. Optional. If omitted, default settings will be used.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Source element children:<\/p>\n\n\n\n

Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Url<\/td>string<\/td>URL address of imported file. Supported protocols are HTTP, HTTPS, FTP, FTPS and SFTP. E.g. ftp:\/\/www.domain.com\/myimportedfile.csv*<\/td><\/tr>
Username<\/td>string<\/td>Username used for authentication. Optional.<\/td><\/tr>
Password<\/td>string<\/td>Password used for authentication. Optional.<\/td><\/tr>
FtpAuth<\/td>string<\/td>Authentication method for secure FTP servers. Optional. Valid values are:
None – FTP server does not support secure authentication (default)
ExplicitTls – Explicit TLS\/SSL authentication
ExplicitSsl – Explicit SSL only authentication
ImplicitSsl – Implicit SSL authentication<\/td><\/tr>
FtpUseActiveMode<\/td>boolean<\/td>If set to “true”, active mode will be used for FTP connections. Default value is “false” – passive connection mode will be used.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

*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.<\/p>\n\n\n\n

Target element children:<\/p>\n\n\n\n

Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Name<\/td>string<\/td>Import name. Used internally for easier identification. Required.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

ImportSetup element children:<\/p>\n\n\n\n

Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Mode<\/td>string<\/td>Import mode. Import modes are exactly the same as adding modes. Optional. Defaults to “Add”.<\/td><\/tr>
Delimiter<\/td>string<\/td>CSV file delimiter. Optional. Default value is ‘,’ (comma).<\/td><\/tr>
Quote<\/td>string<\/td>CSV file quoting character. Optional. Default value is ‘”‘ (double quote).<\/td><\/tr>
Escape<\/td>string<\/td>CSV file escape character. Optional. Default value is ‘”‘ (double quote).<\/td><\/tr>
Comment<\/td>string<\/td>CSV file comment character. Optional. Default value is zero-byte (undefined).<\/td><\/tr>
Encoding<\/td>string<\/td>CSV file encoding. Optional. Default is “utf-8”. List of recognized values.<\/a><\/td><\/tr>
StartingLine<\/td>integer<\/td>Number of line in file that import will start from. Optional. Default is 0 (from the beginning).<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Supported import modes:<\/p>\n\n\n\n

Mode<\/th>Behaviour<\/th><\/tr><\/thead>
Add<\/td>If row does not exist in Data Table, it will be added.<\/td><\/tr>
Replace<\/td>Non-existing rows will be added. Existing rows will be replaced.<\/td><\/tr>
AddOrUpdate<\/td>Non-existing rows will be added. Existing rows will be updated.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Response<\/strong><\/h3>\n\n\n\n

Method returns ID of scheduled import. ID can be used to get import status using GET method.<\/p>\n\n\n\n

Response Data element:<\/p>\n\n\n\n

Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
(Data element content)<\/td>int<\/td>ID of scheduled import.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Examples<\/strong><\/h3>\n\n\n\n

Scheduling a new Data Tables import with default options<\/strong><\/p>\n\n\n\n

Request:<\/p>\n\n\n\n

<\/path><\/path><\/svg><\/span>
POST https:\/\/api.esv2.com\/v2\/Api\/ImportToDataTableTasks HTTP\/1.1 <\/span><\/span>\nAccept-Encoding: gzip,deflate <\/span><\/span>\nContent-Type: application\/xml <\/span><\/span>\nUser-Agent: Jakarta Commons-HttpClient\/3.1 <\/span><\/span>\nHost: api.esv2.com <\/span><\/span>\nContent-Length: 353<\/span><\/span>\n<\/span>\n<<\/span>ApiRequest<\/span> <\/span>xmlns<\/span>:<\/span>xsi<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span>"<\/span> <\/span>xmlns<\/span>:<\/span>xs<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema<\/span>"<\/span>><\/span><\/span>\n   <\/span><<\/span>ApiKey<\/span>><\/span>test_api_key1<\/span><\/<\/span>ApiKey<\/span>><\/span><\/span>\n   <\/span><<\/span>Data<\/span>><\/span><\/span>\n     <\/span><<\/span>Source<\/span>><\/span><\/span>\n       <\/span><<\/span>Url<\/span>><\/span>ftp:\/\/ftp.expertsender.com\/Lists\/table_name.csv<\/span><\/<\/span>Url<\/span>><\/span><\/span>\n     <\/span><\/<\/span>Source<\/span>><\/span><\/span>\n     <\/span><<\/span>Target<\/span>><\/span><\/span>\n       <\/span><<\/span>Name<\/span>><\/span>API test import<\/span><\/<\/span>Name<\/span>><\/span><\/span>\n     <\/span><\/<\/span>Target<\/span>><\/span><\/span>\n   <\/span><\/<\/span>Data<\/span>><\/span><\/span>\n<\/<\/span>ApiRequest<\/span>><\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Response:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
HTTP\/1.1 201 Created <\/span><\/span>\nCache-Control: private <\/span><\/span>\nContent-Type: text\/xml; charset=utf-8 <\/span><\/span>\nServer: Microsoft-IIS\/7.5 <\/span><\/span>\nX-AspNetMvc-Version: 3.0 <\/span><\/span>\nX-AspNet-Version: 4.0.30319 <\/span><\/span>\nX-Powered-By: ASP.NET <\/span><\/span>\nDate: Tue, 25 Nov 2014 10:41:33 GMT <\/span><\/span>\nContent-Length: 147 <\/span><\/span>\n<\/span>\n<<\/span>ApiResponse<\/span> <\/span>xmlns<\/span>:<\/span>xsd<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema<\/span>"<\/span> <\/span>xmlns<\/span>:<\/span>xsi<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span>"<\/span>><\/span><\/span>\n   <\/span><<\/span>Data<\/span>><\/span>25<\/span><\/<\/span>Data<\/span>><\/span><\/span>\n<\/<\/span>ApiResponse<\/span>><\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Scheduling a new Data Tables import with full options<\/strong><\/p>\n\n\n\n
Request:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
POST https:\/\/api.esv2.com\/v2\/Api\/ImportToDataTableTasks HTTP\/1.1 <\/span><\/span>\nAccept-Encoding: gzip,deflate <\/span><\/span>\nContent-Type: application\/xml;charset=UTF-8 <\/span><\/span>\nUser-Agent: Jakarta Commons-HttpClient\/3.1 <\/span><\/span>\nHost: api.esv2.com <\/span><\/span>\nContent-Length: 810 <\/span><\/span>\n<\/span>\n<<\/span>ApiRequest<\/span> <\/span>xmlns<\/span>:<\/span>xsi<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span>"<\/span> <\/span>xmlns<\/span>:<\/span>xs<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema<\/span>"<\/span>><\/span><\/span>\n   <\/span><<\/span>ApiKey<\/span>><\/span>test_api_key1<\/span><\/<\/span>ApiKey<\/span>><\/span><\/span>\n   <\/span><<\/span>Data<\/span>><\/span><\/span>\n     <\/span><<\/span>Source<\/span>><\/span><\/span>\n       <\/span><<\/span>Url<\/span>><\/span>ftp:\/\/ftp.expertsender.com\/Lists\/table_name.csv<\/span><\/<\/span>Url<\/span>><\/span><\/span>\n       <\/span><<\/span>Username<\/span>><\/span>username<\/span><\/<\/span>Username<\/span>><\/span><\/span>\n       <\/span><<\/span>Password<\/span>><\/span>password<\/span><\/<\/span>Password<\/span>><\/span><\/span>\n     <\/span><\/<\/span>Source<\/span>><\/span><\/span>\n     <\/span><<\/span>Target<\/span>><\/span><\/span>\n       <\/span><<\/span>Name<\/span>><\/span>API test import <\/span><\/<\/span>Name<\/span>><\/span><\/span>\n     <\/span><\/<\/span>Target<\/span>><\/span><\/span>\n     <\/span><<\/span>ImportSetup<\/span>><\/span><\/span>\n       <\/span><<\/span>Mode<\/span>><\/span>Add<\/span><\/<\/span>Mode<\/span>><\/span><\/span>\n       <\/span><<\/span>Delimiter<\/span>><\/span>,<\/span><\/<\/span>Delimiter<\/span>><\/span><\/span>\n       <\/span><<\/span>Quote<\/span>><\/span>"<\/span><\/<\/span>Quote<\/span>><\/span><\/span>\n       <\/span><<\/span>Escape<\/span>><\/span>"<\/span><\/<\/span>Escape<\/span>><\/span><\/span>\n       <\/span><<\/span>Comment<\/span>><\/span>|<\/span><\/<\/span>Comment<\/span>><\/span><\/span>\n       <\/span><<\/span>Encoding<\/span>><\/span>UTF-8<\/span><\/<\/span>Encoding<\/span>><\/span><\/span>\n       <\/span><<\/span>StartingLine<\/span>><\/span>1<\/span><\/<\/span>StartingLine<\/span>><\/span><\/span>\n     <\/span><\/<\/span>ImportSetup<\/span>><\/span><\/span>\n   <\/span><\/<\/span>Data<\/span>><\/span><\/span>\n <\/span><\/<\/span>ApiRequest<\/span>><\/span><\/span><\/code><\/pre><\/div>\n","protected":false},"author":5,"featured_media":0,"parent":3682,"menu_order":286,"template":"","format":"standard","emp-category":[],"class_list":["post-3691","es","type-es","status-publish","format-standard","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3691","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es"}],"about":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/types\/es"}],"author":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/users\/5"}],"version-history":[{"count":4,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3691\/revisions"}],"predecessor-version":[{"id":11014,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3691\/revisions\/11014"}],"up":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3682"}],"wp:attachment":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/media?parent=3691"}],"wp:term":[{"taxonomy":"emp-category","embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/emp-category?post=3691"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}