Skip to content

Get Data Tables import progress

Request data format

Request URL parameters:

Element/attributeTypeNotes
apiKeystringYour API key, required for authentication. Required.
idintegerImport ID. Required as a part of address (not GET parameter). See example below.

Example URL:

https://api.esv2.com/v2/Api/ImportToDataTableTasks/39?apiKey=test_api_key1

Response

Method returns an object describing the scheduled import and its execution history.

Response Data element:

Element/attributeTypeNotes
NamestringImport task name.
UrlstringURL address of file containing imported data.
Historyarray[complex]Array of Import elements describing import executions.*

*History may be empty if import was never executed.

Import element children:

Element/attributeTypeNotes
StartedAtdateTimeDate of import start.
UpdatedAtdateTimeDate of last import status change.
StatusstringImport status. One of: “Queued”, “InProgress”, “Completed”, “Error”.
DetailsstringAdditional information, e.g. error info if import failed.

Examples

Request:

GET https://api.esv2.com/v2/Api/ImportToDataTableTasks?apiKey=test_api_key1&id=39
HTTP/1.1 
Accept-Encoding: gzip,deflate 
User-Agent: Jakarta Commons-HttpClient/3.1 
Host: api.esv2.com

Response:

HTTP/1.1 200 OK 
Cache-Control: private 
Content-Type: text/xml; charset=utf-8 
Server: Microsoft-IIS/8.0 
X-AspNetMvc-Version: 5.2
X-AspNet-Version: 4.0.30319 X-Powered-By: ASP.NET 
Date: Mon, 19 Jan 2015 13:32:30 GMT Content-Length: 367 

<ApiResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Data>
    <Name>TESTOWA</Name>
    <Url>ftp://ftp.expertsender.com/TESTOWA.csv</Url>
    <History>
      <Import>
        <StartedAt>2015-01-19T14:31:29</StartedAt>
        <UpdatedAt>2015-01-19T14:31:30</UpdatedAt>
        <Status>Completed</Status>
        <Details>ftp://ftp.expertsender.com/TESTOWA.csv</Details>
      </Import>
    </History>
  </Data>
</ApiResponse>